* limitations under the License.
*/
-#ifndef __TIZEN_MEDIA_CONTROLLER_CLIENT_H__
-#define __TIZEN_MEDIA_CONTROLLER_CLIENT_H__
+#ifndef __TIZEN_MULTIMEDIA_MEDIA_CONTROLLER_CLIENT_H__
+#define __TIZEN_MULTIMEDIA_MEDIA_CONTROLLER_CLIENT_H__
#include <media_controller_type.h>
*
* @remarks The callback is called in the dbus event loop.
*
- * @param [in] server_name, The app_id of the updated media controller server, it can be used only in the callback. To use outside, make a copy.
- * @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
+ * @param[in] server_name The app_id of the updated media controller server, it can be used only in the callback. To use outside, make a copy.
+ * @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
*
* @pre mc_client_set_server_update_cb()
*
*
* @remarks The callback is called in the dbus event loop.
*
- * @param [in] server_name, The app_id of the updated media controller server, it can be used only in the callback. To use outside, make a copy.
- * @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
+ * @param[in] server_name The app_id of the updated media controller server, it can be used only in the callback. To use outside, make a copy.
+ * @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
*
* @pre mc_client_set_playback_update_cb()
*
*
* @remarks The callback is called in the dbus event loop.
*
- * @param [in] server_name, The app_id of the updated media controller server, it can be used only in the callback. To use outside, make a copy.
- * @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
+ * @param[in] server_name The app_id of the updated media controller server, it can be used only in the callback. To use outside, make a copy.
+ * @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
*
* @pre mc_client_set_metadata_update_cb()
*
*
* @remarks The callback is called in the dbus event loop.
*
- * @param [in] server_name, The app_id of the updated media controller server, it can be used only in the callback. To use outside, make a copy.
- * @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
+ * @param[in] server_name The app_id of the updated media controller server, it can be used only in the callback. To use outside, make a copy.
+ * @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
*
* @pre mc_client_set_shuffle_mode_update_cb()
*
*
* @remarks The callback is called in the dbus event loop.
*
- * @param [in] server_name, The app_id of the updated media controller server, it can be used only in the callback. To use outside, make a copy.
- * @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
+ * @param[in] server_name The app_id of the updated media controller server, it can be used only in the callback. To use outside, make a copy.
+ * @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
*
* @pre mc_client_set_repeat_mode_update_cb()
*
*
* @remarks The callback is called in the dbus event loop.
*
- * @param [in] server_name, The app_id of the activated media controller server, it can be used only in the callback. To use outside, make a copy.
- * @param [in] user_data The user data passed from the mc_client_foreach_server() fuction
+ * @param[in] server_name The app_id of the activated media controller server, it can be used only in the callback. To use outside, make a copy.
+ * @param[in] user_data The user data passed from the mc_client_foreach_server() fuction
*
* @return @c true to continue with the next iteration of the loop,
* otherwise @c false to break out of the loop
*
* @remarks The callback is called in the dbus event loop.
*
- * @param [in] server_name The app_id of the updated media controller server, it can be used only in the callback. To use outside, make a copy.
- * @param [in] result_code The result code of custom command
- * @param [in] data The extra data
- * @param [in] user_data The user data passed from the mc_client_send_custom_command() fuction
+ * @param[in] server_name The app_id of the updated media controller server, it can be used only in the callback. To use outside, make a copy.
+ * @param[in] result_code The result code of custom command
+ * @param[in] data The extra data
+ * @param[in] user_data The user data passed from the mc_client_send_custom_command() fuction
*
* @pre mc_client_send_custom_command()
*
*
* @remarks The callback is called in the dbus event loop.
*
- * @param [in] server_name, The app_id of the subscribed media controller server, it can be used only in the callback. To use outside, make a copy.
- * @param [in] user_data The user data passed from the mc_client_foreach_server_subscribed() fuction
+ * @param[in] server_name The app_id of the subscribed media controller server, it can be used only in the callback. To use outside, make a copy.
+ * @param[in] user_data The user data passed from the mc_client_foreach_server_subscribed() fuction
*
* @return @c true to continue with the next iteration of the loop,
* otherwise @c false to break out of the loop
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @remarks You must release @a client using mc_client_destroy().
+ * @remarks The @a client should be released using mc_client_destroy().
*
- * @param [out] client The handle to the media controller client
+ * @param[out] client The handle to the media controller client
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
/**
* @brief Sets the callback for monitoring status of the media controller server.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @details If media controller client call this function, basically the media controller client recieve the callback from all media controller servers.
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
- * @param [in] callback The callback to be invoked when the media controller server status is changed
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] client The handle to the media controller client
+ * @param[in] callback The callback to be invoked when the media controller server status is changed
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
+ * @param[in] client The handle to the media controller client
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
/**
* @brief Sets the callback for monitoring playback status of the media controller server.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @details If media controller client call this function, basically the media controller client recieve the callback from all media controller servers. \n
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
- * @param [in] callback The callback to be invoked when the playback status is changed
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] client The handle to the media controller client
+ * @param[in] callback The callback to be invoked when the playback status is changed
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
+ * @param[in] client The handle to the media controller client
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
/**
* @brief Sets the callback for monitoring metadata status of the media controller server.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @details If media controller client call this function, basically the media controller client recieve the callback from all media controller servers.
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
- * @param [in] callback The callback to be invoked when the metadata status is changed
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] client The handle to the media controller client
+ * @param[in] callback The callback to be invoked when the metadata status is changed
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
+ * @param[in] client The handle to the media controller client
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
/**
* @brief Sets the callback for monitoring shuffle mode of the media controller server.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @details If media controller client call this function, basically the media controller client recieve the callback from all media controller servers.
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
- * @param [in] callback The callback to be invoked when the shuffle mode is changed
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] client The handle to the media controller client
+ * @param[in] callback The callback to be invoked when the shuffle mode is changed
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
+ * @param[in] client The handle to the media controller client
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
/**
* @brief Sets the callback for monitoring repeat mode of the media controller server.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @details If media controller client call this function, basically the media controller client recieve the callback from all media controller servers.
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
- * @param [in] callback The callback to be invoked when the repeat mode is changed
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] client The handle to the media controller client
+ * @param[in] callback The callback to be invoked when the repeat mode is changed
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
+ * @param[in] client The handle to the media controller client
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
/**
* @brief Subscribes media controller server for monitoring status.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @details If media controller client subscribe media controller server, \n
* the media controller client recieve callback from subscribed media controller server. \n
* If media controller client subscribe media controller server one or more, \n
* the media controller client can recieve callback from only subscribed media controller server. \n
* If you want to subscribe for the all media controller server again, \n
* unset mode update callback and set the callback for the monitoring status again. \n
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
- * @param [in] subscription_type The subscription type
- * @param [in] server_name The app_id of the media controller server
+ * @param[in] client The handle to the media controller client
+ * @param[in] subscription_type The subscription type
+ * @param[in] server_name The app_id of the media controller server
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
/**
* @brief Unsubscribes media controller server for monitoring status.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @details If media controller client unsubscribe media controller server, \n
* the media controller client don't recieve callback from unsubscribed media controller server. \n
* If media controller client unsubscribe all subscibed media controller server, \n
* the media controller client don't recieve callback from all media controller server. \n
* After unset and set update callback function is called again, the media controller client can recieve callback from all media controller servers. \n
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
- * @param [in] subscription_type The subscription type
- * @param [in] server_name The app_id of the media controller server
+ * @param[in] client The handle to the media controller client
+ * @param[in] subscription_type The subscription type
+ * @param[in] server_name The app_id of the media controller server
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
- * @param [in] subscription_type The subscription type
- * @param [in] callback The callback to be invoked when the list of the subscribed media controller server.
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] client The handle to the media controller client
+ * @param[in] subscription_type The subscription type
+ * @param[in] callback The callback to be invoked when the list of the subscribed media controller server.
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @brief Gets the playback state.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release @a playback using @c mc_client_destroy_playback().
+ * @remarks The @a playback should be released using @c mc_client_destroy_playback().
*
- * @param [in] playback The handle to playback
- * @param [out] state The state of the playback
+ * @param[in] playback The handle to playback
+ * @param[out] state The state of the playback
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @brief Gets the playback position.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release @a playback using @c mc_client_destroy_playback().
+ * @remarks The @a playback should be released using @c mc_client_destroy_playback().
*
- * @param [in] playback The handle to playback
- * @param [out] position The position of the playback in milliseconds
+ * @param[in] playback The handle to playback
+ * @param[out] position The position of the playback in milliseconds
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
int mc_client_get_playback_position(mc_playback_h playback, unsigned long long *position);
/**
- * @brief Destroys playback
+ * @brief Destroys playback.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param [in] playback The handle to playback
+ * @param[in] playback The handle to playback
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @brief Gets the metadata.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release @a metadata using @c mc_client_destroy_metadata(). \n
- * And also You must release @a value using free().
+ * @remarks The @a metadata should be released using @c mc_client_destroy_metadata(). \n
+ * And also The @a value should be released using free().
* If the attribute value of the metadata is empty, return value is NULL.
*
- * @param [in] metadata The handle to metadata
- * @param [in] attribute The key attribute name to get
- * @param [out] value The value of the attribute
+ * @param[in] metadata The handle to metadata
+ * @param[in] attribute The key attribute name to get
+ * @param[out] value The value of the attribute
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
int mc_client_get_metadata(mc_metadata_h metadata, mc_meta_e attribute, char **value);
/**
- * @brief Destroys metadata
+ * @brief Destroys metadata.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param [in] metadata The handle to metadata
+ * @param[in] metadata The handle to metadata
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @remarks If there is no activated media controller server, return value of the server name is NULL.
+ * @remarks The @a server_name should be released using free(). \n
+ * If there is no activated media controller server, return value of the server name is NULL. \n
*
- * @param [in] client The handle to the media controller client
- * @param [out] server_name The app_id of the latest media controller server
- * @param [out] server_state The state of the latest media controller server
+ * @param[in] client The handle to the media controller client
+ * @param[out] server_name The app_id of the latest media controller server
+ * @param[out] server_state The state of the latest media controller server
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @remarks You must release @a playback using @c mc_client_destroy_playback(). \n
+ * @remarks The @a playback should be released using @c mc_client_destroy_playback(). \n
* If there is no playback info, return value of the playback is NULL.
*
- * @param [in] client The handle to the media controller client
- * @param [in] server_name The app_id of the server to requesting
- * @param [out] playback The handle to playback
+ * @param[in] client The handle to the media controller client
+ * @param[in] server_name The app_id of the server to requesting
+ * @param[out] playback The handle to playback
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @remarks You must release @a metadata using @c mc_client_destroy_metadata(). \n
+ * @remarks The @a metadata should be released using @c mc_client_destroy_metadata(). \n
* If there is no metadata, return value of the metadata is NULL.
*
- * @param [in] client The handle to the media controller client
- * @param [in] server_name The app_id of the server to requesting
- * @param [out] metadata The handle to metadata
+ * @param[in] client The handle to the media controller client
+ * @param[in] server_name The app_id of the server to requesting
+ * @param[out] metadata The handle to metadata
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
*
* @remarks If there is no shuffle mode info, return value is #MC_SHUFFLE_MODE_OFF.
*
- * @param [in] client The handle to the media controller client
- * @param [in] server_name The app_id of the server to requesting
- * @param [out] mode The info of the latest shuffle mode
+ * @param[in] client The handle to the media controller client
+ * @param[in] server_name The app_id of the server to requesting
+ * @param[out] mode The info of the latest shuffle mode
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
*
* @remarks If there is no repeat mode info, return value is #MC_REPEAT_MODE_OFF.
*
- * @param [in] client The handle to the media controller client
- * @param [in] server_name The app_id of the server to requesting
- * @param [out] mode The info of the latest shuffle mode
+ * @param[in] client The handle to the media controller client
+ * @param[in] server_name The app_id of the server to requesting
+ * @param[out] mode The info of the latest shuffle mode
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
- * @param [in] callback The callback to be invoked when the list of the registered media controller server created completely.
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] client The handle to the media controller client
+ * @param[in] callback The callback to be invoked when the list of the registered media controller server created completely.
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
- * @param [in] server_name The app_id of the media controller server
- * @param [in] state The playback state to send to media controller server
+ * @param[in] client The handle to the media controller client
+ * @param[in] server_name The app_id of the media controller server
+ * @param[in] state The playback state to send to media controller server
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
- * @param [in] server_name The app_id of the media controller server
- * @param [in] position The playback position to send to media controller server
+ * @param[in] client The handle to the media controller client
+ * @param[in] server_name The app_id of the media controller server
+ * @param[in] position The playback position to send to media controller server
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
- * @param [in] server_name The app_id of the media controller server
- * @param [in] shuffle_mode The shuffle mode to send to media controller server
+ * @param[in] client The handle to the media controller client
+ * @param[in] server_name The app_id of the media controller server
+ * @param[in] shuffle_mode The shuffle mode to send to media controller server
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
- * @param [in] server_name The app_id of the media controller server
- * @param [in] repeat_mode The repeat mode to send to media controller server
+ * @param[in] client The handle to the media controller client
+ * @param[in] server_name The app_id of the media controller server
+ * @param[in] repeat_mode The repeat mode to send to media controller server
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
/**
* @brief Sends the custom command to server.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @details If there is the result for comand from server, the media controller client will get the result of the custom command by mc_command_reply_received_cb() callback.
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.client
*
- * @param [in] client The handle to the media controller client
- * @param [in] server_name The app_id of the media controller server
- * @param [in] command The command to be sent
- * @param [in] data The extra data
- * @param [in] callback The callback to be invoked when the custom command execute completely.
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] client The handle to the media controller client
+ * @param[in] server_name The app_id of the media controller server
+ * @param[in] command The command to be sent
+ * @param[in] data The extra data
+ * @param[in] callback The callback to be invoked when the custom command execute completely.
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
/**
* @brief Destroys client.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @param [in] client The handle to the media controller client
+ * @param[in] client The handle to the media controller client
* @return @c 0 on success,
* otherwise a negative error value
* @retval #METADATA_EXTRACTOR_ERROR_NONE Successful
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_CONTROLLER_CLIENT_H__ */
+#endif /* __TIZEN_MULTIMEDIA_MEDIA_CONTROLLER_CLIENT_H__ */
* limitations under the License.
*/
-#ifndef __TIZEN_MEDIA_CONTROLLER_SERVER_H__
-#define __TIZEN_MEDIA_CONTROLLER_SERVER_H__
+#ifndef __TIZEN_MULTIMEDIA_MEDIA_CONTROLLER_SERVER_H__
+#define __TIZEN_MULTIMEDIA_MEDIA_CONTROLLER_SERVER_H__
#include <media_controller_type.h>
*
* @remarks The callback is called in the dbus event loop.
*
- * @param [in] client_name The app_id of the media controller client, it can be used only in the callback. To use outside, make a copy.
- * @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
+ * @param[in] client_name The app_id of the media controller client, it can be used only in the callback. To use outside, make a copy.
+ * @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
*
* @pre mc_server_set_playback_state_command_received_cb()
*
*
* @remarks The callback is called in the dbus event loop.
*
- * @param [in] client_name The app_id of the media controller client, it can be used only in the callback. To use outside, make a copy.
- * @param [in] position The received playback position
- * @param [in] user_data The user data passed from the mc_server_set_playback_position_command_received_cb() fuction
+ * @param[in] client_name The app_id of the media controller client, it can be used only in the callback. To use outside, make a copy.
+ * @param[in] position The received playback position
+ * @param[in] user_data The user data passed from the mc_server_set_playback_position_command_received_cb() fuction
*
* @pre mc_server_set_playback_position_command_received_cb()
*
*
* @remarks The callback is called in the dbus event loop.
*
- * @param [in] client_name The app_id of the media controller client, it can be used only in the callback. To use outside, make a copy.
- * @param [in] shuffle_mode The received shuffle_mode
- * @param [in] user_data The user data passed from the mc_server_set_shuffle_mode_command_received_cb() fuction
+ * @param[in] client_name The app_id of the media controller client, it can be used only in the callback. To use outside, make a copy.
+ * @param[in] shuffle_mode The received shuffle_mode
+ * @param[in] user_data The user data passed from the mc_server_set_shuffle_mode_command_received_cb() fuction
*
* @pre mc_server_set_shuffle_mode_command_received_cb()
*
*
* @remarks The callback is called in the dbus event loop.
*
- * @param [in] client_name The app_id of the media controller client, it can be used only in the callback. To use outside, make a copy.
- * @param [in] repeat_mode The received repeat mode
- * @param [in] user_data The user data passed from the mc_server_set_repeat_mode_command_received_cb() fuction
+ * @param[in] client_name The app_id of the media controller client, it can be used only in the callback. To use outside, make a copy.
+ * @param[in] repeat_mode The received repeat mode
+ * @param[in] user_data The user data passed from the mc_server_set_repeat_mode_command_received_cb() fuction
*
* @pre mc_server_set_repeat_mode_command_received_cb()
*
*
* @remarks The callback is called in the dbus event loop.
*
- * @param [in] client_name The app_id of the media controller client, it can be used only in the callback. To use outside, make a copy.
- * @param [in] command The received command
- * @param [in] data The extra data
- * @param [in] user_data The user data passed from the mc_server_set_custom_command_received_cb() fuction
+ * @param[in] client_name The app_id of the media controller client, it can be used only in the callback. To use outside, make a copy.
+ * @param[in] command The received command
+ * @param[in] data The extra data
+ * @param[in] user_data The user data passed from the mc_server_set_custom_command_received_cb() fuction
*
* @pre mc_server_set_custom_command_received_cb()
*
/**
* @brief Creates a media controller server.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @remarks You must release @a server using mc_server_destroy().
*
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [out] server The handle to media controller server
+ * @remarks The @a server should be released using mc_server_destroy().
+ *
+ * @param[out] server The handle to media controller server
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
int mc_server_create(mc_server_h *server);
/**
- * @brief Sets the playback state to update the latest state info
+ * @brief Sets the playback state to update the latest state info.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @param [in] server The handle to media controller server
- * @param [in] state The state to set
+ * @param[in] server The handle to media controller server
+ * @param[in] state The state to set
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
int mc_server_set_playback_state(mc_server_h server, mc_playback_states_e state);
/**
- * @brief Sets the playback position to update the latest playback info
+ * @brief Sets the playback position to update the latest playback info.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @param [in] server The handle to media controller server
- * @param [in] position The position to set in milliseconds
+ * @param[in] server The handle to media controller server
+ * @param[in] position The position to set in milliseconds
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
int mc_server_set_playback_position(mc_server_h server, unsigned long long position);
/**
- * @brief Update the modified playback info
- * @details If this API is called, the updated playback information will be sent to the controller.
+ * @brief Updates the modified playback info.
+ * @details If this function is called, the updated playback information will be sent to the controller.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [in] server The handle to media controller server
+ * @param[in] server The handle to media controller server
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
int mc_server_update_playback_info(mc_server_h server);
/**
- * @brief Sets the metadata to update the latest metadata info
+ * @brief Sets the metadata to update the latest metadata info.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [in] server The handle to media controller server
- * @param [in] attribute The key attribute name to set
- * @param [in] value The value of the attribute
+ * @param[in] server The handle to media controller server
+ * @param[in] attribute The key attribute name to set
+ * @param[in] value The value of the attribute
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
int mc_server_set_metadata(mc_server_h server, mc_meta_e attribute, const char *value);
/**
- * @brief Update the modified metadata info.
- * @details If this API is called, the updated metadata will be sent to all controllers.
+ * @brief Updates the modified metadata info.
+ * @details If this function is called, the updated metadata will be sent to all controllers.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [in] server The handle to media controller server
+ * @param[in] server The handle to media controller server
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
int mc_server_update_metadata(mc_server_h server);
/**
- * @brief Update the modified shuffle mode
- * @details If this API is called, the updated mode information will be sent to all controllers.
+ * @brief Updates the modified shuffle mode.
+ * @details If this function is called, the updated mode information will be sent to all controllers.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [in] server The handle to media controller server
- * @param [in] mode The shuffle mode to update the latest status
+ * @param[in] server The handle to media controller server
+ * @param[in] mode The shuffle mode to update the latest status
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
int mc_server_update_shuffle_mode(mc_server_h server, mc_shuffle_mode_e mode);
/**
- * @brief Updates the modified repeat mode
- * @details If this API is called, the updated mode information will be sent to all controllers.
+ * @brief Updates the modified repeat mode.
+ * @details If this function is called, the updated mode information will be sent to all controllers.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [in] server The handle to media controller server
- * @param [in] mode The repeat mode to update the latest status
+ * @param[in] server The handle to media controller server
+ * @param[in] mode The repeat mode to update the latest status
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [in] server The handle to media controller server
- * @param [in] callback The callback to be invoked when media controller server receives playback command from client.
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] server The handle to media controller server
+ * @param[in] callback The callback to be invoked when media controller server receives playback command from client.
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [in] server The handle to media controller server
+ * @param[in] server The handle to media controller server
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [in] server The handle to media controller server
- * @param [in] callback The callback to be invoked when media controller server receives position command from client.
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] server The handle to media controller server
+ * @param[in] callback The callback to be invoked when media controller server receives position command from client.
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [in] server The handle to media controller server
+ * @param[in] server The handle to media controller server
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [in] server The handle to media controller server
- * @param [in] callback The callback to be invoked when media controller server receives shuffle mode from client.
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] server The handle to media controller server
+ * @param[in] callback The callback to be invoked when media controller server receives shuffle mode from client.
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [in] server The handle to media controller server
+ * @param[in] server The handle to media controller server
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [in] server The handle to media controller server
- * @param [in] callback The callback to be invoked when media controller server receives repeat mode from client.
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] server The handle to media controller server
+ * @param[in] callback The callback to be invoked when media controller server receives repeat mode from client.
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [in] server The handle to media controller server
+ * @param[in] server The handle to media controller server
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [in] server The handle to media controller server
- * @param [in] callback The callback to be invoked when media controller server receives custom command from client.
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] server The handle to media controller server
+ * @param[in] callback The callback to be invoked when media controller server receives custom command from client.
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [in] server The handle to media controller server
+ * @param[in] server The handle to media controller server
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
/**
* @brief Sends a reply for the requested command to the client.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @remarks When server recieve command, this API can be called by mc_server_custom_command_received_cb().
*
* @privlevel public
* @privilege %http://tizen.org/privilege/mediacontroller.server
*
- * @param [in] server The handle to media controller server
- * @param [in] client_name The app_id of the media controller client
- * @param [in] result_code The result code of custom command
- * @param [in] data The extra data
+ * @remarks When server recieve command, this function can be called by mc_server_custom_command_received_cb().
+ *
+ * @param[in] server The handle to media controller server
+ * @param[in] client_name The app_id of the media controller client
+ * @param[in] result_code The result code of custom command
+ * @param[in] data The extra data
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTROLLER_ERROR_NONE Successful
/**
* @brief Destroys media controller server.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @param [in] server The handle to media controller server
+ * @param[in] server The handle to media controller server
* @return @c 0 on success,
* otherwise a negative error value
* @retval #METADATA_EXTRACTOR_ERROR_NONE Successful
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_CONTROLLER_SERVER_H__ */
+#endif /* __TIZEN_MULTIMEDIA_MEDIA_CONTROLLER_SERVER_H__ */