Clean up bufferConfig notes about when it needs to be applied

This commit is contained in:
Hampton Maxwell 2018-08-03 16:09:57 -07:00
parent 1d57576c27
commit 91194edbc9

View File

@ -266,8 +266,6 @@ Platforms: all
#### bufferConfig #### bufferConfig
Adjust the buffer settings. This prop takes an object with one or more of the properties listed below. Adjust the buffer settings. This prop takes an object with one or more of the properties listed below.
This prop can only be set when you are setting a new source, changing it after the media is loaded will cause it to restart.
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
minBufferMs | number | The default minimum duration of media that the player will attempt to ensure is buffered at all times, in milliseconds. minBufferMs | number | The default minimum duration of media that the player will attempt to ensure is buffered at all times, in milliseconds.
@ -275,6 +273,8 @@ maxBufferMs | number | The default maximum duration of media that the player wil
bufferForPlaybackMs | number | The default duration of media that must be buffered for playback to start or resume following a user action such as a seek, in milliseconds. bufferForPlaybackMs | number | The default duration of media that must be buffered for playback to start or resume following a user action such as a seek, in milliseconds.
playbackAfterRebufferMs | number | The default duration of media that must be buffered for playback to resume after a rebuffer, in milliseconds. A rebuffer is defined to be caused by buffer depletion rather than a user action. playbackAfterRebufferMs | number | The default duration of media that must be buffered for playback to resume after a rebuffer, in milliseconds. A rebuffer is defined to be caused by buffer depletion rather than a user action.
This prop should only be set when you are setting the source, changing it after the media is loaded will cause it to be reloaded.
Example with default values: Example with default values:
``` ```
bufferConfig={{ bufferConfig={{