From: Jiyong Min Date: Wed, 3 Aug 2016 03:45:57 +0000 (+0900) Subject: Add the description for callback context X-Git-Tag: accepted/tizen/common/20160805.130150^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=8ece3702c46c7a9bed5c933f90d744e8bd050922;p=platform%2Fcore%2Fapi%2Fmedia-controller.git Add the description for callback context Change-Id: I32c6f3202dd611887d2828691ddc2cef8173ba70 Signed-off-by: jiyong min --- diff --git a/include/media_controller_client.h b/include/media_controller_client.h index b6dba20..540323d 100755 --- a/include/media_controller_client.h +++ b/include/media_controller_client.h @@ -38,6 +38,8 @@ extern "C" { * @brief Called when updating status of the media controller server. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * + * @remarks The callback is called in the dbus event loop. + * * @param[in] server_name, The app_id of the updated media controller server * @param[in] state, The state of the updated media controller server * @param[in] user_data The user data passed from the mc_client_set_server_update_cb() fuction @@ -52,6 +54,8 @@ typedef void (*mc_server_state_updated_cb)(const char *server_name, mc_server_st * @brief Called when updating the playback information of the media controller server. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * + * @remarks The callback is called in the dbus event loop. + * * @param[in] server_name, The app_id of the updated media controller server * @param[in] playback, The playback information of the updated media controller server * @param[in] user_data The user data passed from the mc_client_set_playback_update_cb() fuction @@ -66,6 +70,8 @@ typedef void (*mc_playback_updated_cb)(const char *server_name, mc_playback_h pl * @brief Called when updating the metadata of the media controller server. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * + * @remarks The callback is called in the dbus event loop. + * * @param[in] server_name, The app_id of the updated media controller server * @param[in] metadata, the metadata of the updated media controller server * @param[in] user_data The user data passed from the mc_client_set_metadata_update_cb() fuction @@ -80,6 +86,8 @@ typedef void (*mc_metadata_updated_cb)(const char *server_name, mc_metadata_h me * @brief Called when updating the shuffle mode of the media controller server. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * + * @remarks The callback is called in the dbus event loop. + * * @param[in] server_name, The app_id of the updated media controller server * @param[in] mode, The shuffle mode of the updated media controller server * @param[in] user_data The user data passed from the mc_client_set_shuffle_mode_update_cb() fuction @@ -94,6 +102,8 @@ typedef void (*mc_shuffle_mode_changed_cb)(const char *server_name, mc_shuffle_m * @brief Called when updating the repeat mode of the media controller server. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * + * @remarks The callback is called in the dbus event loop. + * * @param[in] server_name, The app_id of the updated media controller server * @param[in] mode, The repeat mode of the updated media controller server * @param[in] user_data The user data passed from the mc_client_set_repeat_mode_update_cb() fuction @@ -108,6 +118,8 @@ typedef void (*mc_repeat_mode_changed_cb)(const char *server_name, mc_repeat_mod * @brief Called when requesting the list of activated servers. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * + * @remarks The callback is called in the dbus event loop. + * * @param[in] server_name, The app_id of the activated media controller server * @param[in] user_data The user data passed from the mc_client_foreach_server() fuction * @@ -124,6 +136,8 @@ typedef bool (*mc_activated_server_cb)(const char *server_name, void *user_data) * @brief Called when receiving the command processing result from the server. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * + * @remarks The callback is called in the dbus event loop. + * * @param[in] server_name The app_id of the updated media controller server * @param[in] result_code The result code of custom command * @param[in] data The extra data @@ -139,6 +153,8 @@ typedef void (*mc_command_reply_received_cb)(const char *server_name, int result * @brief Called when requesting the list of subscribed servers. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * + * @remarks The callback is called in the dbus event loop. + * * @param[in] server_name, The app_id of the subscribed media controller server * @param[in] user_data The user data passed from the mc_client_foreach_server_subscribed() fuction * diff --git a/include/media_controller_server.h b/include/media_controller_server.h index f44e14b..19ef12a 100755 --- a/include/media_controller_server.h +++ b/include/media_controller_server.h @@ -40,6 +40,8 @@ extern "C" { * * @details This callback is called when server received playback state recommand from client. * + * @remarks The callback is called in the dbus event loop. + * * @param[in] client_name The app_id of the media controller client * @param[in] state The received playback state * @param[in] user_data The user data passed from the mc_server_set_playback_state_command_received_cb() fuction @@ -57,6 +59,8 @@ typedef void (*mc_server_playback_state_command_received_cb)(const char* client_ * @details This callback is called when server received custom recommand from client. * If there is reply for command, call mc_server_send_command_reply() function. * + * @remarks The callback is called in the dbus event loop. + * * @param[in] client_name The app_id of the media controller client * @param[in] command The received command * @param[in] data The extra data