Modified as per ACR comments

Change-Id: I3a8a79561b8b93a3657fe58e89786f2def275e9f
Signed-off-by: aravind.gara <aravind.gara@samsung.com>

diff --git a/doc/sound_pool_doc.h b/doc/sound_pool_doc.h
index d063e3d..13809b4 100644 (file)
--- a/doc/sound_pool_doc.h
+++ b/doc/sound_pool_doc.h
@@ -25,13 +25,8 @@
  */
 
 /**
- * @defgroup CAPI_SOUND_POOL_MODULE Sound Pool
- * @ingroup CAPI_MEDIA_FRAMEWORK
- */
-
-/**
  * @ingroup CAPI_MEDIA_FRAMEWORK
- * @addtogroup CAPI_SOUND_POOL_MODULE
+ * @defgroup CAPI_SOUND_POOL_MODULE Sound Pool
  * @brief The @ref CAPI_SOUND_POOL_MODULE API provides functions for easy sound
  *        management such as grouping sounds in pools, play, pause, resume,
  *        stop operations of sound streams and controlling stream/pool states.

diff --git a/include/sound_pool.h b/include/sound_pool.h
index 72cbcfd..d9ad35f 100644 (file)
--- a/include/sound_pool.h
+++ b/include/sound_pool.h
@@ -36,7 +36,7 @@ extern "C" {
 /**
  * @brief Called when sound pool state is changed.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool          The handle to the sound pool
  * @param [in]  prev_state    Previous pool state
  * @param [in]  cur_state     Current pool state
@@ -58,7 +58,7 @@ typedef void (*sound_pool_state_change_cb) (sound_pool_h pool,
 /**
  * @brief Called when sound pool stream state is changed.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool        The handle to the sound pool
  * @param [in]  tag         Unique string that identifies source which was used
  *                          for stream creation
@@ -94,7 +94,7 @@ typedef void (*sound_pool_stream_state_change_cb) (sound_pool_h pool,
  *          SOUND_POOL_STATE_INACTIVE. To activate a pool use
  *          @ref sound_pool_activate() function.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [out] pool    The handle to the pool that will be created
  * @return @c 0 on success, otherwise a negative error value
  * @retval #SOUND_POOL_ERROR_INVALID_PARAMETER
@@ -112,7 +112,7 @@ sound_pool_error_e sound_pool_create(sound_pool_h *pool);
  * @brief Destroys sound pool and cleans allocated memory.
  * @details Stops all streams and unloads all sources associated with pool.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool     The handle to the pool that will be destroyed
  * @return @c 0 on success, otherwise a negative error value
  * @retval #SOUND_POOL_ERROR_INVALID_PARAMETER
@@ -132,7 +132,7 @@ sound_pool_error_e sound_pool_destroy(sound_pool_h pool);
  *          Each of loaded sources must have unique @a tag
  *          It is synchronous operation.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool         The handle to the sound pool
  * @param [in]  file_name    The name of file that contains sound data
  * @param [in]  tag          Unique string that will be used to identify source
@@ -160,7 +160,7 @@ sound_pool_error_e sound_pool_load_source_from_file(sound_pool_h pool,
  * @remarks The usage of @a tag name that was associated with unloaded source
  *          has no effect. It can be reused as well.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool    The handle to the sound pool
  * @param [in]  tag     Unique string that identifies source
  * @return @c 0 on success, otherwise a negative error value
@@ -183,7 +183,7 @@ sound_pool_error_e sound_pool_unload_source(sound_pool_h pool, const char *tag);
  *          priority in the pool will resume their playback. Paused streams will
  *          remain their state.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool     The handle to the sound pool
  * @return @c 0 on success, otherwise a negative error value
  * @retval #SOUND_POOL_ERROR_INVALID_PARAMETER Invalid parameter
@@ -206,7 +206,7 @@ sound_pool_error_e sound_pool_activate(sound_pool_h pool);
  *          be suspended (change state to SOUND_POOL_STREAM_STATE_SUSPENDED).
  *          Paused streams will remain their state.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool     The handle to the sound pool
  * @return @c 0 on success, otherwise a negative error value
  * @retval #SOUND_POOL_ERROR_INVALID_PARAMETER Invalid parameter
@@ -231,7 +231,7 @@ sound_pool_error_e sound_pool_deactivate(sound_pool_h pool);
  *          (i.e. [stream real volume] = [global volume] * [stream volume],
  *          where [stream volume] is the volume parameter of arbitrary stream).
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool      The handle to the sound pool
  * @param [in]  volume    Pool global volume in 0.0~1.0 range
  * @return @c 0 on success, otherwise a negative error value
@@ -248,7 +248,7 @@ sound_pool_error_e sound_pool_set_volume(sound_pool_h pool, float volume);
 /**
  * @brief Gets pool global volume parameter.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]   pool      The handle to the sound pool
  * @param [out]  volume    Pool global volume in 0.0~1.0 range
  * @return @c 0 on success, otherwise a negative error value
@@ -264,7 +264,7 @@ sound_pool_error_e sound_pool_get_volume(sound_pool_h pool, float *volume);
 /**
  * @brief Gets current @a state of @a pool.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool     The handle to the sound pool
  * @param [out] state    Current state of @a pool
  * @return @c 0 on success, otherwise a negative error value
@@ -282,7 +282,7 @@ sound_pool_error_e sound_pool_get_state(sound_pool_h pool,
 /**
  * @brief Sets callback for handling sound @a pool state change.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool        The handle to the sound pool
  * @param [in]  callback    The callback that will be called after pool state
  *                          will be changed.  @a callback will be called
@@ -305,7 +305,7 @@ sound_pool_error_e sound_pool_set_state_change_callback(sound_pool_h pool,
 /**
  * @brief Unsets callback for handling sound @a pool state change.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool     The handle to the pool
  * @return @c 0 on success, otherwise a negative error value
  * @retval #SOUND_POOL_ERROR_INVALID_PARAMETER Invalid parameter
@@ -327,7 +327,7 @@ sound_pool_error_e sound_pool_unset_state_change_callback(sound_pool_h pool);
  *          Sets stream state to SOUND_POOL_STREAM_STATE_PLAYING
  * @remarks Resultant stream volume will depend on global pool volume.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool        The handle to the sound pool
  * @param [in]  tag         Unique string that identifies source
  * @param [in]  loop        Number of times stream will be repeated
@@ -375,7 +375,7 @@ sound_pool_error_e sound_pool_stream_play(sound_pool_h pool, const char *tag,
  * @details Sets stream state to SOUND_POOL_STREAM_STATE_PAUSED.
  * @remarks Stream state has to be SOUND_POOL_STATE_PLAYING
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool    The handle to the sound pool
  * @param [in]  id      Unique stream identifier
  * @return @c 0 on success, otherwise a negative error value
@@ -401,7 +401,7 @@ sound_pool_error_e sound_pool_stream_pause(sound_pool_h pool, unsigned id);
  * @details Sets stream state to SOUND_POOL_STREAM_STATE_PLAYING.
  * @remarks Stream state has to be SOUND_POOL_STATE_PAUSED
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool    The handle to the sound pool
  * @param [in]  id      Unique stream identifier
  * @return @c 0 on success, otherwise a negative error value
@@ -432,7 +432,7 @@ sound_pool_error_e sound_pool_stream_resume(sound_pool_h pool, unsigned id);
  *          @c SOUND_POOL_STREAM_STATE_FINISHED state as it will be terminated
  *          after this function call.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool    The handle to the sound pool
  * @param [in]  id      Unique stream identifier
  * @return @c 0 on success, otherwise a negative error value
@@ -456,7 +456,7 @@ sound_pool_error_e sound_pool_stream_stop(sound_pool_h pool, unsigned id);
 /**
  * @brief Sets stream @a loop parameter by stream @a id.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool    The handle to the sound pool
  * @param [in]  id      Unique stream identifier
  * @param [in]  loop    Number of times stream will be repeated
@@ -482,7 +482,7 @@ sound_pool_error_e sound_pool_stream_set_loop(sound_pool_h pool, unsigned id,
 /**
  * @brief Gets stream @a loop parameter by stream @a id.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool    The handle to the sound pool
  * @param [in]  id      Unique stream identifier
  * @param [out] loop    Number of times stream will be repeated before
@@ -509,7 +509,7 @@ sound_pool_error_e sound_pool_stream_get_loop(sound_pool_h pool, unsigned id,
  * @brief Sets stream volume parameters by stream @a id.
  * @remarks Resultant stream volume will depend on global pool volume.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool      The handle to the sound pool
  * @param [in]  id        Unique stream identifier
  * @param [in]  volume    Stream volume in 0.0~1.0 range
@@ -536,7 +536,7 @@ sound_pool_error_e sound_pool_stream_set_volume(sound_pool_h pool, unsigned id,
 /**
  * @brief Gets stream volume parameters by stream @a id.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool      The handle to the sound pool
  * @param [in]  id        Unique stream identifier
  * @param [out] volume    Stream volume in 0.0~1.0 range
@@ -580,7 +580,7 @@ sound_pool_error_e sound_pool_stream_get_volume(sound_pool_h pool, unsigned id,
  *          Priorities don't make any effect in inactive Sound Pools. But after
  *          pool activation, all mentioned rules will be applied.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool        The handle to the sound pool
  * @param [in]  id          Unique stream identifier
  * @param [in]  priority    Stream priority (0 = lowest priority)
@@ -605,7 +605,7 @@ sound_pool_error_e sound_pool_stream_set_priority(sound_pool_h pool, unsigned id
 /**
  * @brief Gets stream priority parameter by stream @a id.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]   pool        The handle to the sound pool
  * @param [in]   id          Unique stream identifier
  * @param [out]  priority    Stream priority (0 = lowest priority). Check
@@ -631,7 +631,7 @@ sound_pool_error_e sound_pool_stream_get_priority(sound_pool_h pool, unsigned id
 /**
  * @brief Gets current @a state of stream by @a id.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool     The handle to the sound pool
  * @param [in]  id       Unique stream identifier
  * @param [out] state    Current state of stream
@@ -656,7 +656,7 @@ sound_pool_error_e sound_pool_stream_get_state(sound_pool_h pool, unsigned id,
 /**
  * @brief Sets callback for handling stream state change events.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool        The handle to the sound pool
  * @param [in]  id          Unique stream identifier
  * @param [in]  callback    The callback that will be called after stream state
@@ -687,7 +687,7 @@ sound_pool_error_e sound_pool_stream_set_state_change_callback(sound_pool_h pool
 /**
  * @brief Unsets callback for handling stream state change events.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  * @param [in]  pool    The handle to the sound pool
  * @param [in]  id      Unique stream identifier
  * @return @c 0 on success, otherwise a negative error value

diff --git a/include/sound_pool_type.h b/include/sound_pool_type.h
index 540e8b3..1e624f9 100644 (file)
--- a/include/sound_pool_type.h
+++ b/include/sound_pool_type.h
@@ -37,7 +37,7 @@ extern "C" {
 /**
  * @brief Enumeration for Tizen Sound Pool error.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  */
 typedef enum {
        SOUND_POOL_ERROR_NONE
@@ -66,14 +66,14 @@ typedef enum {
 /**
  * @brief Sound pool handle type.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  */
 typedef void *sound_pool_h;
 
 /**
  * @brief Enumeration of sound pool stream state.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  */
 typedef enum {
        SOUND_POOL_STREAM_STATE_NONE,       /**< Stream state isn't determined */
@@ -87,7 +87,7 @@ typedef enum {
 /**
  * @brief Enumeration of sound pool state.
  *
- * @since_tizen 3.0
+ * @since_tizen 4.0
  */
 typedef enum {
        SOUND_POOL_STATE_ACTIVE,    /**< Sound pool active state: streams can be played */