 |
Zephyr API Documentation 4.0.0-rc3
A Scalable Open Source RTOS
|
|
Zephyr API Documentation 4.0.0-rc3
A Scalable Open Source RTOS
|
Available calls in a player, that the media proxy can call. More...
#include <media_proxy.h>
Data Fields | |
| const char *(* | get_player_name )(void) |
| Read Media Player Name. | |
| uint64_t(* | get_icon_id )(void) |
| Read Icon Object ID. | |
| const char *(* | get_icon_url )(void) |
| Read Icon URL. | |
| const char *(* | get_track_title )(void) |
| Read Track Title. | |
| int32_t(* | get_track_duration )(void) |
| Read Track Duration. | |
| int32_t(* | get_track_position )(void) |
| Read Track Position. | |
| void(* | set_track_position )(int32_t position) |
| Set Track Position. | |
| int8_t(* | get_playback_speed )(void) |
| Get Playback Speed. | |
| void(* | set_playback_speed )(int8_t speed) |
| Set Playback Speed. | |
| int8_t(* | get_seeking_speed )(void) |
| Get Seeking Speed. | |
| uint64_t(* | get_track_segments_id )(void) |
| Read Current Track Segments Object ID. | |
| uint64_t(* | get_current_track_id )(void) |
| Read Current Track Object ID. | |
| void(* | set_current_track_id )(uint64_t id) |
| Set Current Track Object ID. | |
| uint64_t(* | get_next_track_id )(void) |
| Read Next Track Object ID. | |
| void(* | set_next_track_id )(uint64_t id) |
| Set Next Track Object ID. | |
| uint64_t(* | get_parent_group_id )(void) |
| Read Parent Group Object ID. | |
| uint64_t(* | get_current_group_id )(void) |
| Read Current Group Object ID. | |
| void(* | set_current_group_id )(uint64_t id) |
| Set Current Group Object ID. | |
| uint8_t(* | get_playing_order )(void) |
| Read Playing Order. | |
| void(* | set_playing_order )(uint8_t order) |
| Set Playing Order. | |
| uint16_t(* | get_playing_orders_supported )(void) |
| Read Playing Orders Supported. | |
| uint8_t(* | get_media_state )(void) |
| Read Media State. | |
| void(* | send_command )(const struct mpl_cmd *command) |
| Send Command. | |
| uint32_t(* | get_commands_supported )(void) |
| Read Commands Supported. | |
| void(* | send_search )(const struct mpl_search *search) |
| Set Search. | |
| uint64_t(* | get_search_results_id )(void) |
| Read Search Results Object ID. | |
| uint8_t(* | get_content_ctrl_id )(void) |
| Read Content Control ID. | |
Available calls in a player, that the media proxy can call.
Given by a player when registering.
| uint32_t(* media_proxy_pl_calls::get_commands_supported) (void) |
Read Commands Supported.
Read a bitmap containing the media player's supported command opcodes. See the MEDIA_PROXY_OP_SUP_* defines.
| uint8_t(* media_proxy_pl_calls::get_content_ctrl_id) (void) |
Read Content Control ID.
The content control ID identifies a content control service on a device, and links it to the corresponding audio stream.
| uint64_t(* media_proxy_pl_calls::get_current_group_id) (void) |
Read Current Group Object ID.
Get an ID (48 bit) that can be used to retrieve the Current Track Object from an Object Transfer Service
See the Media Control Service spec v1.0 sections 3.14 and 4.4 for a description of the Current Group Object.
| uint64_t(* media_proxy_pl_calls::get_current_track_id) (void) |
Read Current Track Object ID.
Get an ID (48 bit) that can be used to retrieve the Current Track Object from an Object Transfer Service
See the Media Control Service spec v1.0 sections 3.11 and 4.3 for a description of the Current Track Object.
| uint64_t(* media_proxy_pl_calls::get_icon_id) (void) |
Read Icon Object ID.
Get an ID (48 bit) that can be used to retrieve the Icon Object from an Object Transfer Service
See the Media Control Service spec v1.0 sections 3.2 and 4.1 for a description of the Icon Object.
| const char *(* media_proxy_pl_calls::get_icon_url) (void) |
Read Icon URL.
Get a URL to the media player's icon.
| uint8_t(* media_proxy_pl_calls::get_media_state) (void) |
Read Media State.
Read the media player's state See the MEDIA_PROXY_MEDIA_STATE_* defines.
| uint64_t(* media_proxy_pl_calls::get_next_track_id) (void) |
Read Next Track Object ID.
Get an ID (48 bit) that can be used to retrieve the Next Track Object from an Object Transfer Service
| uint64_t(* media_proxy_pl_calls::get_parent_group_id) (void) |
Read Parent Group Object ID.
Get an ID (48 bit) that can be used to retrieve the Parent Track Object from an Object Transfer Service
The parent group is the parent of the current group.
See the Media Control Service spec v1.0 sections 3.14 and 4.4 for a description of the Current Track Object.
| int8_t(* media_proxy_pl_calls::get_playback_speed) (void) |
Get Playback Speed.
The playback speed parameter is related to the actual playback speed as follows: actual playback speed = 2^(speed_parameter/64)
A speed parameter of 0 corresponds to unity speed playback (i.e. playback at "normal" speed). A speed parameter of -128 corresponds to playback at one fourth of normal speed, 127 corresponds to playback at almost four times the normal speed.
| const char *(* media_proxy_pl_calls::get_player_name) (void) |
Read Media Player Name.
| uint8_t(* media_proxy_pl_calls::get_playing_order) (void) |
Read Playing Order.
return The media player's current playing order
| uint16_t(* media_proxy_pl_calls::get_playing_orders_supported) (void) |
Read Playing Orders Supported.
Read a bitmap containing the media player's supported playing orders. See the MEDIA_PROXY_PLAYING_ORDERS_SUPPORTED_* defines.
| uint64_t(* media_proxy_pl_calls::get_search_results_id) (void) |
Read Search Results Object ID.
Get an ID (48 bit) that can be used to retrieve the Search Results Object from an Object Transfer Service
The search results object is a group object. The search results object only exists if a successful search operation has been done.
| int8_t(* media_proxy_pl_calls::get_seeking_speed) (void) |
Get Seeking Speed.
The seeking speed gives the speed with which the player is seeking. It is a factor, relative to real-time playback speed - a factor four means seeking happens at four times the real-time playback speed. Positive values are for forward seeking, negative values for backwards seeking.
The seeking speed is not settable - a non-zero seeking speed is the result of "fast rewind" of "fast forward" commands.
| int32_t(* media_proxy_pl_calls::get_track_duration) (void) |
Read Track Duration.
The duration of a track is measured in hundredths of a second.
| int32_t(* media_proxy_pl_calls::get_track_position) (void) |
Read Track Position.
The position of the player (the playing position) is measured in hundredths of a second from the beginning of the track
| uint64_t(* media_proxy_pl_calls::get_track_segments_id) (void) |
Read Current Track Segments Object ID.
Get an ID (48 bit) that can be used to retrieve the Current Track Segments Object from an Object Transfer Service
See the Media Control Service spec v1.0 sections 3.10 and 4.2 for a description of the Track Segments Object.
| const char *(* media_proxy_pl_calls::get_track_title) (void) |
Read Track Title.
| void(* media_proxy_pl_calls::send_command) (const struct mpl_cmd *command) |
Send Command.
Send a command to the media player. For command opcodes (play, pause, ...) - see the MEDIA_PROXY_OP_* defines.
| command | The command to send |
| void(* media_proxy_pl_calls::send_search) (const struct mpl_search *search) |
Set Search.
Write a search to the media player. (For the formatting of a search, see the Media Control Service spec and the mcs.h file.)
| search | The search to write |
| void(* media_proxy_pl_calls::set_current_group_id) (uint64_t id) |
Set Current Group Object ID.
Change the player's current group to the group given by the ID, and the current track to the first track in that group.
| id | The ID of a group object |
| void(* media_proxy_pl_calls::set_current_track_id) (uint64_t id) |
Set Current Track Object ID.
Change the player's current track to the track given by the ID. (Behaves similarly to the goto track command.)
| id | The ID of a track object |
| void(* media_proxy_pl_calls::set_next_track_id) (uint64_t id) |
Set Next Track Object ID.
Change the player's next track to the track given by the ID.
| id | The ID of a track object |
| void(* media_proxy_pl_calls::set_playback_speed) (int8_t speed) |
Set Playback Speed.
See the get_playback_speed() function for an explanation of the playback speed parameter.
Note that the media player may not support all possible values of the playback speed parameter. If the value given is not supported, and is higher than the current value, the player should set the playback speed to the next higher supported value. (And correspondingly to the next lower supported value for given values lower than the current value.)
| speed | The playback speed parameter to set |
| void(* media_proxy_pl_calls::set_playing_order) (uint8_t order) |
Set Playing Order.
Set the media player's playing order. See the MEDIA_PROXY_PLAYING_ORDER_* defines.
| order | The playing order to set |
| void(* media_proxy_pl_calls::set_track_position) (int32_t position) |
Set Track Position.
Set the playing position of the media player in the current track. The position is given in hundredths of a second, from the beginning of the track of the track for positive values, and (backwards) from the end of the track for negative values.
| position | The player position to set |
1.12.0