railbird/react-native-video
9
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix formatting for Configurable props

Browse Source 
Make sure Platforms get treated like they're on a newline
This commit is contained in:
Hampton Maxwell 2018-06-05 18:26:25 -07:00 committed by GitHub
parent 4cb9b2214a
commit 5203d1b238
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -237,66 +237,82 @@ Controls the iOS silent switch behavior
* **"inherit" (default)** - Use the default AVPlayer behavior * **"inherit" (default)** - Use the default AVPlayer behavior
* **"ignore"** - Play audio even if the silent switch is set * **"ignore"** - Play audio even if the silent switch is set
* **"obey"** - Don't play audio if the silent switch is set * **"obey"** - Don't play audio if the silent switch is set
<br>Platforms: iOS
Platforms: iOS
#### muted #### muted
Controls whether the audio is muted Controls whether the audio is muted
* **false (default)** - Don't mute audio * **false (default)** - Don't mute audio
* **true** - Mute audio * **true** - Mute audio
<br>Platforms: all
Platforms: all
#### paused #### paused
Controls whether the media is paused Controls whether the media is paused
* **false (default)** - Pause the media * **false (default)** - Pause the media
* **true** - Don't pause the media * **true** - Don't pause the media
<br>Platforms: all
Platforms: all
#### poster #### poster
An image to display while the video is loading 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/" <br>Value: string with a URL for the poster, e.g. "https://baconmockup.com/300/200/"
<br>Platforms: all
Platforms: all
#### posterResizeMode #### posterResizeMode
Determines how to resize the poster image when the frame doesn't match the raw video dimensions. Determines how to resize the poster image when the frame doesn't match the raw video dimensions.
* **"contain" (default)** - Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or less than the corresponding dimension of the view (minus padding). * **"contain" (default)** - Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or less than the corresponding dimension of the view (minus padding).
* **"center"** - Center the image in the view along both dimensions. If the image is larger than the view, scale it down uniformly so that it is contained in the view.
* **"cover"** - Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the view (minus padding). * **"cover"** - Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the view (minus padding).
* **"none"** - Don't apply resize * **"none"** - Don't apply resize
* **"repeat"** - Repeat the image to cover the frame of the view. The image will keep its size and aspect ratio. (iOS only)
* **"stretch"** - Scale width and height independently, This may change the aspect ratio of the src. * **"stretch"** - Scale width and height independently, This may change the aspect ratio of the src.
<br>Platforms: all
Platforms: all
#### progressUpdateInterval #### progressUpdateInterval
Delay in milliseconds between onProgress events in milliseconds. Delay in milliseconds between onProgress events in milliseconds.
<br>Default: 250.0.
<br>Platforms: all Default: 250.0.
Platforms: all
#### rate #### rate
Speed at which the media should play. Speed at which the media should play.
* **0.0** - Pauses the video * **0.0** - Pauses the video
* **1.0** - Play at normal speed * **1.0** - Play at normal speed
* **Other values** - Slow down or speed up playback * **Other values** - Slow down or speed up playback
<br>Note: For Android MediaPlayer, rate is only supported on Android 6.0 and higher devices.
Platforms: all
Note: For Android MediaPlayer, rate is only supported on Android 6.0 and higher devices.
#### repeat #### repeat
Determine whether to repeat the video when the end is reached Determine whether to repeat the video when the end is reached
* **false (default)** - Don't repeat the video * **false (default)** - Don't repeat the video
* **true** - Repeat the video * **true** - Repeat the video
Platforms: all
#### resizeMode #### resizeMode
Determines how to resize the video when the frame doesn't match the raw video dimensions. Determines how to resize the video when the frame doesn't match the raw video dimensions.
**center** - Center the image in the view along both dimensions. If the image is larger than the view, scale it down uniformly so that it is contained in the view. * **"none" (default)** - Don't apply resize
* **"contain"** - Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or less than the corresponding dimension of the view (minus padding). * **"contain"** - Scale the video uniformly (maintain the video's aspect ratio) so that both dimensions (width and height) of the video will be equal to or less than the corresponding dimension of the view (minus padding).
* **"cover"** - Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the view (minus padding). * **"cover"** - Scale the video uniformly (maintain the video's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the view (minus padding).
* **"none"** - Don't apply resize
* **"repeat"** - Repeat the image to cover the frame of the view. The image will keep its size and aspect ratio. (iOS only)
* **"stretch"** - Scale width and height independently, This may change the aspect ratio of the src. * **"stretch"** - Scale width and height independently, This may change the aspect ratio of the src.
<br>Platforms: Android ExoPlayer, Android MediaPlayer, iOS, Windows UWP
Platforms: Android ExoPlayer, Android MediaPlayer, iOS, Windows UWP
#### volume #### volume
Adjust the volume. Adjust the volume.
* **1.0 (default)** - Play at full volume * **1.0 (default)** - Play at full volume
* **0.0** - Mute the audio * **0.0** - Mute the audio
* **Other values** - Reduce volume * **Other values** - Reduce volume
<br>Platforms: all
Platforms: all
### Additional props
To see the full list of available props, you can check the [propTypes](https://github.com/react-native-community/react-native-video/blob/master/Video.js#L246) of the Video.js component. To see the full list of available props, you can check the [propTypes](https://github.com/react-native-community/react-native-video/blob/master/Video.js#L246) of the Video.js component.