Update some description as suggested by documentation team. 78/213678/1 accepted/tizen/unified/20190911.111701 submit/tizen/20190910.061322
authorJeongmo Yang <jm80.yang@samsung.com>
Tue, 10 Sep 2019 05:58:54 +0000 (14:58 +0900)
committerJeongmo Yang <jm80.yang@samsung.com>
Tue, 10 Sep 2019 05:58:54 +0000 (14:58 +0900)
[Version] 0.5.40-1
[Profile] Common
[Issue Type] Update description

Change-Id: Ifa5623c96a8e2e225ed41af915c3e7bbb2c32e1b
Signed-off-by: Jeongmo Yang <jm80.yang@samsung.com>
include/sound_manager.h
packaging/capi-media-sound-manager.spec

index 2320488..62616f2 100644 (file)
@@ -293,9 +293,9 @@ typedef void (*sound_manager_volume_changed_cb) (sound_type_e type, unsigned int
  * @since_tizen 5.5
  *
  * @remarks    This function is invoked by the internal thread of the sound manager.
- *     Therefore it is recommended not to call functions which update the UI from this callback.
- * @remarks    @a stream_ducking is the same handle for which the callback was set in the sound_manager_create_stream_ducking() call,
- *     so it should not be released in this callback.
+ *     Therefore it is recommended not to call functions which update UI in this callback.
+ * @remarks    @a stream_ducking is the same handle as the parameter in sound_manager_create_stream_ducking() that registers this callback,
+ *     so the handle should not be released in this callback.
  *
  * @param[in]   stream_ducking The stream ducking handle
  * @param[in]   is_ducked      The flag whether it's ducked or not
@@ -520,7 +520,7 @@ int sound_manager_remove_volume_changed_cb(int id);
  * @remarks @a stream_ducking should be released using sound_manager_destroy_stream_ducking().
  *
  * @param[in]  target_stream   The type of target stream
- * @param[in]  callback                The ducking state changed callback function (optional, this can be NULL)
+ * @param[in]  callback                The callback function called when ducking state is changed (optional, this can be NULL)
  * @param[in]  user_data               The user data to be passed to the callback function (optional, this can be NULL)
  * @param[out] stream_ducking  The handle of stream ducking
  * @return @c 0 on success,
@@ -540,7 +540,7 @@ int sound_manager_create_stream_ducking(sound_stream_type_e target_stream, sound
  * @since_tizen 5.5
  *
  * @param[in]  stream_ducking  The handle of stream ducking
- * @param[out] is_ducked               Whether the stream is ducked or not: (@c true = ducked, @c false = unducked)
+ * @param[out] is_ducked               Whether the stream is ducked or not. @c true if ducked, @c false otherwise.
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SOUND_MANAGER_ERROR_NONE Success
@@ -559,8 +559,9 @@ int sound_manager_is_ducked(sound_stream_ducking_h stream_ducking, bool *is_duck
  * @privlevel public
  * @privilege %http://tizen.org/privilege/volume.set
  * @remarks If ducking is activated successfully, the volume of all sound streams
- *     matched with target_stream (set in sound_manager_create_stream_ducking())
- *     is decreased by @a ratio for @a duration. The change is system-wide.
+ *     matched with the target_stream that set in sound_manager_create_stream_ducking()
+ *     is decreased by @a ratio for @a duration.
+ *     The change applies system-wide.
  * @param[in]  stream_ducking  The handle of stream ducking
  * @param[in]  duration                The duration for ducking (msec, 0 <= duration <= 3000)
  * @param[in]  ratio                   The volume ratio when ducked (0.0 <= ratio < 1.0)
index abfb3d7..9aa08d2 100644 (file)
@@ -1,7 +1,7 @@
 Name:       capi-media-sound-manager
 Summary:    Sound Manager library
 Version:    0.5.40
-Release:    0
+Release:    1
 Group:      Multimedia/API
 License:    Apache-2.0
 Source0:    %{name}-%{version}.tar.gz