From b6281cae2d9481a3c4e39d7d842ca3cd89894189 Mon Sep 17 00:00:00 2001 From: Gilbok Lee Date: Tue, 5 Dec 2023 17:49:20 +0900 Subject: [PATCH] [0.3.158] Remove profile tag from header description Change-Id: I216928610211aef860d9180e6f4bf76edeef9e99 --- doc/player_doc.h | 4 - include/player.h | 216 +++++++++++++++++++-------------------- include/tv/player.h | 182 ++++++++++++++++----------------- packaging/capi-media-player.spec | 2 +- 4 files changed, 198 insertions(+), 206 deletions(-) diff --git a/doc/player_doc.h b/doc/player_doc.h index 02157b0..344e47f 100644 --- a/doc/player_doc.h +++ b/doc/player_doc.h @@ -356,10 +356,6 @@ * These features are required for 360 video playback. * - %http://tizen.org/feature/multimedia.player.audio_offload * This feature is required for hardware-offloaded audio processing. - * @if WEARABLE - * - %http://tizen.org/feature/network.internet - * This feature is required for network streaming. - * @endif * * It is recommended to design feature related codes in your application for reliability. * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application. diff --git a/include/player.h b/include/player.h index 1b2ad89..d7238ae 100644 --- a/include/player.h +++ b/include/player.h @@ -27,7 +27,7 @@ extern "C" { /** * @brief The player error class define. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ #define PLAYER_ERROR_CLASS TIZEN_ERROR_PLAYER | 0x20 @@ -49,13 +49,13 @@ extern "C" { /** * @brief The media player's type handle. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef struct player_s *player_h; /** * @brief Enumeration for media player state. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef enum { PLAYER_STATE_NONE, /**< Player is not created */ @@ -67,7 +67,7 @@ typedef enum { /** * @brief Enumeration for media player's error codes. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef enum { PLAYER_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ @@ -101,7 +101,7 @@ typedef enum { /** * @brief Enumeration for media player's interruption type. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef enum { PLAYER_INTERRUPTED_BY_RESOURCE_CONFLICT = 4, /**< Interrupted by a resource conflict and the player handle will be paused or unprepared */ @@ -109,7 +109,7 @@ typedef enum { /** * @brief Enumeration for display type. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @details In case of using #PLAYER_DISPLAY_TYPE_OVERLAY_SYNC_UI, the video is rendering in full scale in the rendering area.\n * To change the video rendering position, use UI API functions like ecore_wl2_subsurface_exported_surface_move(), * ecore_wl2_subsurface_exported_surface_resize(), ecore_wl2_subsurface_exported_surface_transform_set(), @@ -130,7 +130,7 @@ typedef enum { /** * @brief Enumeration for audio latency mode. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef enum { AUDIO_LATENCY_MODE_LOW = 0, /**< Low audio latency mode */ @@ -140,7 +140,7 @@ typedef enum { /** * @brief Enumeration for stream type. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 */ typedef enum { PLAYER_STREAM_TYPE_DEFAULT, /**< Container type */ @@ -151,7 +151,7 @@ typedef enum { /** * @brief Enumeration of media stream buffer status. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @see player_set_media_stream_buffer_max_size() * @see player_set_media_stream_buffer_min_threshold() */ @@ -192,21 +192,21 @@ typedef enum { /** * @brief The player display handle. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef void *player_display_h; #ifndef GET_DISPLAY /** * @brief Definition for a display handle from evas object. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ #define GET_DISPLAY(x) (void *)(x) #endif /** * @brief Enumeration for display rotation type. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef enum { PLAYER_DISPLAY_ROTATION_NONE, /**< Display is not rotated */ @@ -217,7 +217,7 @@ typedef enum { /** * @brief Enumeration for display mode. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef enum { PLAYER_DISPLAY_MODE_LETTER_BOX = 0, /**< Letter box */ @@ -240,7 +240,7 @@ typedef enum { /** * @brief Enumeration for media stream content information. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef enum { PLAYER_CONTENT_INFO_ALBUM, /**< Album */ @@ -263,7 +263,7 @@ typedef enum { /** * @brief Called when the subtitle is updated. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The @a text should not be released and it can be used only in the callback. * To use outside, make a copy. * @param[in] duration The duration of the updated subtitle @@ -286,7 +286,7 @@ typedef void (*player_subtitle_updated_cb)(unsigned long duration, char *text, v /** * @brief Called when the media player is prepared. * @details It will be invoked when player has reached the begin of stream. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] user_data The user data passed from the callback registration function * @pre player_prepare_async() will cause this callback. * @post The player state will be #PLAYER_STATE_READY. @@ -297,7 +297,7 @@ typedef void (*player_prepared_cb)(void *user_data); /** * @brief Called when the media player is completed. * @details It will be invoked when player has reached the end of the stream. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] user_data The user data passed from the callback registration function * @pre It will be invoked when the playback is completed if you register this callback using player_set_completed_cb(). * @see player_set_completed_cb() @@ -307,7 +307,7 @@ typedef void (*player_completed_cb)(void *user_data); /** * @brief Called when the seek operation is completed. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] user_data The user data passed from the callback registration function * @see player_set_play_position() * @see player_set_play_position_nsec() @@ -319,7 +319,7 @@ typedef void (*player_seek_completed_cb)(void *user_data); * @details If the code is #PLAYER_INTERRUPTED_BY_RESOURCE_CONFLICT, * the player state will be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, or #PLAYER_STATE_PAUSED. * Application should get exact state by calling player_get_state(). - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] code The interrupted error code * @param[in] user_data The user data passed from the callback registration function * @see player_set_interrupted_cb() @@ -343,7 +343,7 @@ typedef void (*player_interrupted_cb)(player_interrupted_code_e code, void *user * #PLAYER_ERROR_NOT_SUPPORTED_AUDIO_CODEC (Since 4.0) * #PLAYER_ERROR_NOT_SUPPORTED_VIDEO_CODEC (Since 4.0) * #PLAYER_ERROR_NOT_SUPPORTED_SUBTITLE (Since 4.0) - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] error_code The error code * @param[in] user_data The user data passed from the callback registration function * @see player_set_error_cb() @@ -353,7 +353,7 @@ typedef void (*player_error_cb)(int error_code, void *user_data); /** * @brief Called when the video is captured. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The color space format of the captured image is #IMAGE_UTIL_COLORSPACE_RGB888. * @remarks The @a captured_data should not be released and it can be used only in the callback. * To use outside, make a copy. @@ -368,7 +368,7 @@ typedef void (*player_video_captured_cb)(unsigned char *captured_data, int width /** * @brief Called to register for notifications about delivering media packet when each video frame is decoded. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The UI update code must not be directly invoked.\n * @remarks The @a packet should be released using media_packet_destroy(). \n * If not, the decoder will fail due to having insufficient buffer space for the decoded frame. @@ -391,7 +391,7 @@ typedef void (*player_media_packet_audio_decoded_cb)(media_packet_h packet, void /** * @brief Called when the buffer level drops below the threshold of max size or no free space in buffer. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @param[in] status The buffer status * @param[in] user_data The user data passed from the callback registration function @@ -404,7 +404,7 @@ typedef void (*player_media_stream_buffer_status_cb)(player_media_stream_buffer_ /** * @brief Called to notify the next push-buffer offset when seeking is occurred. * @details The next push-buffer should produce buffers from the new offset. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @param[in] offset The new byte position to seek * @param[in] user_data The user data passed from the callback registration function @@ -435,7 +435,7 @@ typedef bool (*player_supported_media_format_cb)(media_format_mimetype_e format, /** * @brief Called to notify the video stream changed. * @details The video stream changing is detected just before rendering operation. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @param[in] width The width of the captured image * @param[in] height The height of the captured image * @param[in] fps The frame per second of the video \n @@ -459,7 +459,7 @@ typedef void (*player_video_stream_changed_cb)(int width, int height, int fps, i /** * @brief Called when the buffering percentage of the media playback is updated. * @details If the buffer is full, it will return 100%. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] percent The percentage of buffering completed (0~100) * @param[in] user_data The user data passed from the callback registration function * @see player_set_buffering_cb() @@ -491,7 +491,7 @@ typedef void (*player_adaptive_variant_cb)(int bandwidth, int width, int height, /** * @brief Creates a player handle for playing multimedia content. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks You must release @a player by using player_destroy().\n * Although you can create multiple player handles at the same time, * the player cannot guarantee proper operation because of limited resources, such as @@ -512,7 +512,7 @@ int player_create(player_h *player); /** * @brief Destroys the media player handle and releases all its resources. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks To completely shutdown player operation, call this function with a valid player handle from any player state. * @param[in] player The handle to the media player to be destroyed * @return @c 0 on success, @@ -528,7 +528,7 @@ int player_destroy(player_h player); /** * @brief Prepares the media player for playback. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) must be added if any video/audio files are used to play located in the internal storage. * @remarks The externalstorage privilege(http://tizen.org/privilege/externalstorage) must be added if any video/audio files are used to play located in the external storage. * @remarks The internet privilege(http://tizen.org/privilege/internet) must be added if any URLs are used to play from network. @@ -555,7 +555,7 @@ int player_prepare(player_h player); /** * @brief Prepares the media player for playback, asynchronously. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) must be added if any video/audio files are used to play located in the internal storage. * The externalstorage privilege(http://tizen.org/privilege/externalstorage) must be added if any video/audio files are used to play located in the external storage. * The internet privilege(http://tizen.org/privilege/internet) must be added if any URLs are used to play from network. \n @@ -587,7 +587,7 @@ int player_prepare_async(player_h player, player_prepared_cb callback, void *use * @details The most recently used media is reset and no longer associated with the player. * Playback is no longer possible. If you want to use the player again, you must set the data URI and call * player_prepare() again. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -608,7 +608,7 @@ int player_unprepare(player_h player); * * @details Associates media contents, referred to by the URI, with the player. * If the function call is successful, subsequent calls to player_prepare() and player_start() will start playing the media. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If you use HTTP or RTSP, URI must start with "http://" or "rtsp://". The default protocol is "file://". * If you provide an invalid URI, you won't receive an error message until you call player_start(). * @remarks This function must be called before calling the player_prepare() or player_prepare_async() to build the player based on the URI information. @@ -626,7 +626,6 @@ int player_unprepare(player_h player); * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state * @retval #PLAYER_ERROR_PERMISSION_DENIED Permission denied - * @if WEARABLE @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature @endif * @pre The player state must be set to #PLAYER_STATE_IDLE by calling player_create() or player_unprepare(). * @see player_set_memory_buffer() */ @@ -637,7 +636,7 @@ int player_set_uri(player_h player, const char *uri); * * @details Associates media content, cached in memory, with the player. Unlike the case of player_set_uri(), the media resides in memory. * If the function call is successful, subsequent calls to player_prepare() and player_start() will start playing the media. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If you provide an invalid data, you won't receive an error message until you call player_start(). * @remarks This function must be called before calling the player_prepare() or player_prepare_async() * to build the player based on the data. @@ -658,7 +657,7 @@ int player_set_memory_buffer(player_h player, const void *data, int size); /** * @brief Gets the player's current state. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[out] state The current state of the player * @return @c 0 on success, @@ -675,7 +674,7 @@ int player_get_state(player_h player, player_state_e *state); * The valid range is from 0 to 1.0, inclusive (1.0 = 100%). Default value is 1.0. * To change system volume, use the @ref CAPI_MEDIA_SOUND_MANAGER_MODULE API. * Finally, it does not support to set other value into each channel currently. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[in] left The left volume scalar * @param[in] right The right volume scalar @@ -693,7 +692,7 @@ int player_set_volume(player_h player, float left, float right); * @details The range of @a left and @a right is from @c 0 to @c 1.0, inclusive (1.0 = 100%). * This function gets the player volume, not the system volume. * To get the system volume, use the @ref CAPI_MEDIA_SOUND_MANAGER_MODULE API. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[out] left The current left volume scalar * @param[out] right The current right volume scalar @@ -750,7 +749,7 @@ int player_set_sound_stream_info(player_h player, sound_stream_info_h stream_inf /** * @brief Sets the audio latency mode. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The default audio latency mode of the player is #AUDIO_LATENCY_MODE_MID. * To get the current audio latency mode, use player_get_audio_latency_mode(). * If it's high mode, audio output interval can be increased so, it can keep more audio data to play. @@ -775,7 +774,7 @@ int player_set_audio_latency_mode(player_h player, audio_latency_mode_e latency_ /** * @brief Gets the current audio latency mode. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If audio offload is enabled by calling player_audio_offload_set_enabled(), * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) * @param[in] player The handle to the media player @@ -796,7 +795,7 @@ int player_get_audio_latency_mode(player_h player, audio_latency_mode_e *latency /** * @brief Starts or resumes playback. * @details Plays current media content, or resumes playback if the player is paused or buffering during HTTP streaming play. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks Even if you don't set visible to true by calling player_set_display_visible(), the video will be shown on #PLAYER_STATE_PLAYING state. * @remarks Since 3.0: \n * Sound can be mixed with other sounds, if you don't control the stream focus in sound-manager module.\n @@ -832,7 +831,7 @@ int player_start(player_h player); /** * @brief Stops playing media content. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -850,7 +849,7 @@ int player_stop(player_h player); /** * @brief Pauses the player. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks You can resume playback using player_start(). * * @param[in] player The handle to the media player @@ -869,7 +868,7 @@ int player_pause(player_h player); /** * @brief Sets the seek position for playback, asynchronously. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks This function will trigger the seeking operation on player instance like in the case of player_set_play_position_nsec(). * Normally application needs to wait for player_seek_completed_cb() before calling setting position function again. * Otherwise it will return #PLAYER_ERROR_SEEK_FAILED. @@ -939,7 +938,7 @@ int player_set_play_position_nsec(player_h player, int64_t nanoseconds, bool acc /** * @brief Gets the current position in milliseconds. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[out] milliseconds The current position in milliseconds * @return @c 0 on success, @@ -976,7 +975,7 @@ int player_get_play_position_nsec(player_h player, int64_t *nanoseconds); * @details If the mute status is @c true, no sounds are played. * If it is @c false, sounds are played at the previously set volume level. * Until this function is called, by default the player is not muted. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[in] muted The new mute status: (@c true = mute, @c false = not muted) * @return @c 0 on success, @@ -992,7 +991,7 @@ int player_set_mute(player_h player, bool muted); * @brief Gets the player's mute status. * @details If the mute status is @c true, no sounds are played. * If it is @c false, sounds are played at the previously set volume level. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[out] muted The current mute status: (@c true = mute, @c false = not muted) * @return @c 0 on success, @@ -1008,7 +1007,7 @@ int player_is_muted(player_h player, bool *muted); * @brief Sets the player's looping status. * @details If the looping status is @c true, playback automatically restarts upon finishing. * If it is @c false, it won't. The default value is @c false. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[in] looping The new looping status: (@c true = looping, @c false = non-looping ) * @return @c 0 on success, @@ -1024,7 +1023,7 @@ int player_set_looping(player_h player, bool looping); * @brief Gets the player's looping status. * @details If the looping status is @c true, playback automatically restarts upon finishing. * If it is @c false, it won't. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[out] looping The looping status: (@c true = looping, @c false = non-looping ) * @return @c 0 on success, @@ -1038,7 +1037,7 @@ int player_is_looping(player_h player, bool *looping); /** * @brief Sets the video display. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks To get @a display to set, use #GET_DISPLAY(). * @remarks We are not supporting changing display. * @remarks This function must be called before calling the player_prepare() or player_prepare_async() \n @@ -1070,7 +1069,7 @@ int player_set_display(player_h player, player_display_type_e type, player_displ /** * @brief Sets a callback function for getting the decoded video frame. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks This function must be called before calling player_prepare() or player_prepare_async().\n * A registered callback is called in a separate thread (not in the main loop).\n * A video frame can be retrieved using a registered callback as a media packet.\n @@ -1096,7 +1095,7 @@ int player_set_media_packet_video_frame_decoded_cb(player_h player, player_media /** * @brief Unsets the callback notifying the decoded video frame. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -1190,7 +1189,7 @@ int player_unset_media_packet_audio_frame_decoded_cb(player_h player); /** * @brief Pushes elementary stream to decode audio or video. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks player_set_media_stream_info() must be called before using this function. * @remarks The available buffer size can be set by calling player_set_media_stream_buffer_max_size(). * If there is no available buffer space, this function will return error since 3.0. @@ -1230,7 +1229,7 @@ int player_foreach_media_stream_supported_format(player_h player, player_support /** * @brief Sets contents information for media stream. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks AV format must be set before pushing elementary stream with player_push_media_stream(). * @remarks This function must be called before calling the player_prepare() or player_prepare_async() * to reflect the media information. @@ -1254,7 +1253,7 @@ int player_set_media_stream_info(player_h player, player_stream_type_e type, med /** * @brief Sets a callback function to be invoked when buffer underrun or overflow is occurred. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @remarks The callback is called in a separate thread (not in the main loop). * @param[in] player The handle to the media player @@ -1275,7 +1274,7 @@ int player_set_media_stream_buffer_status_cb(player_h player, player_stream_type /** * @brief Unsets the buffer status callback function. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @param[in] player The handle to the media player * @param[in] type The type of target stream @@ -1289,7 +1288,7 @@ int player_unset_media_stream_buffer_status_cb(player_h player, player_stream_ty /** * @brief Sets a callback function to be invoked when seeking is occurred. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @remarks The callback is called in a separate thread (not in the main loop). * @param[in] player The handle to the media player @@ -1310,7 +1309,7 @@ int player_set_media_stream_seek_cb(player_h player, player_stream_type_e type, /** * @brief Unsets the seek callback function. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @param[in] player The handle to the media player * @param[in] type The type of target stream * @return @c 0 on success, @@ -1323,7 +1322,7 @@ int player_unset_media_stream_seek_cb(player_h player, player_stream_type_e type /** * @brief Sets the max size bytes of buffer. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @remarks If the buffer level over the max size, player_media_stream_buffer_status_cb() will be invoked with overflow status. * @param[in] player The handle to the media player @@ -1340,7 +1339,7 @@ int player_set_media_stream_buffer_max_size(player_h player, player_stream_type_ /** * @brief Gets the max size bytes of buffer. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @remarks If the buffer level over the max size, player_media_stream_buffer_status_cb() will be invoked with overflow status. * @param[in] player The handle to the media player @@ -1357,7 +1356,7 @@ int player_get_media_stream_buffer_max_size(player_h player, player_stream_type_ /** * @brief Sets the buffer threshold percent of buffer. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @remarks If the buffer level drops below the percent value, player_media_stream_buffer_status_cb() will be invoked with underrun status. * @param[in] player The handle to the media player @@ -1374,7 +1373,7 @@ int player_set_media_stream_buffer_min_threshold(player_h player, player_stream_ /** * @brief Gets the buffer threshold percent of buffer. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @remarks If the buffer level drops below the percent value, player_media_stream_buffer_status_cb() will be invoked with underrun status. * @param[in] player The handle to the media player @@ -1400,7 +1399,7 @@ int player_get_media_stream_buffer_min_threshold(player_h player, player_stream_ /** * @brief Sets the video display mode. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If no display is set, no operation is performed. * @param[in] player The handle to the media player * @param[in] mode The display mode @@ -1418,7 +1417,7 @@ int player_set_display_mode(player_h player, player_display_mode_e mode); /** * @brief Gets the video display mode. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If no display is set, no operation is performed. * @param[in] player The handle to the media player * @param[out] mode The current display mode @@ -1458,7 +1457,7 @@ int player_set_display_roi_area(player_h player, int x, int y, int width, int he /** * @brief Sets the visibility of the video display. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If no display is set, no operation is performed. * @remarks If you set visible before calling player_set_display(), it will be applied on #PLAYER_STATE_READY state. * @param[in] player The handle to the media player @@ -1475,7 +1474,7 @@ int player_set_display_visible(player_h player, bool visible); /** * @brief Gets the visibility of the video display. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[out] visible The current visibility of the display (@c true = visible, @c false = non-visible ) * @return @c 0 on success, @@ -1491,7 +1490,7 @@ int player_is_display_visible(player_h player, bool *visible); * @brief Sets the rotation settings of the video surface display. * @details Use this function to change the video orientation to portrait mode. * The video out will be rotated in a counterclockwise direction. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If no display is set, no operation is performed. * @param[in] player The handle to the media player * @param[in] rotation The rotation of the display @@ -1509,7 +1508,7 @@ int player_set_display_rotation(player_h player, player_display_rotation_e rotat /** * @brief Gets the rotation of the video surface display. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[out] rotation The current rotation of the display * @return @c 0 on success, @@ -1535,7 +1534,7 @@ int player_get_display_rotation(player_h player, player_display_rotation_e *rota /** * @brief Gets the media content information. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks You must release @a value using @c free(). * @remarks The playback type should be local playback or HTTP streaming playback. * @param[in] player The handle to the media player @@ -1555,7 +1554,7 @@ int player_get_content_info(player_h player, player_content_info_e key, char **v /** * @brief Gets the audio and video codec information. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks You must release @a audio_codec and @a video_codec using free(). * @remarks The playback type should be local playback or HTTP streaming playback. * @param[in] player The handle to the media player @@ -1575,7 +1574,7 @@ int player_get_codec_info(player_h player, char **audio_codec, char **video_code /** * @brief Gets the audio stream information. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The playback type should be local playback or HTTP streaming playback. * @param[in] player The handle to the media player * @param[out] sample_rate The audio sample rate [Hz] \n @@ -1596,7 +1595,7 @@ int player_get_audio_stream_info(player_h player, int *sample_rate, int *channel /** * @brief Gets the video stream information. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The playback type should be local playback or HTTP streaming playback. * @param[in] player The handle to the media player * @param[out] fps The frame per second of the video \n @@ -1615,7 +1614,7 @@ int player_get_video_stream_info(player_h player, int *fps, int *bit_rate); /** * @brief Gets the video display's height and width. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The playback type should be local playback or HTTP streaming playback. * @param[in] player The handle to the media player * @param[out] width The width of the video \n @@ -1634,7 +1633,7 @@ int player_get_video_size(player_h player, int *width, int *height); /** * @brief Gets the album art in the media resource. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks You must not release @a album_art. * The @a album_art is managed by the platform and will be released * when the player is unprepared or destroyed by calling player_unprepare() or player_destroy(). @@ -1653,7 +1652,7 @@ int player_get_album_art(player_h player, void **album_art, int *size); /** * @brief Gets the total running time of the associated media. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The media source is associated with the player, using either player_set_uri() or player_set_memory_buffer(). * @remarks The playback type should be local playback or HTTP streaming playback. * @param[in] player The handle to the media player @@ -1701,7 +1700,7 @@ int player_get_duration_nsec(player_h player, int64_t *nanoseconds); /** * @brief Gets the number of equalizer bands. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If player_audio_effect_equalizer_is_available() returns @a available parameter as @c false, * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) * @param[in] player The handle to the media player @@ -1719,7 +1718,7 @@ int player_audio_effect_get_equalizer_bands_count(player_h player, int *count); /** * @brief Sets the gain set for the given equalizer band. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If player_audio_effect_equalizer_is_available() returns @a available parameter as @c false, * this function will return #PLAYER_ERROR_NOT_AVAILABLE and * this will not work at all even if it was called before enabling audio offload @@ -1744,7 +1743,7 @@ int player_audio_effect_set_equalizer_band_level(player_h player, int index, int /** * @brief Gets the gain set for the given equalizer band. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If player_audio_effect_equalizer_is_available() returns @a available parameter as @c false, * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) * @param[in] player The handle to the media player @@ -1762,7 +1761,7 @@ int player_audio_effect_get_equalizer_band_level(player_h player, int index, int /** * @brief Sets all bands of the equalizer. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If player_audio_effect_equalizer_is_available() returns @a available parameter as @c false, * this function will return #PLAYER_ERROR_NOT_AVAILABLE and * this will not work at all even if it was called before enabling audio offload @@ -1786,7 +1785,7 @@ int player_audio_effect_set_equalizer_all_bands(player_h player, int *band_level /** * @brief Gets the valid band level range of the equalizer. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If player_audio_effect_equalizer_is_available() returns @a available parameter as @c false, * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) * @param[in] player The handle to the media player @@ -1806,7 +1805,7 @@ int player_audio_effect_get_equalizer_level_range(player_h player, int *min, int /** * @brief Gets the band frequency of the equalizer. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If player_audio_effect_equalizer_is_available() returns @a available parameter as @c false, * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) * @param[in] player The handle to the media player @@ -1823,7 +1822,7 @@ int player_audio_effect_get_equalizer_band_frequency(player_h player, int index, /** * @brief Gets the band frequency range of the equalizer. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If player_audio_effect_equalizer_is_available() returns @a available parameter as @c false, * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) * @param[in] player The handle to the media player @@ -1840,7 +1839,7 @@ int player_audio_effect_get_equalizer_band_frequency_range(player_h player, int /** * @brief Clears the equalizer effect. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If player_audio_effect_equalizer_is_available() returns @a available parameter as @c false, * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) * @param[in] player The handle to the media player @@ -1860,7 +1859,7 @@ int player_audio_effect_equalizer_clear(player_h player); * @brief Checks whether the custom equalizer effect is available. * @details This function returns the availability of the audio effect function group and * it could be unavailable depending on the platform capabilities. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If audio offload is enabled by calling player_audio_offload_set_enabled(), * @a available will be @c false. * @param[in] player The handle to the media player @@ -1891,7 +1890,7 @@ int player_audio_effect_equalizer_is_available(player_h player, bool *available) /** * @brief Captures the video frame, asynchronously. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If the content is encrypted or there are copyright issues with it, * this function could be unsupported depending on the DRM policy. * In case the function is not supported by the DRM policy, it will return an error. @@ -1922,7 +1921,7 @@ int player_capture_video(player_h player, player_video_captured_cb callback, voi /** * @brief Sets the cookie for streaming playback. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks This function must be called before calling the player_prepare() or player_prepare_async() * to reflect the cookie information when the streaming connection is set up. * @param[in] player The handle to the media player @@ -1942,7 +1941,7 @@ int player_set_streaming_cookie(player_h player, const char *cookie, int size); /** * @brief Sets the streaming user agent for playback. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks This function must be called before calling the player_prepare() or player_prepare_async() * to reflect the user agent information when the streaming connection is set up. * @param[in] player The handle to the media player @@ -1962,7 +1961,7 @@ int player_set_streaming_user_agent(player_h player, const char *user_agent, int /** * @brief Gets the download progress for streaming playback. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[out] start The starting position of received data in percentage [0, 100] * @param[out] end The end position of received data in percentage [0, 100] @@ -1987,7 +1986,7 @@ int player_get_streaming_download_progress(player_h player, int *start, int *end /** * @brief Sets a callback function to be invoked when the playback is finished. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -2005,7 +2004,7 @@ int player_set_completed_cb(player_h player, player_completed_cb callback, void /** * @brief Unsets the playback completed callback function. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -2018,7 +2017,7 @@ int player_unset_completed_cb(player_h player); /** * @brief Sets a callback function to be invoked when the playback is interrupted or the interrupt is completed. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -2036,7 +2035,7 @@ int player_set_interrupted_cb(player_h player, player_interrupted_cb callback, v /** * @brief Unsets the interrupted callback function. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -2049,7 +2048,7 @@ int player_unset_interrupted_cb(player_h player); /** * @brief Sets a callback function to be invoked when an error occurs. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -2066,7 +2065,7 @@ int player_set_error_cb(player_h player, player_error_cb callback, void *user_da /** * @brief Unsets the error callback function. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -2088,7 +2087,7 @@ int player_unset_error_cb(player_h player); /** * @brief Sets a callback function to be invoked when there is a change in the buffering status of a media stream. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The media resource should be streamed over the network. * @param[in] player The handle to the media player * @param[in] callback The callback function to register @@ -2098,7 +2097,6 @@ int player_unset_error_cb(player_h player); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation - * @if WEARABLE @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature @endif * @post player_buffering_cb() will be invoked. * @see player_unset_buffering_cb() * @see player_set_uri() @@ -2108,7 +2106,7 @@ int player_set_buffering_cb(player_h player, player_buffering_cb callback, void /** * @brief Unsets the buffering callback function. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -2131,7 +2129,7 @@ int player_unset_buffering_cb(player_h player); /** * @brief Sets the playback rate. * @details The default value is @c 1.0. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks #PLAYER_ERROR_INVALID_OPERATION occurs when streaming playback. * @remarks No operation is performed, if @a rate is @c 0. * @remarks The sound is muted, when playback rate is under @c 0.0 and over @c 2.0. @@ -2162,7 +2160,7 @@ int player_set_playback_rate(player_h player, float rate); /** * @brief Sets a subtitle path. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks Only MicroDVD/SubViewer(*.sub), SAMI(*.smi), and SubRip(*.srt) subtitle formats are supported. * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) must be added if any files are used to play located in the internal storage. * @remarks The externalstorage privilege(http://tizen.org/privilege/externalstorage) must be added if any files are used to play located in the external storage. @@ -2182,7 +2180,7 @@ int player_set_subtitle_path(player_h player, const char *path); /** * @brief Sets a callback function to be invoked when a subtitle updates. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The callback is called in a separate thread (not in the main loop). * @param[in] player The handle to the media player * @param[in] callback The callback function to register @@ -2202,7 +2200,7 @@ int player_set_subtitle_updated_cb(player_h player, player_subtitle_updated_cb c /** * @brief Unsets the subtitle updated callback function. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -2215,7 +2213,7 @@ int player_unset_subtitle_updated_cb(player_h player); /** * @brief Sets the seek position for the subtitle. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif.1 + * @since_tizen 2.3.1 * @remarks Only MicroDVD/SubViewer(*.sub), SAMI(*.smi), and SubRip(*.srt) subtitle formats are supported. * @param[in] player The handle to the media player * @param[in] milliseconds The position in milliseconds from the start to the seek point @@ -2242,7 +2240,7 @@ int player_set_subtitle_position_offset(player_h player, int milliseconds); /** * @brief Sets a callback function to be invoked when video stream is changed. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks The stream changing is detected just before rendering operation. * @remarks The callback is called in a separate thread (not in the main loop). * @remarks This function must be called before calling the player_prepare() or player_prepare_async() @@ -2264,7 +2262,7 @@ int player_set_video_stream_changed_cb(player_h player, player_video_stream_chan /** * @brief Unsets the video stream changed callback function. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -2287,7 +2285,7 @@ int player_unset_video_stream_changed_cb(player_h player); /** * @brief Gets current track index. * @details Index starts from 0. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks If audio offload is enabled by calling player_audio_offload_set_enabled(), * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) * @param[in] player The handle to the media player @@ -2307,7 +2305,7 @@ int player_get_current_track(player_h player, player_stream_type_e type, int *in /** * @brief Gets language code of a track. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks @a code must be released with @c free() by caller * @remarks If audio offload is enabled by calling player_audio_offload_set_enabled(), * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) @@ -2329,7 +2327,7 @@ int player_get_track_language_code(player_h player, player_stream_type_e type, i /** * @brief Gets the track count. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks If audio offload is enabled by calling player_audio_offload_set_enabled(), * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) * @param[in] player The handle to the media player @@ -2349,7 +2347,7 @@ int player_get_track_count(player_h player, player_stream_type_e type, int *coun /** * @brief Selects a track to play. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks If audio offload is enabled by calling player_audio_offload_set_enabled(), * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) * @param[in] player The handle to the media player @@ -2899,7 +2897,7 @@ int player_get_video_codec_type(player_h player, player_codec_type_e *codec_type /** * @brief Sets the streaming buffering time. - * @since_tizen 4.0 + * 4.0 * @param[in] player The handle to the media player * @param[in] prebuffer_ms The time duration of buffering data that must be prerolled to start playback. \n * The value should be more than 1000 milliseconds to ensure the normal buffering. \n @@ -2918,7 +2916,6 @@ int player_get_video_codec_type(player_h player, player_codec_type_e *codec_type * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid state * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation (since 5.5) - * @if WEARABLE @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature @endif * @pre The player state must be #PLAYER_STATE_IDLE. * @see player_get_streaming_buffering_time() * @par Example @@ -2959,7 +2956,6 @@ int player_set_streaming_buffering_time(player_h player, int prebuffer_ms, int r * otherwise a negative error value * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter - * @if WEARABLE @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature @endif * @see player_set_streaming_buffering_time() */ int player_get_streaming_buffering_time(player_h player, int *prebuffer_ms, int *rebuffer_ms); diff --git a/include/tv/player.h b/include/tv/player.h index 9ed9b03..0d453a6 100644 --- a/include/tv/player.h +++ b/include/tv/player.h @@ -27,7 +27,7 @@ extern "C" { /** * @brief The player error class define. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ #define PLAYER_ERROR_CLASS TIZEN_ERROR_PLAYER | 0x20 @@ -49,13 +49,13 @@ extern "C" { /** * @brief The media player's type handle. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef struct player_s *player_h; /** * @brief Enumeration for media player state. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef enum { PLAYER_STATE_NONE, /**< Player is not created */ @@ -67,7 +67,7 @@ typedef enum { /** * @brief Enumeration for media player's error codes. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef enum { PLAYER_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ @@ -101,7 +101,7 @@ typedef enum { /** * @brief Enumeration for media player's interruption type. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef enum { PLAYER_INTERRUPTED_BY_RESOURCE_CONFLICT = 4, /**< Interrupted by a resource conflict and the player handle will be paused or unprepared */ @@ -109,7 +109,7 @@ typedef enum { /** * @brief Enumeration for display type. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @details In case of using #PLAYER_DISPLAY_TYPE_OVERLAY_SYNC_UI, the video is rendering in full scale in the rendering area.\n * To change the video rendering position, use UI API functions like ecore_wl2_subsurface_exported_surface_move(), * ecore_wl2_subsurface_exported_surface_resize(), ecore_wl2_subsurface_exported_surface_transform_set(), @@ -130,7 +130,7 @@ typedef enum { /** * @brief Enumeration for audio latency mode. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef enum { AUDIO_LATENCY_MODE_LOW = 0, /**< Low audio latency mode */ @@ -140,7 +140,7 @@ typedef enum { /** * @brief Enumeration for stream type. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 */ typedef enum { PLAYER_STREAM_TYPE_DEFAULT, /**< Container type */ @@ -151,7 +151,7 @@ typedef enum { /** * @brief Enumeration of media stream buffer status. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @see player_set_media_stream_buffer_max_size() * @see player_set_media_stream_buffer_min_threshold() */ @@ -192,21 +192,21 @@ typedef enum { /** * @brief The player display handle. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef void *player_display_h; #ifndef GET_DISPLAY /** * @brief Definition for a display handle from evas object. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ #define GET_DISPLAY(x) (void *)(x) #endif /** * @brief Enumeration for display rotation type. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef enum { PLAYER_DISPLAY_ROTATION_NONE, /**< Display is not rotated */ @@ -217,7 +217,7 @@ typedef enum { /** * @brief Enumeration for display mode. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef enum { PLAYER_DISPLAY_MODE_LETTER_BOX = 0, /**< Letter box */ @@ -240,7 +240,7 @@ typedef enum { /** * @brief Enumeration for media stream content information. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 */ typedef enum { PLAYER_CONTENT_INFO_ALBUM, /**< Album */ @@ -263,7 +263,7 @@ typedef enum { /** * @brief Called when the subtitle is updated. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The @a text should not be released and it can be used only in the callback. * To use outside, make a copy. * @param[in] duration The duration of the updated subtitle @@ -286,7 +286,7 @@ typedef void (*player_subtitle_updated_cb)(unsigned long duration, char *text, v /** * @brief Called when the media player is prepared. * @details It will be invoked when player has reached the begin of stream. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] user_data The user data passed from the callback registration function * @pre player_prepare_async() will cause this callback. * @post The player state will be #PLAYER_STATE_READY. @@ -297,7 +297,7 @@ typedef void (*player_prepared_cb)(void *user_data); /** * @brief Called when the media player is completed. * @details It will be invoked when player has reached the end of the stream. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] user_data The user data passed from the callback registration function * @pre It will be invoked when the playback is completed if you register this callback using player_set_completed_cb(). * @see player_set_completed_cb() @@ -307,7 +307,7 @@ typedef void (*player_completed_cb)(void *user_data); /** * @brief Called when the seek operation is completed. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] user_data The user data passed from the callback registration function * @see player_set_play_position() * @see player_set_play_position_nsec() @@ -319,7 +319,7 @@ typedef void (*player_seek_completed_cb)(void *user_data); * @details If the code is #PLAYER_INTERRUPTED_BY_RESOURCE_CONFLICT, * the player state will be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, or #PLAYER_STATE_PAUSED. * Application should get exact state by calling player_get_state(). - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] code The interrupted error code * @param[in] user_data The user data passed from the callback registration function * @see player_set_interrupted_cb() @@ -343,7 +343,7 @@ typedef void (*player_interrupted_cb)(player_interrupted_code_e code, void *user * #PLAYER_ERROR_NOT_SUPPORTED_AUDIO_CODEC (Since 4.0) * #PLAYER_ERROR_NOT_SUPPORTED_VIDEO_CODEC (Since 4.0) * #PLAYER_ERROR_NOT_SUPPORTED_SUBTITLE (Since 4.0) - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] error_code The error code * @param[in] user_data The user data passed from the callback registration function * @see player_set_error_cb() @@ -364,7 +364,7 @@ typedef void (*player_media_packet_audio_decoded_cb)(media_packet_h packet, void /** * @brief Called when the buffer level drops below the threshold of max size or no free space in buffer. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @param[in] status The buffer status * @param[in] user_data The user data passed from the callback registration function @@ -377,7 +377,7 @@ typedef void (*player_media_stream_buffer_status_cb)(player_media_stream_buffer_ /** * @brief Called to notify the next push-buffer offset when seeking is occurred. * @details The next push-buffer should produce buffers from the new offset. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @param[in] offset The new byte position to seek * @param[in] user_data The user data passed from the callback registration function @@ -408,7 +408,7 @@ typedef bool (*player_supported_media_format_cb)(media_format_mimetype_e format, /** * @brief Called to notify the video stream changed. * @details The video stream changing is detected just before rendering operation. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @param[in] width The width of the captured image * @param[in] height The height of the captured image * @param[in] fps The frame per second of the video \n @@ -432,7 +432,7 @@ typedef void (*player_video_stream_changed_cb)(int width, int height, int fps, i /** * @brief Called when the buffering percentage of the media playback is updated. * @details If the buffer is full, it will return 100%. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] percent The percentage of buffering completed (0~100) * @param[in] user_data The user data passed from the callback registration function * @see player_set_buffering_cb() @@ -464,7 +464,7 @@ typedef void (*player_adaptive_variant_cb)(int bandwidth, int width, int height, /** * @brief Creates a player handle for playing multimedia content. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks You must release @a player by using player_destroy().\n * Although you can create multiple player handles at the same time, * the player cannot guarantee proper operation because of limited resources, such as @@ -485,7 +485,7 @@ int player_create(player_h *player); /** * @brief Destroys the media player handle and releases all its resources. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks To completely shutdown player operation, call this function with a valid player handle from any player state. * @param[in] player The handle to the media player to be destroyed * @return @c 0 on success, @@ -501,7 +501,7 @@ int player_destroy(player_h player); /** * @brief Prepares the media player for playback. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) must be added if any video/audio files are used to play located in the internal storage. * @remarks The externalstorage privilege(http://tizen.org/privilege/externalstorage) must be added if any video/audio files are used to play located in the external storage. * @remarks The internet privilege(http://tizen.org/privilege/internet) must be added if any URLs are used to play from network. @@ -528,7 +528,7 @@ int player_prepare(player_h player); /** * @brief Prepares the media player for playback, asynchronously. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) must be added if any video/audio files are used to play located in the internal storage. * The externalstorage privilege(http://tizen.org/privilege/externalstorage) must be added if any video/audio files are used to play located in the external storage. * The internet privilege(http://tizen.org/privilege/internet) must be added if any URLs are used to play from network. \n @@ -560,7 +560,7 @@ int player_prepare_async(player_h player, player_prepared_cb callback, void *use * @details The most recently used media is reset and no longer associated with the player. * Playback is no longer possible. If you want to use the player again, you must set the data URI and call * player_prepare() again. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -581,7 +581,7 @@ int player_unprepare(player_h player); * * @details Associates media contents, referred to by the URI, with the player. * If the function call is successful, subsequent calls to player_prepare() and player_start() will start playing the media. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If you use HTTP or RTSP, URI must start with "http://" or "rtsp://". The default protocol is "file://". * If you provide an invalid URI, you won't receive an error message until you call player_start(). * @remarks This function must be called before calling the player_prepare() or player_prepare_async() to build the player based on the URI information. @@ -610,7 +610,7 @@ int player_set_uri(player_h player, const char *uri); * * @details Associates media content, cached in memory, with the player. Unlike the case of player_set_uri(), the media resides in memory. * If the function call is successful, subsequent calls to player_prepare() and player_start() will start playing the media. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If you provide an invalid data, you won't receive an error message until you call player_start(). * @remarks This function must be called before calling the player_prepare() or player_prepare_async() * to build the player based on the data. @@ -631,7 +631,7 @@ int player_set_memory_buffer(player_h player, const void *data, int size); /** * @brief Gets the player's current state. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[out] state The current state of the player * @return @c 0 on success, @@ -648,7 +648,7 @@ int player_get_state(player_h player, player_state_e *state); * The valid range is from 0 to 1.0, inclusive (1.0 = 100%). Default value is 1.0. * To change system volume, use the @ref CAPI_MEDIA_SOUND_MANAGER_MODULE API. * Finally, it does not support to set other value into each channel currently. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[in] left The left volume scalar * @param[in] right The right volume scalar @@ -666,7 +666,7 @@ int player_set_volume(player_h player, float left, float right); * @details The range of @a left and @a right is from @c 0 to @c 1.0, inclusive (1.0 = 100%). * This function gets the player volume, not the system volume. * To get the system volume, use the @ref CAPI_MEDIA_SOUND_MANAGER_MODULE API. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[out] left The current left volume scalar * @param[out] right The current right volume scalar @@ -723,7 +723,7 @@ int player_set_sound_stream_info(player_h player, sound_stream_info_h stream_inf /** * @brief Sets the audio latency mode. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The default audio latency mode of the player is #AUDIO_LATENCY_MODE_MID. * To get the current audio latency mode, use player_get_audio_latency_mode(). * If it's high mode, audio output interval can be increased so, it can keep more audio data to play. @@ -748,7 +748,7 @@ int player_set_audio_latency_mode(player_h player, audio_latency_mode_e latency_ /** * @brief Gets the current audio latency mode. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If audio offload is enabled by calling player_audio_offload_set_enabled(), * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) * @param[in] player The handle to the media player @@ -769,7 +769,7 @@ int player_get_audio_latency_mode(player_h player, audio_latency_mode_e *latency /** * @brief Starts or resumes playback. * @details Plays current media content, or resumes playback if the player is paused or buffering during HTTP streaming play. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks Even if you don't set visible to true by calling player_set_display_visible(), the video will be shown on #PLAYER_STATE_PLAYING state. * @remarks Since 3.0: \n * Sound can be mixed with other sounds, if you don't control the stream focus in sound-manager module.\n @@ -805,7 +805,7 @@ int player_start(player_h player); /** * @brief Stops playing media content. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -823,7 +823,7 @@ int player_stop(player_h player); /** * @brief Pauses the player. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks You can resume playback using player_start(). * * @param[in] player The handle to the media player @@ -842,7 +842,7 @@ int player_pause(player_h player); /** * @brief Sets the seek position for playback, asynchronously. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks This function will trigger the seeking operation on player instance like in the case of player_set_play_position_nsec(). * Normally application needs to wait for player_seek_completed_cb() before calling setting position function again. * Otherwise it will return #PLAYER_ERROR_SEEK_FAILED. @@ -912,7 +912,7 @@ int player_set_play_position_nsec(player_h player, int64_t nanoseconds, bool acc /** * @brief Gets the current position in milliseconds. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[out] milliseconds The current position in milliseconds * @return @c 0 on success, @@ -949,7 +949,7 @@ int player_get_play_position_nsec(player_h player, int64_t *nanoseconds); * @details If the mute status is @c true, no sounds are played. * If it is @c false, sounds are played at the previously set volume level. * Until this function is called, by default the player is not muted. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[in] muted The new mute status: (@c true = mute, @c false = not muted) * @return @c 0 on success, @@ -965,7 +965,7 @@ int player_set_mute(player_h player, bool muted); * @brief Gets the player's mute status. * @details If the mute status is @c true, no sounds are played. * If it is @c false, sounds are played at the previously set volume level. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[out] muted The current mute status: (@c true = mute, @c false = not muted) * @return @c 0 on success, @@ -981,7 +981,7 @@ int player_is_muted(player_h player, bool *muted); * @brief Sets the player's looping status. * @details If the looping status is @c true, playback automatically restarts upon finishing. * If it is @c false, it won't. The default value is @c false. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[in] looping The new looping status: (@c true = looping, @c false = non-looping ) * @return @c 0 on success, @@ -997,7 +997,7 @@ int player_set_looping(player_h player, bool looping); * @brief Gets the player's looping status. * @details If the looping status is @c true, playback automatically restarts upon finishing. * If it is @c false, it won't. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[out] looping The looping status: (@c true = looping, @c false = non-looping ) * @return @c 0 on success, @@ -1011,7 +1011,7 @@ int player_is_looping(player_h player, bool *looping); /** * @brief Sets the video display. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks To get @a display to set, use #GET_DISPLAY(). * @remarks We are not supporting changing display. * @remarks This function must be called before calling the player_prepare() or player_prepare_async() \n @@ -1124,7 +1124,7 @@ int player_unset_media_packet_audio_frame_decoded_cb(player_h player); /** * @brief Pushes elementary stream to decode audio or video. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks player_set_media_stream_info() must be called before using this function. * @remarks The available buffer size can be set by calling player_set_media_stream_buffer_max_size(). * If there is no available buffer space, this function will return error since 3.0. @@ -1164,7 +1164,7 @@ int player_foreach_media_stream_supported_format(player_h player, player_support /** * @brief Sets contents information for media stream. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks AV format must be set before pushing elementary stream with player_push_media_stream(). * @remarks This function must be called before calling the player_prepare() or player_prepare_async() * to reflect the media information. @@ -1188,7 +1188,7 @@ int player_set_media_stream_info(player_h player, player_stream_type_e type, med /** * @brief Sets a callback function to be invoked when buffer underrun or overflow is occurred. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @remarks The callback is called in a separate thread (not in the main loop). * @param[in] player The handle to the media player @@ -1209,7 +1209,7 @@ int player_set_media_stream_buffer_status_cb(player_h player, player_stream_type /** * @brief Unsets the buffer status callback function. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @param[in] player The handle to the media player * @param[in] type The type of target stream @@ -1223,7 +1223,7 @@ int player_unset_media_stream_buffer_status_cb(player_h player, player_stream_ty /** * @brief Sets a callback function to be invoked when seeking is occurred. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @remarks The callback is called in a separate thread (not in the main loop). * @param[in] player The handle to the media player @@ -1244,7 +1244,7 @@ int player_set_media_stream_seek_cb(player_h player, player_stream_type_e type, /** * @brief Unsets the seek callback function. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @param[in] player The handle to the media player * @param[in] type The type of target stream * @return @c 0 on success, @@ -1257,7 +1257,7 @@ int player_unset_media_stream_seek_cb(player_h player, player_stream_type_e type /** * @brief Sets the max size bytes of buffer. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @remarks If the buffer level over the max size, player_media_stream_buffer_status_cb() will be invoked with overflow status. * @param[in] player The handle to the media player @@ -1274,7 +1274,7 @@ int player_set_media_stream_buffer_max_size(player_h player, player_stream_type_ /** * @brief Gets the max size bytes of buffer. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @remarks If the buffer level over the max size, player_media_stream_buffer_status_cb() will be invoked with overflow status. * @param[in] player The handle to the media player @@ -1291,7 +1291,7 @@ int player_get_media_stream_buffer_max_size(player_h player, player_stream_type_ /** * @brief Sets the buffer threshold percent of buffer. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @remarks If the buffer level drops below the percent value, player_media_stream_buffer_status_cb() will be invoked with underrun status. * @param[in] player The handle to the media player @@ -1308,7 +1308,7 @@ int player_set_media_stream_buffer_min_threshold(player_h player, player_stream_ /** * @brief Gets the buffer threshold percent of buffer. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks This function is used for media stream playback only. * @remarks If the buffer level drops below the percent value, player_media_stream_buffer_status_cb() will be invoked with underrun status. * @param[in] player The handle to the media player @@ -1334,7 +1334,7 @@ int player_get_media_stream_buffer_min_threshold(player_h player, player_stream_ /** * @brief Sets the video display mode. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If no display is set, no operation is performed. * @param[in] player The handle to the media player * @param[in] mode The display mode @@ -1352,7 +1352,7 @@ int player_set_display_mode(player_h player, player_display_mode_e mode); /** * @brief Gets the video display mode. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If no display is set, no operation is performed. * @param[in] player The handle to the media player * @param[out] mode The current display mode @@ -1392,7 +1392,7 @@ int player_set_display_roi_area(player_h player, int x, int y, int width, int he /** * @brief Sets the visibility of the video display. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If no display is set, no operation is performed. * @remarks If you set visible before calling player_set_display(), it will be applied on #PLAYER_STATE_READY state. * @param[in] player The handle to the media player @@ -1409,7 +1409,7 @@ int player_set_display_visible(player_h player, bool visible); /** * @brief Gets the visibility of the video display. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[out] visible The current visibility of the display (@c true = visible, @c false = non-visible ) * @return @c 0 on success, @@ -1425,7 +1425,7 @@ int player_is_display_visible(player_h player, bool *visible); * @brief Sets the rotation settings of the video surface display. * @details Use this function to change the video orientation to portrait mode. * The video out will be rotated in a counterclockwise direction. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks If no display is set, no operation is performed. * @param[in] player The handle to the media player * @param[in] rotation The rotation of the display @@ -1443,7 +1443,7 @@ int player_set_display_rotation(player_h player, player_display_rotation_e rotat /** * @brief Gets the rotation of the video surface display. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[out] rotation The current rotation of the display * @return @c 0 on success, @@ -1469,7 +1469,7 @@ int player_get_display_rotation(player_h player, player_display_rotation_e *rota /** * @brief Gets the media content information. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks You must release @a value using @c free(). * @remarks The playback type should be local playback or HTTP streaming playback. * @param[in] player The handle to the media player @@ -1489,7 +1489,7 @@ int player_get_content_info(player_h player, player_content_info_e key, char **v /** * @brief Gets the audio and video codec information. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks You must release @a audio_codec and @a video_codec using free(). * @remarks The playback type should be local playback or HTTP streaming playback. * @param[in] player The handle to the media player @@ -1509,7 +1509,7 @@ int player_get_codec_info(player_h player, char **audio_codec, char **video_code /** * @brief Gets the audio stream information. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The playback type should be local playback or HTTP streaming playback. * @param[in] player The handle to the media player * @param[out] sample_rate The audio sample rate [Hz] \n @@ -1530,7 +1530,7 @@ int player_get_audio_stream_info(player_h player, int *sample_rate, int *channel /** * @brief Gets the video stream information. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The playback type should be local playback or HTTP streaming playback. * @param[in] player The handle to the media player * @param[out] fps The frame per second of the video \n @@ -1549,7 +1549,7 @@ int player_get_video_stream_info(player_h player, int *fps, int *bit_rate); /** * @brief Gets the video display's height and width. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The playback type should be local playback or HTTP streaming playback. * @param[in] player The handle to the media player * @param[out] width The width of the video \n @@ -1568,7 +1568,7 @@ int player_get_video_size(player_h player, int *width, int *height); /** * @brief Gets the album art in the media resource. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks You must not release @a album_art. * The @a album_art is managed by the platform and will be released * when the player is unprepared or destroyed by calling player_unprepare() or player_destroy(). @@ -1587,7 +1587,7 @@ int player_get_album_art(player_h player, void **album_art, int *size); /** * @brief Gets the total running time of the associated media. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The media source is associated with the player, using either player_set_uri() or player_set_memory_buffer(). * @remarks The playback type should be local playback or HTTP streaming playback. * @param[in] player The handle to the media player @@ -1634,7 +1634,7 @@ int player_get_duration_nsec(player_h player, int64_t *nanoseconds); /** * @brief Sets the cookie for streaming playback. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks This function must be called before calling the player_prepare() or player_prepare_async() * to reflect the cookie information when the streaming connection is set up. * @param[in] player The handle to the media player @@ -1654,7 +1654,7 @@ int player_set_streaming_cookie(player_h player, const char *cookie, int size); /** * @brief Sets the streaming user agent for playback. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks This function must be called before calling the player_prepare() or player_prepare_async() * to reflect the user agent information when the streaming connection is set up. * @param[in] player The handle to the media player @@ -1674,7 +1674,7 @@ int player_set_streaming_user_agent(player_h player, const char *user_agent, int /** * @brief Gets the download progress for streaming playback. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[out] start The starting position of received data in percentage [0, 100] * @param[out] end The end position of received data in percentage [0, 100] @@ -1699,7 +1699,7 @@ int player_get_streaming_download_progress(player_h player, int *start, int *end /** * @brief Sets a callback function to be invoked when the playback is finished. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -1717,7 +1717,7 @@ int player_set_completed_cb(player_h player, player_completed_cb callback, void /** * @brief Unsets the playback completed callback function. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -1730,7 +1730,7 @@ int player_unset_completed_cb(player_h player); /** * @brief Sets a callback function to be invoked when the playback is interrupted or the interrupt is completed. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -1748,7 +1748,7 @@ int player_set_interrupted_cb(player_h player, player_interrupted_cb callback, v /** * @brief Unsets the interrupted callback function. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -1761,7 +1761,7 @@ int player_unset_interrupted_cb(player_h player); /** * @brief Sets a callback function to be invoked when an error occurs. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function @@ -1778,7 +1778,7 @@ int player_set_error_cb(player_h player, player_error_cb callback, void *user_da /** * @brief Unsets the error callback function. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -1800,7 +1800,7 @@ int player_unset_error_cb(player_h player); /** * @brief Sets a callback function to be invoked when there is a change in the buffering status of a media stream. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The media resource should be streamed over the network. * @param[in] player The handle to the media player * @param[in] callback The callback function to register @@ -1820,7 +1820,7 @@ int player_set_buffering_cb(player_h player, player_buffering_cb callback, void /** * @brief Unsets the buffering callback function. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -1843,7 +1843,7 @@ int player_unset_buffering_cb(player_h player); /** * @brief Sets the playback rate. * @details The default value is @c 1.0. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks #PLAYER_ERROR_INVALID_OPERATION occurs when streaming playback. * @remarks No operation is performed, if @a rate is @c 0. * @remarks The sound is muted, when playback rate is under @c 0.0 and over @c 2.0. @@ -1874,7 +1874,7 @@ int player_set_playback_rate(player_h player, float rate); /** * @brief Sets a subtitle path. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks Only MicroDVD/SubViewer(*.sub), SAMI(*.smi), and SubRip(*.srt) subtitle formats are supported. * @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) must be added if any files are used to play located in the internal storage. * @remarks The externalstorage privilege(http://tizen.org/privilege/externalstorage) must be added if any files are used to play located in the external storage. @@ -1894,7 +1894,7 @@ int player_set_subtitle_path(player_h player, const char *path); /** * @brief Sets a callback function to be invoked when a subtitle updates. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @remarks The callback is called in a separate thread (not in the main loop). * @param[in] player The handle to the media player * @param[in] callback The callback function to register @@ -1914,7 +1914,7 @@ int player_set_subtitle_updated_cb(player_h player, player_subtitle_updated_cb c /** * @brief Unsets the subtitle updated callback function. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif + * @since_tizen 2.3 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -1927,7 +1927,7 @@ int player_unset_subtitle_updated_cb(player_h player); /** * @brief Sets the seek position for the subtitle. - * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif.1 + * @since_tizen 2.3.1 * @remarks Only MicroDVD/SubViewer(*.sub), SAMI(*.smi), and SubRip(*.srt) subtitle formats are supported. * @param[in] player The handle to the media player * @param[in] milliseconds The position in milliseconds from the start to the seek point @@ -1954,7 +1954,7 @@ int player_set_subtitle_position_offset(player_h player, int milliseconds); /** * @brief Sets a callback function to be invoked when video stream is changed. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks The stream changing is detected just before rendering operation. * @remarks The callback is called in a separate thread (not in the main loop). * @remarks This function must be called before calling the player_prepare() or player_prepare_async() @@ -1976,7 +1976,7 @@ int player_set_video_stream_changed_cb(player_h player, player_video_stream_chan /** * @brief Unsets the video stream changed callback function. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @param[in] player The handle to the media player * @return @c 0 on success, * otherwise a negative error value @@ -1999,7 +1999,7 @@ int player_unset_video_stream_changed_cb(player_h player); /** * @brief Gets current track index. * @details Index starts from 0. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks If audio offload is enabled by calling player_audio_offload_set_enabled(), * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) * @param[in] player The handle to the media player @@ -2019,7 +2019,7 @@ int player_get_current_track(player_h player, player_stream_type_e type, int *in /** * @brief Gets language code of a track. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks @a code must be released with @c free() by caller * @remarks If audio offload is enabled by calling player_audio_offload_set_enabled(), * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) @@ -2041,7 +2041,7 @@ int player_get_track_language_code(player_h player, player_stream_type_e type, i /** * @brief Gets the track count. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks If audio offload is enabled by calling player_audio_offload_set_enabled(), * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) * @param[in] player The handle to the media player @@ -2061,7 +2061,7 @@ int player_get_track_count(player_h player, player_stream_type_e type, int *coun /** * @brief Selects a track to play. - * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif + * @since_tizen 2.4 * @remarks If audio offload is enabled by calling player_audio_offload_set_enabled(), * this function will return #PLAYER_ERROR_NOT_AVAILABLE. (Since 5.5) * @param[in] player The handle to the media player diff --git a/packaging/capi-media-player.spec b/packaging/capi-media-player.spec index 0a201d6..a754434 100644 --- a/packaging/capi-media-player.spec +++ b/packaging/capi-media-player.spec @@ -1,6 +1,6 @@ Name: capi-media-player Summary: A Media Player API -Version: 0.3.157 +Version: 0.3.158 Release: 0 Group: Multimedia/API License: Apache-2.0 -- 2.7.4