From: Eunhye Choi <eunhae1.choi@samsung.com>
Date: Thu, 28 Mar 2019 11:32:41 +0000 (+0900)
Subject: [ACR-1347][2] modify API reference about buffering time function
X-Git-Tag: accepted/tizen/unified/20190412.124534~2
X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fapi%2Fplayer.git;a=commitdiff_plain;h=7bf7bf0c8fb6f8ce1100f8b4232321fd3b26222a

[ACR-1347][2] modify API reference about buffering time function

- apply the additional feedback of ACR-1347 during doc review
- original commit : I03beabed7d10ee0de810f1555dd0159180c69bee

Change-Id: I2a60e2276c7d0f323c434c5eecd835c3a086f255
---

diff --git a/include/player.h b/include/player.h
index b5c1e54..e6884bf 100644
--- a/include/player.h
+++ b/include/player.h
@@ -2424,14 +2424,16 @@ int player_pitch_get_value(player_h player, float *value);
  * @since_tizen 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
- *                          At least 1000 milliseconds is recommended to ensure the normal buffering operation except 0 or -1. \n
- *                           0 : use platform default value which could be different depending on the streaming type and network status (default) \n
- *                          -1 : use current value (since 5.5) \n
+ *                          The value should be more than 1000 milliseconds to ensure the normal buffering. \n
+ *                          There are, however, two exceptions: \n
+ *                           0: Indicate to use platform default value depending on the streaming type and network status (default) \n
+ *                          -1: Indicate to use current value (since 5.5)
  * @param[in] rebuffer_ms   The time duration of buffering data that must be prerolled to resume playback
  *                          if player is paused for buffering internally. \n
- *                          At least 1000 milliseconds is recommended to ensure the normal buffering operation except 0 or -1. \n
- *                           0 : use platform default value which could be different depending on the streaming type and network status (default) \n
- *                          -1 : use current value (since 5.5)\n
+ *                          The value should be more than 1000 milliseconds to ensure the normal buffering. \n
+ *                          There are, however, two exceptions: \n
+ *                           0: Indicate to use platform default value depending on the streaming type and network status (default) \n
+ *                          -1: Indicate to use current value (since 5.5)
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #PLAYER_ERROR_NONE Successful
@@ -2467,9 +2469,9 @@ int player_set_streaming_buffering_time(player_h player, int prebuffer_ms, int r
  * @param[out] prebuffer_ms  The time duration of buffering data that must be prerolled to start playback
  * @param[out] rebuffer_ms   The time duration of buffering data that must be prerolled to resume playback
  *                           if player is paused for buffering internally. \n
- *                           @c 0 means platform default value which could be different depending on the streaming type and network status.
- *                           If the player state is #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED,
- *                           this function will return correct time value instead of @c 0. (since 5.5)
+ *                           The value has @c 0 which means platform default value depending on the streaming type and network status.
+ *                           The value has the time value instead of @c 0
+ *                           if the player state is #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. (since 5.5)
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #PLAYER_ERROR_NONE Successful