[ACR-1347][3] modify API reference about buffering time function 68/202568/3
authorEunhye Choi <eunhae1.choi@samsung.com>
Mon, 1 Apr 2019 04:39:36 +0000 (13:39 +0900)
committerEunhye Choi <eunhae1.choi@samsung.com>
Wed, 3 Apr 2019 09:50:14 +0000 (18:50 +0900)
Change-Id: I7af2bf27a89308292dba0b5ba613d342d67b91d7

include/player.h

index e6884bf..f0d6e6d 100644 (file)
@@ -2467,11 +2467,16 @@ int player_set_streaming_buffering_time(player_h player, int prebuffer_ms, int r
  * @since_tizen 4.0
  * @param[in]  player        The handle to the media player
  * @param[out] prebuffer_ms  The time duration of buffering data that must be prerolled to start playback
+ *                           If the user did not set any value by calling player_set_streaming_buffering_time() function (or if the value was set to 0),
+ *                           the value is @c 0 which means platform default value depending on the streaming type and network status. \n
+ *                           The value is set to time duration instead of @c 0
+ *                           if the player state is one of: #PLAYER_STATE_READY, #PLAYER_STATE_PLAYING or #PLAYER_STATE_PAUSED. (since 5.5)
  * @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
- *                           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)
+ *                           If the user did not set any value by calling player_set_streaming_buffering_time() function (or if the value was set to 0),
+ *                           the value is @c 0 which means platform default value depending on the streaming type and network status. \n
+ *                           The value is set to time duration instead of @c 0
+ *                           if the player state is one of: #PLAYER_STATE_READY, #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