Skip to main content

Media Player — media_player v1

Anything that originates content: a streamer, a disc player, a cable box, a music service. It is a source in the signal graph — a room's watch or listen names one of these.

Capabilities

Declared in the driver manifest under [[proxy]] capabilities. Anything not declared takes the default below.

CapabilityTypeDefaultMeaning
has_appsboolfalseInstalled applications can be listed and launched
has_browseboolfalseContent can be listed and selected by id
has_dpadboolfalseCursor navigation for an on-screen UI
has_metadataboolfalseReports title/artist/art
has_number_keysboolfalse
has_playlistsboolfalse
has_scanboolfalseFast forward / rewind
has_searchboolfalse
has_seekboolfalse
has_shuffle_repeatboolfalse
has_skipboolfalse
has_transportbooltruePlay/pause/stop
is_audio_sourcebooltrue
is_video_sourceboolfalse

Commands

dpad

Only present when has_dpad is declared true.

ParameterTypeNotes
keyone of up · down · left · right · select · back · menu · home · info

launch_app

Only present when has_apps is declared true.

Open an installed application. The valid names are whatever apps reports for this device.

ParameterTypeNotes
appstring
content_idstring (optional)Deep link to a specific title

pause

No parameters.

play

No parameters.

play_item

Only present when has_browse is declared true.

Play a content id previously returned by browse or search

ParameterTypeNotes
idstring

scan_forward

Only present when has_scan is declared true.

No parameters.

scan_reverse

Only present when has_scan is declared true.

No parameters.

Only present when has_search is declared true.

ParameterTypeNotes
querystring

seek

Only present when has_seek is declared true.

ParameterTypeNotes
position_msu32

set_repeat

Only present when has_shuffle_repeat is declared true.

ParameterTypeNotes
modeone of off · one · all

set_shuffle

Only present when has_shuffle_repeat is declared true.

ParameterTypeNotes
shufflebool

skip_back

Only present when has_skip is declared true.

No parameters.

skip_forward

Only present when has_skip is declared true.

No parameters.

stop

No parameters.

Notifications

app_changed

Only present when has_apps is declared true.

ParameterTypeNotes
appstring

apps_changed

Only present when has_apps is declared true.

The installed application list, read from the device.

ParameterTypeNotes
app_iconsstring[] (optional)One artwork URL per entry in apps, same order, empty string where the device has none. A
control surface draws the channel the way its owner recognises it — by its logo, not its name.

These are addresses on the device, and they stay there: a client asks the controller for /artwork?binding=..&i=.. and the controller fetches the picture. That is what makes this work from a phone that is not on the television's network, and it means a driver only has to say where its artwork lives, not serve it. | | apps | string[] | |

metadata_changed

Only present when has_metadata is declared true.

ParameterTypeNotes
albumstring (optional)
art_urlstring (optional)
artiststring (optional)
duration_msu32 (optional)
titlestring (optional)

online_changed

ParameterTypeNotes
onlinebool

position_changed

Only present when has_seek is declared true.

ParameterTypeNotes
position_msu32

transport_changed

ParameterTypeNotes
stateone of playing · paused · stopped · buffering

State

Last-known values core keeps for a binding of this proxy.

KeyTypeMeaning
appstringApplication currently in the foreground
app_iconsstring[]Artwork for apps, one per entry, same order
appsstring[]Installed applications, as read from the device
artiststring
onlinebool
titlestring
transportstring