From a85e722b0a227c24d7a488abffea83a362367800 Mon Sep 17 00:00:00 2001 From: Eunhae Choi Date: Wed, 26 Apr 2017 17:56:31 +0900 Subject: [PATCH] [ACR-955] Add new error code and fix doxygen bug Change-Id: Iaef49715284dad6b0963b2f7a4fa7f6bf035768d --- include/player.h | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/include/player.h b/include/player.h index 24659db..0812be3 100644 --- a/include/player.h +++ b/include/player.h @@ -69,7 +69,7 @@ typedef enum { PLAYER_ERROR_NO_SUCH_FILE = TIZEN_ERROR_NO_SUCH_FILE, /**< No such file or directory */ PLAYER_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Invalid operation */ PLAYER_ERROR_FILE_NO_SPACE_ON_DEVICE = TIZEN_ERROR_FILE_NO_SPACE_ON_DEVICE, /**< No space left on the device */ - PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */ + PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported Feature */ PLAYER_ERROR_SEEK_FAILED = PLAYER_ERROR_CLASS | 0x01, /**< Seek operation failure */ PLAYER_ERROR_INVALID_STATE = PLAYER_ERROR_CLASS | 0x02, /**< Invalid state */ PLAYER_ERROR_NOT_SUPPORTED_FILE = PLAYER_ERROR_CLASS | 0x03, /**< File format not supported */ @@ -84,7 +84,10 @@ typedef enum { PLAYER_ERROR_RESOURCE_LIMIT = PLAYER_ERROR_CLASS | 0x0c, /**< Resource limit */ PLAYER_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */ PLAYER_ERROR_SERVICE_DISCONNECTED = PLAYER_ERROR_CLASS | 0x0d, /**< Socket connection lost (Since 3.0) */ - PLAYER_ERROR_BUFFER_SPACE = TIZEN_ERROR_BUFFER_SPACE, /**< No buffer space available (Since 3.0)*/ + PLAYER_ERROR_BUFFER_SPACE = TIZEN_ERROR_BUFFER_SPACE, /**< No buffer space available (Since 3.0) */ + PLAYER_ERROR_NOT_SUPPORTED_AUDIO_CODEC = PLAYER_ERROR_CLASS | 0x0e, /**< Not supported audio codec but video can be played (Since 4.0) */ + PLAYER_ERROR_NOT_SUPPORTED_VIDEO_CODEC = PLAYER_ERROR_CLASS | 0x0f, /**< Not supported video codec but audio can be played (Since 4.0) */ + PLAYER_ERROR_NOT_SUPPORTED_SUBTITLE = PLAYER_ERROR_CLASS | 0x10, /**< Not supported subtitle format (Since 4.0) */ } player_error_e; /** @@ -316,6 +319,9 @@ typedef void (*player_interrupted_cb)(player_interrupted_code_e code, void *user * #PLAYER_ERROR_NOT_SUPPORTED_FILE * #PLAYER_ERROR_SEEK_FAILED * #PLAYER_ERROR_SERVICE_DISCONNECTED + * #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 * @param[in] error_code The error code * @param[in] user_data The user data passed from the callback registration function @@ -459,6 +465,8 @@ int player_destroy(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 + * @retval #PLAYER_ERROR_NOT_SUPPORTED_AUDIO_CODEC Not support audio codec format (Since 4.0) + * @retval #PLAYER_ERROR_NOT_SUPPORTED_VIDEO_CODEC Not support video codec format (Since 4.0) * @pre The player state must be set to #PLAYER_STATE_IDLE by calling player_create() or player_unprepare(). After that, call player_set_uri() to load the media content you want to play. * @post The player state will be #PLAYER_STATE_READY. * @see player_prepare_async() @@ -1467,7 +1475,9 @@ int player_get_duration(player_h player, int *duration); * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state + * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @see player_audio_effect_equalizer_is_available() * @see player_audio_effect_set_equalizer_band_level() * @see player_audio_effect_set_equalizer_all_bands() */ @@ -1485,7 +1495,9 @@ int player_audio_effect_get_equalizer_bands_count(player_h player, int *count); * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state + * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @see player_audio_effect_equalizer_is_available() * @see player_audio_effect_get_equalizer_bands_count() * @see player_audio_effect_get_equalizer_level_range() * @see player_audio_effect_get_equalizer_band_level() @@ -1504,7 +1516,9 @@ int player_audio_effect_set_equalizer_band_level(player_h player, int index, int * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state + * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @see player_audio_effect_equalizer_is_available() * @see player_audio_effect_set_equalizer_band_level() */ int player_audio_effect_get_equalizer_band_level(player_h player, int index, int *level); @@ -1521,7 +1535,9 @@ int player_audio_effect_get_equalizer_band_level(player_h player, int index, int * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state + * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @see player_audio_effect_equalizer_is_available() * @see player_audio_effect_get_equalizer_bands_count() * @see player_audio_effect_get_equalizer_level_range() * @see player_audio_effect_set_equalizer_band_level() @@ -1539,7 +1555,10 @@ int player_audio_effect_set_equalizer_all_bands(player_h player, int *band_level * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state + * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation + * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @see player_audio_effect_equalizer_is_available() * @see player_audio_effect_set_equalizer_band_level() * @see player_audio_effect_set_equalizer_all_bands() */ @@ -1556,7 +1575,9 @@ int player_audio_effect_get_equalizer_level_range(player_h player, int* min, int * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state + * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @see player_audio_effect_equalizer_is_available() */ int player_audio_effect_get_equalizer_band_frequency(player_h player, int index, int *frequency); @@ -1571,7 +1592,9 @@ int player_audio_effect_get_equalizer_band_frequency(player_h player, int index, * @retval #PLAYER_ERROR_NONE Successful * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state + * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @see player_audio_effect_equalizer_is_available() */ int player_audio_effect_get_equalizer_band_frequency_range(player_h player, int index, int *range); @@ -1583,7 +1606,9 @@ int player_audio_effect_get_equalizer_band_frequency_range(player_h player, int * @retval #PLAYER_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PLAYER_ERROR_INVALID_OPERATION Invalid operation * @retval #PLAYER_ERROR_INVALID_STATE Invalid player state + * @retval #PLAYER_ERROR_FEATURE_NOT_SUPPORTED_ON_DEVICE Unsupported feature * @pre The player state must be one of #PLAYER_STATE_IDLE, #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING, or #PLAYER_STATE_PAUSED. + * @see player_audio_effect_equalizer_is_available() * @see player_audio_effect_set_equalizer_band_level() * @see player_audio_effect_set_equalizer_all_bands() */ -- 2.7.4