Tizen Native API
5.5
|
The Media Controller Client API provides functions for requesting the information to the server.
#include <media_controller_client.h>
The Media Controller Client API allows you to check the activated server status (mc_client_set_server_updated_cb()), the playback info (mc_client_set_playback_updated_cb()), the metadata (mc_client_set_metadata_updated_cb()) or the playlist(mc_client_set_playlist_updated_cb()).
And client can send the custom command to server(mc_client_send_custom_cmd()).
Before doing those things you should create handle(mc_client_create()). And if you don't use handle anymore, you have to destroy it(mc_client_destroy()). If there is no the activated server, you can get the latest server information by using mc_client_get_latest_server_info().
Functions | |
int | mc_client_create (mc_client_h *client) |
Creates a media controller client. | |
int | mc_client_set_server_updated_cb (mc_client_h client, mc_server_state_updated_cb callback, void *user_data) |
Sets the callback for monitoring status of the media controller server. | |
int | mc_client_unset_server_updated_cb (mc_client_h client) |
Unsets the callback for monitoring status of the media controller server. | |
int | mc_client_set_playback_updated_cb (mc_client_h client, mc_playback_updated_cb callback, void *user_data) |
Sets the callback for monitoring playback status of the media controller server. | |
int | mc_client_unset_playback_updated_cb (mc_client_h client) |
Unsets the callback for monitoring playback status of the media controller server. | |
int | mc_client_set_metadata_updated_cb (mc_client_h client, mc_metadata_updated_cb callback, void *user_data) |
Sets the callback for monitoring metadata status of the media controller server. | |
int | mc_client_unset_metadata_updated_cb (mc_client_h client) |
Unsets the callback for monitoring metadata status of the media controller server. | |
int | mc_client_set_shuffle_mode_updated_cb (mc_client_h client, mc_shuffle_mode_updated_cb callback, void *user_data) |
Sets the callback for monitoring shuffle mode of the media controller server. | |
int | mc_client_unset_shuffle_mode_updated_cb (mc_client_h client) |
Unsets the callback for monitoring shuffle mode of the media controller server. | |
int | mc_client_set_repeat_mode_updated_cb (mc_client_h client, mc_repeat_mode_updated_cb callback, void *user_data) |
Sets the callback for monitoring repeat mode of the media controller server. | |
int | mc_client_unset_repeat_mode_updated_cb (mc_client_h client) |
Unsets the callback for monitoring repeat mode of the media controller server. | |
int | mc_client_set_playback_ability_updated_cb (mc_client_h client, mc_playback_ability_updated_cb callback, void *user_data) |
Sets the callback for monitoring the playback ability of the media controller server. | |
int | mc_client_unset_playback_ability_updated_cb (mc_client_h client) |
Unsets the callback for monitoring the playback ability of the media controller server. | |
int | mc_client_set_shuffle_ability_updated_cb (mc_client_h client, mc_shuffle_ability_updated_cb callback, void *user_data) TIZEN_DEPRECATED_API |
Sets the callback for monitoring the shuffle ability of the media controller server. | |
int | mc_client_unset_shuffle_ability_updated_cb (mc_client_h client) TIZEN_DEPRECATED_API |
Unsets the callback for monitoring the shuffle ability of the media controller server. | |
int | mc_client_set_repeat_ability_updated_cb (mc_client_h client, mc_repeat_ability_updated_cb callback, void *user_data) TIZEN_DEPRECATED_API |
Sets the callback for monitoring the repeat ability of the media controller server. | |
int | mc_client_unset_repeat_ability_updated_cb (mc_client_h client) TIZEN_DEPRECATED_API |
Unsets the callback for monitoring the repeat ability of the media controller server. | |
int | mc_client_set_ability_support_updated_cb (mc_client_h client, mc_ability_support_updated_cb callback, void *user_data) |
Sets the callback for monitoring the media controller server's support for an ability. | |
int | mc_client_unset_ability_support_updated_cb (mc_client_h client) |
Unsets the callback for monitoring the media controller server's support for an ability. | |
int | mc_client_set_display_mode_ability_updated_cb (mc_client_h client, mc_ability_supported_items_updated_cb callback, void *user_data) |
Sets the callback for monitoring the display mode ability of the media controller server. | |
int | mc_client_unset_display_mode_ability_updated_cb (mc_client_h client) |
Unsets the callback for monitoring the display mode ability of the media controller server. | |
int | mc_client_set_display_rotation_ability_updated_cb (mc_client_h client, mc_ability_supported_items_updated_cb callback, void *user_data) |
Sets the callback for monitoring the display rotation ability of the media controller server. | |
int | mc_client_unset_display_rotation_ability_updated_cb (mc_client_h client) |
Unsets the callback for monitoring the display rotation ability of the media controller server. | |
int | mc_client_set_cmd_reply_received_cb (mc_client_h client, mc_cmd_reply_received_cb callback, void *user_data) |
Sets the callback for receiving the result of the command from the media controller server. | |
int | mc_client_unset_cmd_reply_received_cb (mc_client_h client) |
Unsets the callback for receiving common reply of the media controller server. | |
int | mc_client_set_playlist_updated_cb (mc_client_h client, mc_playlist_updated_cb callback, void *user_data) |
Sets the callback for monitoring playlist status of the media controller server. | |
int | mc_client_unset_playlist_updated_cb (mc_client_h client) |
Unsets the callback for monitoring playlist status of the media controller server. | |
int | mc_client_set_subtitles_updated_cb (mc_client_h client, mc_bool_attribute_updated_cb callback, void *user_data) |
Sets the callback for monitoring the media controller server's subtitles display. | |
int | mc_client_unset_subtitles_updated_cb (mc_client_h client) |
Unsets the callback for monitoring the media controller server's subtitles display. | |
int | mc_client_set_360_mode_updated_cb (mc_client_h client, mc_bool_attribute_updated_cb callback, void *user_data) |
Sets the callback for monitoring the media controller server's 360 mode display. | |
int | mc_client_unset_360_mode_updated_cb (mc_client_h client) |
Unsets the callback for monitoring the media controller server's 360 mode display. | |
int | mc_client_set_display_mode_updated_cb (mc_client_h client, mc_display_mode_updated_cb callback, void *user_data) |
Sets the callback for monitoring the media controller server's display mode. | |
int | mc_client_unset_display_mode_updated_cb (mc_client_h client) |
Unsets the callback for monitoring the media controller server's display mode. | |
int | mc_client_set_display_rotation_updated_cb (mc_client_h client, mc_display_rotation_updated_cb callback, void *user_data) |
Sets the callback for monitoring the media controller server's display rotation. | |
int | mc_client_unset_display_rotation_updated_cb (mc_client_h client) |
Unsets the callback for monitoring the media controller server's display rotation. | |
int | mc_client_set_custom_event_received_cb (mc_client_h client, mc_client_custom_event_received_cb callback, void *user_data) |
Sets the callback for receiving the custom event from a media controller server. | |
int | mc_client_unset_custom_event_received_cb (mc_client_h client) |
Unsets the callback for receiving the custom event from a media controller server. | |
int | mc_client_send_event_reply (mc_client_h client, const char *server_name, const char *request_id, int result_code, bundle *data) |
Replies with the result of the requested event to the media controller server. | |
int | mc_client_subscribe (mc_client_h client, mc_subscription_type_e subscription_type, const char *server_name) |
Subscribes media controller server for monitoring status. | |
int | mc_client_unsubscribe (mc_client_h client, mc_subscription_type_e subscription_type, const char *server_name) |
Unsubscribes media controller server for monitoring status. | |
int | mc_client_foreach_server_subscribed (mc_client_h client, mc_subscription_type_e subscription_type, mc_subscribed_server_cb callback, void *user_data) |
Retrieves all subscribed Server. | |
int | mc_client_get_playback_state (mc_playback_h playback, mc_playback_states_e *state) |
Gets the playback state. | |
int | mc_client_get_playback_position (mc_playback_h playback, unsigned long long *position) |
Gets the playback position. | |
int | mc_client_get_playlist_item_index (mc_playback_h playback, char **index) TIZEN_DEPRECATED_API |
Gets the index of the media in playlist. | |
int | mc_client_get_playlist_item_info (mc_playback_h playback, char **playlist_name, char **index) |
Gets the playlist name and index of the media in playlist. | |
int | mc_client_get_playback_content_type (mc_playback_h playback, mc_content_type_e *content_type) |
Gets the playback content type. | |
int | mc_client_get_age_rating (mc_playback_h playback, mc_content_age_rating_e *age_rating) |
Gets the age rating of the content. | |
int | mc_client_destroy_playback (mc_playback_h playback) |
Destroys playback. | |
int | mc_client_get_latest_server_info (mc_client_h client, char **server_name, mc_server_state_e *server_state) |
Gets the latest media controller server info. | |
int | mc_client_get_server_playback_info (mc_client_h client, const char *server_name, mc_playback_h *playback) |
Gets the latest playback info. | |
int | mc_client_get_server_metadata (mc_client_h client, const char *server_name, mc_metadata_h *metadata) |
Gets the latest metadata. | |
int | mc_client_get_server_shuffle_mode (mc_client_h client, const char *server_name, mc_shuffle_mode_e *mode) |
Gets the latest shuffle mode. | |
int | mc_client_get_server_repeat_mode (mc_client_h client, const char *server_name, mc_repeat_mode_e *mode) |
Gets the latest repeat mode. | |
int | mc_client_get_server_icon (mc_client_h client, const char *server_name, char **uri) |
Gets the icon URI of the media controller server. | |
int | mc_client_get_server_subtitles_enabled (mc_client_h client, const char *server_name, bool *enabled) |
Gets the latest subtitles display status. | |
int | mc_client_get_server_360_mode_enabled (mc_client_h client, const char *server_name, bool *enabled) |
Gets the latest 360 mode display status. | |
int | mc_client_get_server_display_mode (mc_client_h client, const char *server_name, mc_display_mode_e *mode) |
Gets the latest display mode. | |
int | mc_client_get_server_display_rotation (mc_client_h client, const char *server_name, mc_display_rotation_e *rotation) |
Gets the latest display rotation. | |
int | mc_client_get_server_playback_ability (mc_client_h client, const char *server_name, mc_playback_ability_h *ability) |
Gets the playback ability of the media controller server. | |
int | mc_client_get_server_shuffle_ability_support (mc_client_h client, const char *server_name, mc_ability_support_e *support) TIZEN_DEPRECATED_API |
Gets the support value of the shuffle ability of the updated media controller server. | |
int | mc_client_get_server_repeat_ability_support (mc_client_h client, const char *server_name, mc_ability_support_e *support) TIZEN_DEPRECATED_API |
Gets the support value of the repeat ability of the updated media controller server. | |
int | mc_client_get_server_ability_support (mc_client_h client, const char *server_name, mc_ability_e ability, mc_ability_support_e *support) |
Gets the ability support of the media controller server. | |
int | mc_client_get_server_display_mode_ability (mc_client_h client, const char *server_name, unsigned int *supported_modes) |
Gets the supported display mode of the updated media controller server. | |
int | mc_client_get_server_display_rotation_ability (mc_client_h client, const char *server_name, unsigned int *supported_rotations) |
Gets the supported display rotation of the updated media controller server. | |
int | mc_client_foreach_server (mc_client_h client, mc_activated_server_cb callback, void *user_data) |
Retrieves all created servers. | |
int | mc_client_foreach_server_playlist (mc_client_h client, const char *server_name, mc_playlist_cb callback, void *user_data) TIZEN_DEPRECATED_API |
Retrieves all playlists of the media controller server. | |
int | mc_client_send_playback_action_cmd (mc_client_h client, const char *server_name, mc_playback_action_e action, char **request_id) |
Sends the playback action command to server. | |
int | mc_client_send_playback_position_cmd (mc_client_h client, const char *server_name, unsigned long long position, char **request_id) |
Sends the playback position command to server. | |
int | mc_client_send_shuffle_mode_cmd (mc_client_h client, const char *server_name, mc_shuffle_mode_e shuffle_mode, char **request_id) |
Sends the shuffle mode command to server. | |
int | mc_client_send_repeat_mode_cmd (mc_client_h client, const char *server_name, mc_repeat_mode_e repeat_mode, char **request_id) |
Sends the repeat mode command to server. | |
int | mc_client_send_playlist_cmd (mc_client_h client, const char *server_name, const char *playlist_name, const char *index, mc_playback_action_e action, unsigned long long position, char **request_id) |
Sends the playlist command to server. | |
int | mc_client_send_custom_cmd (mc_client_h client, const char *server_name, const char *command, bundle *data, char **request_id) |
Sends the custom command to server. | |
int | mc_client_send_search_cmd (mc_client_h client, const char *server_name, mc_search_h search, char **request_id) |
Sends the search command to server. | |
int | mc_client_send_subtitles_cmd (mc_client_h client, const char *server_name, bool enable, char **request_id) |
Sends the subtitles command to server. | |
int | mc_client_send_360_mode_cmd (mc_client_h client, const char *server_name, bool enable, char **request_id) |
Sends the 360 mode command to server. | |
int | mc_client_send_display_mode_cmd (mc_client_h client, const char *server_name, mc_display_mode_e mode, char **request_id) |
Sends the display mode command to server. | |
int | mc_client_send_display_rotation_cmd (mc_client_h client, const char *server_name, mc_display_rotation_e rotation, char **request_id) |
Sends the display rotation command to server. | |
int | mc_client_destroy (mc_client_h client) |
Destroys client. | |
Typedefs | |
typedef void(* | mc_server_state_updated_cb )(const char *server_name, mc_server_state_e state, void *user_data) |
Called when the status of the media controller server is updated. | |
typedef void(* | mc_playback_updated_cb )(const char *server_name, mc_playback_h playback, void *user_data) |
Called when the playback information of the media controller server is updated. | |
typedef void(* | mc_metadata_updated_cb )(const char *server_name, mc_metadata_h metadata, void *user_data) |
Called when the metadata of the media controller server is updated. | |
typedef void(* | mc_shuffle_mode_updated_cb )(const char *server_name, mc_shuffle_mode_e mode, void *user_data) |
Called when the shuffle mode of the media controller server is updated. | |
typedef void(* | mc_repeat_mode_updated_cb )(const char *server_name, mc_repeat_mode_e mode, void *user_data) |
Called when the repeat mode of the media controller server is updated. | |
typedef void(* | mc_playback_ability_updated_cb )(const char *server_name, mc_playback_ability_h ability, void *user_data) |
Called when the playback ability support of the media controller server is updated. | |
typedef void(* | mc_shuffle_ability_updated_cb )(const char *server_name, mc_ability_support_e support, void *user_data) TIZEN_DEPRECATED_API |
Called when the shuffle ability support of the media controller server is updated. | |
typedef void(* | mc_repeat_ability_updated_cb )(const char *server_name, mc_ability_support_e support, void *user_data) TIZEN_DEPRECATED_API |
Called when the repeat ability of the media controller server is updated. | |
typedef void(* | mc_ability_support_updated_cb )(const char *server_name, mc_ability_e ability, mc_ability_support_e support, void *user_data) |
Called when a media controller server's support for an ability is updated. | |
typedef void(* | mc_ability_supported_items_updated_cb )(const char *server_name, unsigned int supported_items, void *user_data) |
Called when a media controller server's supported items for an ability is updated. | |
typedef bool(* | mc_activated_server_cb )(const char *server_name, void *user_data) |
Called when requesting the list of created servers. | |
typedef void(* | mc_cmd_reply_received_cb )(const char *server_name, const char *request_id, int result_code, bundle *data, void *user_data) |
Called when the result of the command from the server is received. | |
typedef bool(* | mc_subscribed_server_cb )(const char *server_name, void *user_data) |
Called when requesting the list of subscribed servers. | |
typedef void(* | mc_playlist_updated_cb )(const char *server_name, mc_playlist_update_mode_e mode, const char *playlist_name, mc_playlist_h playlist, void *user_data) |
Called when the playlist of the media controller server is updated. | |
typedef void(* | mc_client_custom_event_received_cb )(const char *server_name, const char *request_id, const char *event, bundle *data, void *user_data) |
Called when receiving custom event of media controller servers. | |
typedef void(* | mc_bool_attribute_updated_cb )(const char *server_name, bool enabled, void *user_data) |
Called when the status of a media controller server's boolean attribute (subtitles or 360 mode) is updated. | |
typedef void(* | mc_display_mode_updated_cb )(const char *server_name, mc_display_mode_e mode, void *user_data) |
Called when a media controller server's display mode is updated. | |
typedef void(* | mc_display_rotation_updated_cb )(const char *server_name, mc_display_rotation_e rotation, void *user_data) |
Called when a media controller server's display rotation is updated. |
typedef void(* mc_ability_support_updated_cb)(const char *server_name, mc_ability_e ability, mc_ability_support_e support, void *user_data) |
Called when a media controller server's support for an ability is updated.
[in] | server_name | The app_id of the media controller server which sent the notification |
[in] | ability | The ability |
[in] | support | The support value of the ability of the updated media controller server |
[in] | user_data | The user data passed from the callback function |
typedef void(* mc_ability_supported_items_updated_cb)(const char *server_name, unsigned int supported_items, void *user_data) |
Called when a media controller server's supported items for an ability is updated.
[in] | server_name | The app_id of the media controller server which sent the notification |
[in] | supported_items | The supported items of the updated media controller server |
[in] | user_data | The user data passed from the callback function |
typedef bool(* mc_activated_server_cb)(const char *server_name, void *user_data) |
Called when requesting the list of created servers.
[in] | server_name | The app_id of the created media controller server |
[in] | user_data | The user data passed from the mc_client_foreach_server() function |
true
to continue with the next iteration of the loop, otherwise false
to break out of the looptypedef void(* mc_bool_attribute_updated_cb)(const char *server_name, bool enabled, void *user_data) |
Called when the status of a media controller server's boolean attribute (subtitles or 360 mode) is updated.
[in] | server_name | The app_id of the media controller server which sent the notification |
[in] | enabled | The new status of the attribute |
[in] | user_data | The user data passed from the callback function |
typedef void(* mc_client_custom_event_received_cb)(const char *server_name, const char *request_id, const char *event, bundle *data, void *user_data) |
Called when receiving custom event of media controller servers.
[in] | server_name | The app_id of the subscribed media controller server |
[in] | request_id | The id of the custom event request |
[in] | event | The name of the custom event |
[in] | data | The data can include other information associated with the event |
[in] | user_data | The user data passed from the mc_client_set_custom_event_received_cb() function |
true
to continue with the next iteration of the loop, otherwise false
to break out of the looptypedef void(* mc_cmd_reply_received_cb)(const char *server_name, const char *request_id, int result_code, bundle *data, void *user_data) |
Called when the result of the command from the server is received.
[in] | server_name | The app_id of the media controller server which sent the reply |
[in] | request_id | The id of the command request |
[in] | result_code | The result code of the action |
[in] | data | The extra data |
[in] | user_data | The user data passed from the mc_client_set_cmd_reply_received_cb() function |
typedef void(* mc_display_mode_updated_cb)(const char *server_name, mc_display_mode_e mode, void *user_data) |
Called when a media controller server's display mode is updated.
[in] | server_name | The app_id of the media controller server which sent the notification |
[in] | mode | The display mode |
[in] | user_data | The user data passed from the callback function |
typedef void(* mc_display_rotation_updated_cb)(const char *server_name, mc_display_rotation_e rotation, void *user_data) |
Called when a media controller server's display rotation is updated.
[in] | server_name | The app_id of the media controller server which sent the notification |
[in] | rotation | The display rotation |
[in] | user_data | The user data passed from the callback function |
typedef void(* mc_metadata_updated_cb)(const char *server_name, mc_metadata_h metadata, void *user_data) |
Called when the metadata of the media controller server is updated.
[in] | server_name | The app_id of the media controller server which sent the notification |
[in] | metadata | The metadata of the updated media controller server |
[in] | user_data | The user data passed from the mc_client_set_metadata_updated_cb() function |
typedef void(* mc_playback_ability_updated_cb)(const char *server_name, mc_playback_ability_h ability, void *user_data) |
Called when the playback ability support of the media controller server is updated.
[in] | server_name | The app_id of the media controller server which sent the notification |
[in] | ability | The ability of the updated media controller server |
[in] | user_data | The user data passed from the mc_client_set_playback_ability_updated_cb() function |
typedef void(* mc_playback_updated_cb)(const char *server_name, mc_playback_h playback, void *user_data) |
Called when the playback information of the media controller server is updated.
[in] | server_name | The app_id of the media controller server which sent the notification |
[in] | playback | The playback information of the updated media controller server |
[in] | user_data | The user data passed from the mc_client_set_playback_updated_cb() function |
typedef void(* mc_playlist_updated_cb)(const char *server_name, mc_playlist_update_mode_e mode, const char *playlist_name, mc_playlist_h playlist, void *user_data) |
Called when the playlist of the media controller server is updated.
[in] | server_name | The app_id of the media controller server which sent the notification |
[in] | mode | The playlist update mode of the updated media controller server |
[in] | playlist_name | Updated playlist name |
[in] | playlist | The handle of the media controller playlist |
[in] | user_data | The user data passed from the mc_client_set_playlist_updated_cb() function |
typedef void(* mc_repeat_ability_updated_cb)(const char *server_name, mc_ability_support_e support, void *user_data) TIZEN_DEPRECATED_API |
Called when the repeat ability of the media controller server is updated.
[in] | server_name | The app_id of the media controller server which sent the notification |
[in] | support | The support value of the ability of the updated media controller server |
[in] | user_data | The user data passed from the mc_client_set_repeat_ability_updated_cb() function |
typedef void(* mc_repeat_mode_updated_cb)(const char *server_name, mc_repeat_mode_e mode, void *user_data) |
Called when the repeat mode of the media controller server is updated.
[in] | server_name | The app_id of the media controller server which sent the notification |
[in] | mode | The repeat mode of the updated media controller server |
[in] | user_data | The user data passed from the mc_client_set_repeat_mode_updated_cb() function |
typedef void(* mc_server_state_updated_cb)(const char *server_name, mc_server_state_e state, void *user_data) |
Called when the status of the media controller server is updated.
[in] | server_name | The app_id of the media controller server which sent the notification |
[in] | state | The state of the updated media controller server |
[in] | user_data | The user data passed from the mc_client_set_server_updated_cb() function |
typedef void(* mc_shuffle_ability_updated_cb)(const char *server_name, mc_ability_support_e support, void *user_data) TIZEN_DEPRECATED_API |
Called when the shuffle ability support of the media controller server is updated.
[in] | server_name | The app_id of the media controller server which sent the notification |
[in] | support | The support value of the ability of the updated media controller server |
[in] | user_data | The user data passed from the mc_client_set_shuffle_ability_updated_cb() function |
typedef void(* mc_shuffle_mode_updated_cb)(const char *server_name, mc_shuffle_mode_e mode, void *user_data) |
Called when the shuffle mode of the media controller server is updated.
[in] | server_name | The app_id of the media controller server which sent the notification |
[in] | mode | The shuffle mode of the updated media controller server |
[in] | user_data | The user data passed from the mc_client_set_shuffle_mode_updated_cb() function |
typedef bool(* mc_subscribed_server_cb)(const char *server_name, void *user_data) |
Called when requesting the list of subscribed servers.
[in] | server_name | The app_id of the subscribed media controller server |
[in] | user_data | The user data passed from the mc_client_foreach_server_subscribed() function |
true
to continue with the next iteration of the loop, otherwise false
to break out of the loopint mc_client_create | ( | mc_client_h * | client | ) |
Creates a media controller client.
The media controller client binds the latest media controller server when handlers are created.
mc_client_destroy()
. You can create only one client handle for each process.[out] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_destroy | ( | mc_client_h | client | ) |
Destroys client.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_destroy_playback | ( | mc_playback_h | playback | ) |
Destroys playback.
[in] | playback | The handle to playback |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
int mc_client_foreach_server | ( | mc_client_h | client, |
mc_activated_server_cb | callback, | ||
void * | user_data | ||
) |
Retrieves all created servers.
This function gets all created media controller servers. The callback function will be invoked for every created media controller server. If there are no media controller servers, the callback will not be invoked.
[in] | client | The handle of the media controller client |
[in] | callback | The callback function to be invoked, will be called for each server |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_foreach_server_playlist | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_playlist_cb | callback, | ||
void * | user_data | ||
) |
Retrieves all playlists of the media controller server.
This function gets all playlists of the media controller server. The callback function will be invoked for every retrieved playlist. If there are no playlists, the callback will not be invoked.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[in] | callback | The callback function to be invoked |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error valueMEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_foreach_server_subscribed | ( | mc_client_h | client, |
mc_subscription_type_e | subscription_type, | ||
mc_subscribed_server_cb | callback, | ||
void * | user_data | ||
) |
Retrieves all subscribed Server.
[in] | client | The handle of the media controller client |
[in] | subscription_type | The subscription type |
[in] | callback | The callback to be invoked when the list of the subscribed media controller server |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_get_age_rating | ( | mc_playback_h | playback, |
mc_content_age_rating_e * | age_rating | ||
) |
Gets the age rating of the content.
Gets the age rating of the current playing media.
[in] | playback | The handle to playback |
[out] | age_rating | Age rating of the content |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_get_latest_server_info | ( | mc_client_h | client, |
char ** | server_name, | ||
mc_server_state_e * | server_state | ||
) |
Gets the latest media controller server info.
The media controller client will get the most recently updated information by the server.
[in] | client | The handle of the media controller client |
[out] | server_name | The app_id of the latest media controller server |
[out] | server_state | The state of the latest media controller server |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_get_playback_content_type | ( | mc_playback_h | playback, |
mc_content_type_e * | content_type | ||
) |
Gets the playback content type.
Gets the content type of the current playing media. If there is no content type info, result value is MC_CONTENT_TYPE_UNDECIDED.
[in] | playback | The handle to playback |
[out] | content_type | The content type of the playback |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_get_playback_position | ( | mc_playback_h | playback, |
unsigned long long * | position | ||
) |
Gets the playback position.
[in] | playback | The handle to playback |
[out] | position | The position of the playback in milliseconds |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
int mc_client_get_playback_state | ( | mc_playback_h | playback, |
mc_playback_states_e * | state | ||
) |
Gets the playback state.
[in] | playback | The handle to playback |
[out] | state | The state of the playback |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
int mc_client_get_playlist_item_index | ( | mc_playback_h | playback, |
char ** | index | ||
) |
Gets the index of the media in playlist.
Gets the index of the current playing media in a playlist. If the media controller server didn't set the index, the value is NULL.
[in] | playback | The handle to playback |
[out] | index | The index of the media |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_get_playlist_item_info | ( | mc_playback_h | playback, |
char ** | playlist_name, | ||
char ** | index | ||
) |
Gets the playlist name and index of the media in playlist.
Gets the playlist name and index of the current playing media in a playlist.
If the media controller server didn't set the info, playlist_name and index will be set to NULL.
[in] | playback | The handle to playback |
[out] | playlist_name | The playlist name media included |
[out] | index | The index of the media |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_get_server_360_mode_enabled | ( | mc_client_h | client, |
const char * | server_name, | ||
bool * | enabled | ||
) |
Gets the latest 360 mode display status.
The media controller client will get the most recently updated information from server_name.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[out] | enabled | The status of the latest 360 mode display |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_get_server_ability_support | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_ability_e | ability, | ||
mc_ability_support_e * | support | ||
) |
Gets the ability support of the media controller server.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[in] | ability | The ability |
[out] | support | The support value of the ability |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_get_server_display_mode | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_display_mode_e * | mode | ||
) |
Gets the latest display mode.
The media controller client will get the most recently updated information from server_name.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[out] | mode | The info of the latest display mode |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_get_server_display_mode_ability | ( | mc_client_h | client, |
const char * | server_name, | ||
unsigned int * | supported_modes | ||
) |
Gets the supported display mode of the updated media controller server.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[out] | supported_modes | The supported display mode, values of mc_display_mode_e combined with bitwise 'or'. |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_get_server_display_rotation | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_display_rotation_e * | rotation | ||
) |
Gets the latest display rotation.
The media controller client will get the most recently updated information from server_name.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[out] | rotation | The info of the latest display rotation |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_get_server_display_rotation_ability | ( | mc_client_h | client, |
const char * | server_name, | ||
unsigned int * | supported_rotations | ||
) |
Gets the supported display rotation of the updated media controller server.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[out] | supported_rotations | The supported display rotation, values of mc_display_rotation_e combined with bitwise 'or' |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_get_server_icon | ( | mc_client_h | client, |
const char * | server_name, | ||
char ** | uri | ||
) |
Gets the icon URI of the media controller server.
free()
. [in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[out] | uri | The icon URI |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_get_server_metadata | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_metadata_h * | metadata | ||
) |
Gets the latest metadata.
The media controller client will get the most recently updated information from server_name.
mc_metadata_destroy()
. [in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[out] | metadata | The handle to metadata |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_get_server_playback_ability | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_playback_ability_h * | ability | ||
) |
Gets the playback ability of the media controller server.
mc_playback_ability_destroy()
.[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[out] | ability | The handle to ability |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_get_server_playback_info | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_playback_h * | playback | ||
) |
Gets the latest playback info.
The media controller client will get the most recently updated information from server_name.
mc_client_destroy_playback()
. [in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[out] | playback | The handle to playback |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_get_server_repeat_ability_support | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_ability_support_e * | support | ||
) |
Gets the support value of the repeat ability of the updated media controller server.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[out] | support | The support value of the repeat ability |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_get_server_repeat_mode | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_repeat_mode_e * | mode | ||
) |
Gets the latest repeat mode.
The media controller client will get the most recently updated information from server_name.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[out] | mode | The info of the latest shuffle mode |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
int mc_client_get_server_shuffle_ability_support | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_ability_support_e * | support | ||
) |
Gets the support value of the shuffle ability of the updated media controller server.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[out] | support | The support value of the shuffle ability |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_get_server_shuffle_mode | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_shuffle_mode_e * | mode | ||
) |
Gets the latest shuffle mode.
The media controller client will get the most recently updated information from server_name.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[out] | mode | The info of the latest shuffle mode |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
int mc_client_get_server_subtitles_enabled | ( | mc_client_h | client, |
const char * | server_name, | ||
bool * | enabled | ||
) |
Gets the latest subtitles display status.
The media controller client will get the most recently updated information from server_name.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[out] | enabled | The status of the latest subtitles display |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_send_360_mode_cmd | ( | mc_client_h | client, |
const char * | server_name, | ||
bool | enable, | ||
char ** | request_id | ||
) |
Sends the 360 mode command to server.
If the server sends the result of the command, the media controller client will get the result of the 360 mode command by mc_cmd_reply_received_cb() callback.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[in] | enable | The request status to send to media controller server |
[out] | request_id | The id of the command request, it will be passed to the mc_cmd_reply_received_cb() function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
MEDIA_CONTROLLER_ERROR_ABILITY_LIMITED_BY_SERVER_APP | Limited by server application |
int mc_client_send_custom_cmd | ( | mc_client_h | client, |
const char * | server_name, | ||
const char * | command, | ||
bundle * | data, | ||
char ** | request_id | ||
) |
Sends the custom command to server.
If the server sends the result of the command, the media controller client will get the result of the custom command by mc_cmd_reply_received_cb() callback.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[in] | command | The command to be sent |
[in] | data | The extra data |
[out] | request_id | The id of the command request, it will be passed to the mc_cmd_reply_received_cb() function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
MEDIA_CONTROLLER_ERROR_ABILITY_LIMITED_BY_SERVER_APP | Limited by server application |
int mc_client_send_display_mode_cmd | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_display_mode_e | mode, | ||
char ** | request_id | ||
) |
Sends the display mode command to server.
If the server sends the result of the command, the media controller client will get the result of the display mode command by mc_cmd_reply_received_cb() callback.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[in] | mode | The display mode to send to media controller server |
[out] | request_id | The id of the command request, it will be passed to the mc_cmd_reply_received_cb() function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
MEDIA_CONTROLLER_ERROR_ABILITY_LIMITED_BY_SERVER_APP | Limited by server application |
int mc_client_send_display_rotation_cmd | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_display_rotation_e | rotation, | ||
char ** | request_id | ||
) |
Sends the display rotation command to server.
If the server sends the result of the command, the media controller client will get the result of the display rotation command by mc_cmd_reply_received_cb() callback.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[in] | rotation | The display rotation to send to media controller server |
[out] | request_id | The id of the command request, it will be passed to the mc_cmd_reply_received_cb() function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
MEDIA_CONTROLLER_ERROR_ABILITY_LIMITED_BY_SERVER_APP | Limited by server application |
int mc_client_send_event_reply | ( | mc_client_h | client, |
const char * | server_name, | ||
const char * | request_id, | ||
int | result_code, | ||
bundle * | data | ||
) |
Replies with the result of the requested event to the media controller server.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[in] | request_id | The id of the event request, received in the mc_client_set_custom_event_received_cb() function |
[in] | result_code | The result code of custom event |
[in] | data | The extra data |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_send_playback_action_cmd | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_playback_action_e | action, | ||
char ** | request_id | ||
) |
Sends the playback action command to server.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[in] | action | The playback action command to send to the media controller server |
[out] | request_id | The id of the command request, it will be passed to the mc_cmd_reply_received_cb() function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
MEDIA_CONTROLLER_ERROR_ABILITY_LIMITED_BY_SERVER_APP | Limited by server application |
int mc_client_send_playback_position_cmd | ( | mc_client_h | client, |
const char * | server_name, | ||
unsigned long long | position, | ||
char ** | request_id | ||
) |
Sends the playback position command to server.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[in] | position | The position of the playback in milliseconds to send to media controller server |
[out] | request_id | The id of the command request, it will be passed to the mc_cmd_reply_received_cb() function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
MEDIA_CONTROLLER_ERROR_ABILITY_LIMITED_BY_SERVER_APP | Limited by server application |
int mc_client_send_playlist_cmd | ( | mc_client_h | client, |
const char * | server_name, | ||
const char * | playlist_name, | ||
const char * | index, | ||
mc_playback_action_e | action, | ||
unsigned long long | position, | ||
char ** | request_id | ||
) |
Sends the playlist command to server.
The media controller client can send "index" of the playlist to the media controller server with playback action and position.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[in] | playlist_name | The playlist name of the server |
[in] | index | The index of the media in playlist to send to the media controller server |
[in] | action | The playback action command to send to the media controller server |
[in] | position | The position of the playback in milliseconds to send to media controller server |
[out] | request_id | The id of the command request, it will be passed to the mc_cmd_reply_received_cb() function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
MEDIA_CONTROLLER_ERROR_ABILITY_LIMITED_BY_SERVER_APP | Limited by server application |
int mc_client_send_repeat_mode_cmd | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_repeat_mode_e | repeat_mode, | ||
char ** | request_id | ||
) |
Sends the repeat mode command to server.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[in] | repeat_mode | The repeat mode to send to media controller server |
[out] | request_id | The id of the command request, it will be passed to the mc_cmd_reply_received_cb() function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
MEDIA_CONTROLLER_ERROR_ABILITY_LIMITED_BY_SERVER_APP | Limited by server application |
int mc_client_send_search_cmd | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_search_h | search, | ||
char ** | request_id | ||
) |
Sends the search command to server.
If the server sends the result of the command, the media controller client will get the result of the search command by mc_cmd_reply_received_cb() callback.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[in] | search | The search handle to be sent |
[out] | request_id | The id of the command request, it will be passed to the mc_cmd_reply_received_cb() function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
MEDIA_CONTROLLER_ERROR_ABILITY_LIMITED_BY_SERVER_APP | Limited by server application |
int mc_client_send_shuffle_mode_cmd | ( | mc_client_h | client, |
const char * | server_name, | ||
mc_shuffle_mode_e | shuffle_mode, | ||
char ** | request_id | ||
) |
Sends the shuffle mode command to server.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[in] | shuffle_mode | The shuffle mode to send to media controller server |
[out] | request_id | The id of the command request, it will be passed to the mc_cmd_reply_received_cb() function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
MEDIA_CONTROLLER_ERROR_ABILITY_LIMITED_BY_SERVER_APP | Limited by server application |
int mc_client_send_subtitles_cmd | ( | mc_client_h | client, |
const char * | server_name, | ||
bool | enable, | ||
char ** | request_id | ||
) |
Sends the subtitles command to server.
If the server sends the result of the command, the media controller client will get the result of the subtitles command by mc_cmd_reply_received_cb() callback.
[in] | client | The handle of the media controller client |
[in] | server_name | The app_id of the media controller server |
[in] | enable | The request status to send to media controller server |
[out] | request_id | The id of the command request, it will be passed to the mc_cmd_reply_received_cb() function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
MEDIA_CONTROLLER_ERROR_ABILITY_LIMITED_BY_SERVER_APP | Limited by server application |
int mc_client_set_360_mode_updated_cb | ( | mc_client_h | client, |
mc_bool_attribute_updated_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for monitoring the media controller server's 360 mode display.
The media controller client which calls this function will receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the 360 mode is changed |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_ability_support_updated_cb | ( | mc_client_h | client, |
mc_ability_support_updated_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for monitoring the media controller server's support for an ability.
The media controller client which calls this function will receive notifications from all media controller servers. This function can be used to monitor the following abilities:
MC_ABILITY_SHUFFLE,
MC_ABILITY_REPEAT,
MC_ABILITY_PLAYBACK_POSITION,
MC_ABILITY_PLAYLIST,
MC_ABILITY_CLIENT_CUSTOM,
MC_ABILITY_SEARCH,
MC_ABILITY_SUBTITLES,
MC_ABILITY_360_MODE,
To monitor the media controller server's support for other abilities, use corresponding function.
For a playback ability, use mc_client_set_playback_ability_updated_cb().
For a display mode ability, use mc_client_set_display_mode_ability_updated_cb().
For a display rotation ability, use mc_client_set_display_rotation_ability_updated_cb().
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the ability is changed |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_cmd_reply_received_cb | ( | mc_client_h | client, |
mc_cmd_reply_received_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for receiving the result of the command from the media controller server.
The media controller client which calls this function will receives the result of the command from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the reply is received |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_custom_event_received_cb | ( | mc_client_h | client, |
mc_client_custom_event_received_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for receiving the custom event from a media controller server.
[in] | client | The handle to media controller client |
[in] | callback | The callback to be invoked when the media controller client receives custom event from a media controller server |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_display_mode_ability_updated_cb | ( | mc_client_h | client, |
mc_ability_supported_items_updated_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for monitoring the display mode ability of the media controller server.
The media controller client which calls this function will receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the ability is changed |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_display_mode_updated_cb | ( | mc_client_h | client, |
mc_display_mode_updated_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for monitoring the media controller server's display mode.
The media controller client which calls this function will receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the display mode is changed |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_display_rotation_ability_updated_cb | ( | mc_client_h | client, |
mc_ability_supported_items_updated_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for monitoring the display rotation ability of the media controller server.
The media controller client which calls this function will receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the ability is changed |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_display_rotation_updated_cb | ( | mc_client_h | client, |
mc_display_rotation_updated_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for monitoring the media controller server's display rotation.
The media controller client which calls this function will receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the display rotation is changed |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_metadata_updated_cb | ( | mc_client_h | client, |
mc_metadata_updated_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for monitoring metadata status of the media controller server.
The media controller client which calls this function will receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the metadata status is changed |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_playback_ability_updated_cb | ( | mc_client_h | client, |
mc_playback_ability_updated_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for monitoring the playback ability of the media controller server.
The media controller client which calls this function will receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the ability is changed |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_playback_updated_cb | ( | mc_client_h | client, |
mc_playback_updated_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for monitoring playback status of the media controller server.
The media controller client which calls this function will receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the playback status is changed |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_playlist_updated_cb | ( | mc_client_h | client, |
mc_playlist_updated_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for monitoring playlist status of the media controller server.
The media controller client which calls this function will receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the playlist status is changed |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_repeat_ability_updated_cb | ( | mc_client_h | client, |
mc_repeat_ability_updated_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for monitoring the repeat ability of the media controller server.
The media controller client which calls this function will receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the ability is changed |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_repeat_mode_updated_cb | ( | mc_client_h | client, |
mc_repeat_mode_updated_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for monitoring repeat mode of the media controller server.
The media controller client which calls this function will receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the repeat mode is changed |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_server_updated_cb | ( | mc_client_h | client, |
mc_server_state_updated_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for monitoring status of the media controller server.
The media controller client which calls this function will receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the media controller server status is changed |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_shuffle_ability_updated_cb | ( | mc_client_h | client, |
mc_shuffle_ability_updated_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for monitoring the shuffle ability of the media controller server.
The media controller client which calls this function will receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the ability is changed |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_shuffle_mode_updated_cb | ( | mc_client_h | client, |
mc_shuffle_mode_updated_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for monitoring shuffle mode of the media controller server.
The media controller client which calls this function will receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the shuffle mode is changed |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_set_subtitles_updated_cb | ( | mc_client_h | client, |
mc_bool_attribute_updated_cb | callback, | ||
void * | user_data | ||
) |
Sets the callback for monitoring the media controller server's subtitles display.
The media controller client which calls this function will receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | callback | The callback to be invoked when the subtitles status is changed |
[in] | user_data | The user data to be passed to the callback function |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_subscribe | ( | mc_client_h | client, |
mc_subscription_type_e | subscription_type, | ||
const char * | server_name | ||
) |
Subscribes media controller server for monitoring status.
If media controller client subscribe media controller server, the media controller client receive callback from subscribed media controller server.
If media controller client subscribe media controller server one or more, the media controller client can receive callback from only subscribed media controller server.
If you want to subscribe for the all media controller server again, unset mode update callback and set the callback for the monitoring status again.
[in] | client | The handle of the media controller client |
[in] | subscription_type | The subscription type |
[in] | server_name | The app_id of the media controller server |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
MEDIA_CONTROLLER_ERROR_OUT_OF_MEMORY | Out of memory |
int mc_client_unset_360_mode_updated_cb | ( | mc_client_h | client | ) |
Unsets the callback for monitoring the media controller server's 360 mode display.
The media controller client which calls this function will not receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unset_ability_support_updated_cb | ( | mc_client_h | client | ) |
Unsets the callback for monitoring the media controller server's support for an ability.
The media controller client which calls this function will not receive notifications from all media controller servers. This function can be used for the following abilities:
MC_ABILITY_SHUFFLE,
MC_ABILITY_REPEAT,
MC_ABILITY_PLAYBACK_POSITION,
MC_ABILITY_PLAYLIST,
MC_ABILITY_CLIENT_CUSTOM,
MC_ABILITY_SEARCH,
MC_ABILITY_SUBTITLES,
MC_ABILITY_360_MODE,
To stop monitoring the media controller server's support for other abilities, use corresponding function.
For a playback ability, use mc_client_unset_playback_ability_updated_cb().
For a display mode ability, use mc_client_unset_display_mode_ability_updated_cb().
For a display rotation ability, use mc_client_unset_display_rotation_ability_updated_cb().
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unset_cmd_reply_received_cb | ( | mc_client_h | client | ) |
Unsets the callback for receiving common reply of the media controller server.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unset_custom_event_received_cb | ( | mc_client_h | client | ) |
Unsets the callback for receiving the custom event from a media controller server.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unset_display_mode_ability_updated_cb | ( | mc_client_h | client | ) |
Unsets the callback for monitoring the display mode ability of the media controller server.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unset_display_mode_updated_cb | ( | mc_client_h | client | ) |
Unsets the callback for monitoring the media controller server's display mode.
The media controller client which calls this function will not receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
Unsets the callback for monitoring the display rotation ability of the media controller server.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unset_display_rotation_updated_cb | ( | mc_client_h | client | ) |
Unsets the callback for monitoring the media controller server's display rotation.
The media controller client which calls this function will not receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unset_metadata_updated_cb | ( | mc_client_h | client | ) |
Unsets the callback for monitoring metadata status of the media controller server.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unset_playback_ability_updated_cb | ( | mc_client_h | client | ) |
Unsets the callback for monitoring the playback ability of the media controller server.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unset_playback_updated_cb | ( | mc_client_h | client | ) |
Unsets the callback for monitoring playback status of the media controller server.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unset_playlist_updated_cb | ( | mc_client_h | client | ) |
Unsets the callback for monitoring playlist status of the media controller server.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unset_repeat_ability_updated_cb | ( | mc_client_h | client | ) |
Unsets the callback for monitoring the repeat ability of the media controller server.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unset_repeat_mode_updated_cb | ( | mc_client_h | client | ) |
Unsets the callback for monitoring repeat mode of the media controller server.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unset_server_updated_cb | ( | mc_client_h | client | ) |
Unsets the callback for monitoring status of the media controller server.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unset_shuffle_ability_updated_cb | ( | mc_client_h | client | ) |
Unsets the callback for monitoring the shuffle ability of the media controller server.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unset_shuffle_mode_updated_cb | ( | mc_client_h | client | ) |
Unsets the callback for monitoring shuffle mode of the media controller server.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unset_subtitles_updated_cb | ( | mc_client_h | client | ) |
Unsets the callback for monitoring the media controller server's subtitles display.
The media controller client which calls this function will not receive notifications from all media controller servers.
[in] | client | The handle of the media controller client |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |
int mc_client_unsubscribe | ( | mc_client_h | client, |
mc_subscription_type_e | subscription_type, | ||
const char * | server_name | ||
) |
Unsubscribes media controller server for monitoring status.
If media controller client unsubscribe media controller server,
the media controller client don't receive callback from unsubscribed media controller server.
If media controller client unsubscribe all subscribed media controller server, the media controller client don't receive callback from all media controller server.
After unset and set update callback function is called again, the media controller client can receive callback from all media controller servers.
[in] | client | The handle of the media controller client |
[in] | subscription_type | The subscription type |
[in] | server_name | The app_id of the media controller server |
0
on success, otherwise a negative error value MEDIA_CONTROLLER_ERROR_NONE | Successful |
MEDIA_CONTROLLER_ERROR_PERMISSION_DENIED | Permission denied |
MEDIA_CONTROLLER_ERROR_INVALID_PARAMETER | Invalid parameter |
MEDIA_CONTROLLER_ERROR_INVALID_OPERATION | Invalid operation |