[0.3.82] resolve API grouping error and update doxygen

Change-Id: Ic04c12ffabd954f47ae2248971b2ff55c2a59fb7

diff --git a/doc/player_doc.h b/doc/player_doc.h
index 23425c8f25328e114cbf5ce981217ab8a2fd3057..f87c0b76fd3789d845523659e818cd2177c9631a 100644 (file)
--- a/doc/player_doc.h
+++ b/doc/player_doc.h
@@ -121,8 +121,8 @@
  * </tr>
  * <tr>
  *    <td>player_destroy()</td>
- *    <td>ANY</td>
- *    <td>-</td>
+ *    <td>IDLE/ READY/ PLAYING/ PAUSED</td>
+ *    <td>This function must be called after player_create()</td>
  * </tr>
  * <tr>
  *    <td>player_prepare()</td>
@@ -131,8 +131,8 @@
  * </tr>
  * <tr>
  *    <td>player_unprepare()</td>
- *    <td>READY/PAUSED/PLAYING</td>
- *    <td>This function must be called after player_stop() or player_start() or player_pause()</td>
+ *    <td>READY/ PLAYING/ PAUSED</td>
+ *    <td>This function must be called after player_prepare()</td>
  * </tr>
  * <tr>
  *    <td>player_start()</td>
@@ -155,11 +155,21 @@
  *    <td>This function must be called after player_create()</td>
  * </tr>
  * <tr>
- *    <td>player_unset_completed_cb()<BR> player_unset_interrupted_cb()<BR> player_unset_error_cb()<BR> player_unset_buffering_cb()<BR> player_unset_subtitle_updated_cb()</td>
+ *    <td>player_set_video_stream_changed_cb()<BR>player_set_media_stream_seek_cb()<BR>player_set_media_stream_buffer_status_cb()<BR>player_set_media_packet_video_frame_decoded_cb()</td>
+ *    <td>IDLE</td>
+ *    <td>This function must be called before player_prepare()</td>
+ * </tr>
+ * <tr>
+ *    <td>player_unset_completed_cb()<BR> player_unset_interrupted_cb()<BR> player_unset_error_cb()<BR> player_unset_buffering_cb()<BR> player_unset_subtitle_updated_cb()<BR>player_unset_video_stream_changed_cb()<BR>player_unset_media_stream_seek_cb()<BR>player_unset_media_stream_buffer_status_cb()</td>
  *    <td>IDLE/ READY/ PLAYING/ PAUSED</td>
  *    <td>This function must be called after register callback functions such as player_set_completed_cb()</td>
  * </tr>
  * <tr>
+ *    <td>player_unset_media_packet_video_frame_decoded_cb()</td>
+ *    <td>IDLE/ READY</td>
+ *    <td>This function must be called after player_set_media_packet_video_frame_decoded_cb()</td>
+ * </tr>
+ * <tr>
  *    <td>player_get_state()</td>
  *    <td>ANY</td>
  *    <td>-</td>
@@ -176,8 +186,8 @@
  * </tr>
  * <tr>
  *    <td>player_set_subtitle_path()</td>
- *    <td>IDLE</td>
- *    <td>This function must be called before player_prepare() </td>
+ *    <td>IDLE/ READY/ PLAYING/ PAUSED</td>
+ *    <td>This function must be called before player_create() </td>
  * </tr>
  * <tr>
  *    <td>player_set_volume()</td>
@@ -192,12 +202,12 @@
  * <tr>
  *    <td>player_set_sound_stream_info()</td>
  *    <td>IDLE</td>
- *    <td>This function must be called after player_create()</td>
+ *    <td>This function must be called before player_prepare()</td>
  * </tr>
  * <tr>
  *    <td>player_set_sound_type()</td>
  *    <td>IDLE</td>
- *    <td>This function must be called after player_create()</td>
+ *    <td>This function must be called before player_prepare()</td>
  * </tr>
  * <tr>
  *    <td>player_set_mute()</td>
@@ -244,6 +254,26 @@
  *    <td>READY/ PLAYING/ PAUSED</td>
  *    <td>This function must be called after player_prepare()</td>
  * </tr>
+ * <tr>
+ *    <td>player_set_subtitle_position_offset()</td>
+ *    <td>PLAYING/ PAUSED</td>
+ *    <td>This function must be called after player_start()</td>
+ * </tr>
+ * <tr>
+ *    <td>player_get_current_track()<BR>player_get_track_language_code()<BR>player_get_track_count()<BR>player_select_track()</td>
+ *    <td>READY/ PLAYING/ PAUSED</td>
+ *    <td>This function must be called after player_prepare()</td>
+ * </tr>
+ * <tr>
+ *    <td>player_set_audio_only()</td>
+ *    <td>READY/ PLAYING/ PAUSED</td>
+ *    <td>This function must be called after player_prepare()</td>
+ * </tr>
+ * <tr>
+ *    <td>player_set_streaming_buffering_time()</td>
+ *    <td>IDLE</td>
+ *    <td>This function must be called before player_prepare()</td>
+ * </tr>
  * </table></div>
  *
  * @subsection CAPI_MEDIA_PLAYER_LIFE_CYCLE_ASYNCHRONOUS_OPERATIONS Asynchronous Operations
@@ -300,6 +330,24 @@
  *        <td>player_media_packet_video_decoded_cb()</td>
  *        <td>called when a video frame is decoded </td>
  *     </tr>
+ *     <tr>
+ *        <td>player_set_media_stream_seek_cb()</td>
+ *        <td>player_unset_media_stream_seek_cb()</td>
+ *        <td>player_media_stream_seek_cb()</td>
+ *        <td>called when seeking is occurred during playback with external media buffer</td>
+ *     </tr>
+ *     <tr>
+ *        <td>player_set_media_stream_buffer_status_cb()</td>
+ *        <td>player_unset_media_stream_buffer_status_cb()</td>
+ *        <td>player_media_stream_buffer_status_cb()</td>
+ *        <td>called when the buffer underrun or overflow is detected during playback with external media buffer</td>
+ *     </tr>
+ *     <tr>
+ *        <td>player_set_video_stream_changed_cb()</td>
+ *        <td>player_unset_video_stream_changed_cb()</td>
+ *        <td>player_video_stream_changed_cb()</td>
+ *        <td>called when the video stream info is changed </td>
+ *     </tr>
 
  *</table></div>
  *
@@ -356,7 +404,7 @@
  *
  * @section CAPI_MEDIA_PLAYER_AUDIO_EFFECT_MODULE_MODULE_OVERVIEW Overview
  * The Audio effect API allows you to apply effects to the player:
- * - Equalizer
+ * - Equalizer \n
  *
  *
 */

diff --git a/include/player.h b/include/player.h
index e670a76e845d2ad8a606b75365983c98b23b6223..ccc299e835da5773cc524f1c78692b0dae7349d5 100644 (file)
--- a/include/player.h
+++ b/include/player.h
@@ -166,6 +166,15 @@ typedef enum {
        PLAYER_MEDIA_STREAM_BUFFER_OVERFLOW,
 } player_media_stream_buffer_status_e;
 
+/**
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_MEDIA_PLAYER_DISPLAY_MODULE
+ * @{
+ */
+
 /**
  * @brief The player display handle.
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@@ -180,15 +189,6 @@ typedef void* player_display_h;
 #define GET_DISPLAY(x) (void*)(x)
 #endif
 
-/**
- * @}
- */
-
-/**
- * @addtogroup CAPI_MEDIA_PLAYER_DISPLAY_MODULE
- * @{
- */
-
 /**
  * @brief Enumeration for display rotation type.
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
@@ -401,6 +401,15 @@ typedef void (*player_media_stream_buffer_status_cb) (player_media_stream_buffer
  */
 typedef void (*player_media_stream_seek_cb) (unsigned long long offset, void *user_data);
 
+/**
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_MEDIA_PLAYER_STREAM_INFO_MODULE
+ * @{
+ */
+
 /**
  * @brief Called to notify the video stream changed.
  * @details The video stream changing is detected just before rendering operation.
@@ -416,6 +425,15 @@ typedef void (*player_media_stream_seek_cb) (unsigned long long offset, void *us
  */
 typedef void (*player_video_stream_changed_cb) (int width, int height, int fps, int bit_rate, void *user_data);
 
+/**
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_MEDIA_PLAYER_MODULE
+ * @{
+ */
+
 /**
  * @brief Called to notify the streaming variant information.
  * @details The adaptive streaming protocol(hls, mpeg dash) can support variant stream condition.
@@ -2026,6 +2044,16 @@ int player_unset_subtitle_updated_cb(player_h player);
  */
 int player_set_subtitle_position_offset(player_h player, int millisecond);
 
+/**
+ * @}
+ */
+
+
+/**
+ * @addtogroup CAPI_MEDIA_PLAYER_STREAM_INFO_MODULE
+ * @{
+ */
+
 /**
  * @brief Registers a callback function to be invoked when video stream is changed.
  * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
@@ -2061,6 +2089,16 @@ int player_set_video_stream_changed_cb(player_h player, player_video_stream_chan
  */
 int player_unset_video_stream_changed_cb(player_h player);
 
+/**
+ * @}
+ */
+
+
+/**
+ * @addtogroup CAPI_MEDIA_PLAYER_MODULE
+ * @{
+ */
+
 /**
  * @brief Gets current track index.
  * @details Index starts from 0.

diff --git a/include/player_internal.h b/include/player_internal.h
index 70ed9ed28cbaa60b2b66d18e72a04786e1b4a76d..a57b904e4522958dcf4f3399292440d10f14117e 100644 (file)
--- a/include/player_internal.h
+++ b/include/player_internal.h
@@ -27,8 +27,8 @@ extern "C" {
  */
 
 /**
- * @addtogroup CAPI_MEDIA_PLAYER_MODULE
- * @{
+ * @brief Enumeration for wayland window type.
+ * @since_tizen 3.0
  */
 typedef enum {
        ELM_WAYLAND_WIN = 1,
@@ -783,10 +783,6 @@ int player_set_codec_type(player_h player, player_stream_type_e stream_type, pla
 int player_get_codec_type(player_h player, player_stream_type_e stream_type, player_codec_type_e *pcodec_type);
 
 
-/**
- * @}
- */
-
 #ifdef __cplusplus
 }
 #endif

diff --git a/packaging/capi-media-player.spec b/packaging/capi-media-player.spec
index ba2cd2b6d7d3d365c2005970cebf00220be8cf63..4d6f181f56d469c2fc559d55c7a98012c89bc99a 100644 (file)
--- 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.81
+Version:    0.3.82
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0