Commit 72eba101 authored by Hampton Maxwell's avatar Hampton Maxwell
Browse files

Document props for playInBackground & playWhenInactive

parent 9c51d00f
Loading
Loading
Loading
Loading
+18 −18
Changes for README.md: 18 added lines, 18 removed lines.
Original line number Diff line number Diff line
@@ -257,6 +257,22 @@ Controls whether the media is paused

Platforms: all

#### playInBackground
Determine whether the media should continue playing while the app is in the background. This allows customers to continue listening to the audio.
* **false (default)** - Don't continue playing the media
* **true** - Continue playing the media

iOS support is currently broken until background service support is added [#797](https://github.com/react-native-community/react-native-video/issues/797)

Platforms: Android ExoPlayer, Android MediaPlayer

#### playWhenInactive
Determine whether the media should continue playing when notifications or the Control Center are in front of the video.
* **false (default)** - Don't continue playing the media
* **true** - Continue playing the media

Platforms: iOS

#### poster
An image to display while the video is loading
<br>Value: string with a URL for the poster, e.g. "https://baconmockup.com/300/200/"
@@ -277,27 +293,11 @@ Platforms: all
#### progressUpdateInterval
Delay in milliseconds between onProgress events in milliseconds.

Default: 250.0.
Default: 250.0

Platforms: all

#### playInBackground
Determine whether the media should continue playing while the app is in the background. This allows customers to continue listening to the audio.
* **false (default)** - Don't continue playing the media
* **true** - Continue playing the media

iOS support is currently broken until background service support is added [#797](https://github.com/react-native-community/react-native-video/issues/797)

Platforms: Android ExoPlayer, Android MediaPlayer

#### playWhenInactive
Determine whether the media should continue playing when notifications or the Control Center are in front of the video.
* **false (default)** - Don't continue playing the media
* **true** - Continue playing the media

Platforms: iOS

#### rate
### rate
Speed at which the media should play. 
* **0.0** - Pauses the video
* **1.0** - Play at normal speed