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

[DOCUMENTATION] Update documentation

Browse Source
This commit is contained in:
Axel Vencatareddy 2022-11-16 12:58:31 +01:00
parent ab5ff01129
commit c887ea1b78
1 changed files with 116 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

204
API.md
View File

@ -263,78 +263,80 @@ var styles = StyleSheet.create({
``` ```
### Configurable props ### Configurable props
| Name |Plateforms Support | | Name | Platforms Support |
|--|--| |-------------------------------------------------------------------------------------|---------------------------|
|[allowsExternalPlayback](#allowsexternalplayback) |iOS | | [adTagUrl](#adTagUrl) | Android, iOS |
|[audioOnly](#audioonly)|All | | [allowsExternalPlayback](#allowsexternalplayback) | iOS |
|[automaticallyWaitsToMinimizeStalling](#automaticallyWaitsToMinimizeStalling) | iOS|\ | [audioOnly](#audioonly) | All |
|[backBufferDurationMs](#backBufferDurationMs)| Android | | [automaticallyWaitsToMinimizeStalling](#automaticallyWaitsToMinimizeStalling) | iOS |
|[bufferConfig](#bufferconfig)|Android| | [backBufferDurationMs](#backBufferDurationMs) | Android |
|[contentStartTime](#contentStartTime)| Android | | [bufferConfig](#bufferconfig) | Android |
|[controls](#controls)|Android, iOS| | [contentStartTime](#contentStartTime) | Android |
|[currentPlaybackTime](#currentPlaybackTime)|Android| | [controls](#controls) | Android, iOS |
|[disableFocus](#disableFocus)|Android, iOS| | [currentPlaybackTime](#currentPlaybackTime) | Android |
|[disableDisconnectError](#disableDisconnectError)|Android| | [disableFocus](#disableFocus) | Android, iOS |
|[filter](#filter)|iOS| | [disableDisconnectError](#disableDisconnectError) | Android |
|[filterEnabled](#filterEnabled)|iOS| | [filter](#filter) | iOS |
|[focusable](#focusable)|Android| | [filterEnabled](#filterEnabled) | iOS |
|[fullscreen](#fullscreen)|iOS| | [focusable](#focusable) | Android |
|[fullscreenAutorotate](#fullscreenautorotate)|iOS| | [fullscreen](#fullscreen) | iOS |
|[fullscreenOrientation](#fullscreenorientation)|iOS| | [fullscreenAutorotate](#fullscreenautorotate) | iOS |
|[headers](#headers)|Android| | [fullscreenOrientation](#fullscreenorientation) | iOS |
|[hideShutterView](#hideshutterview)|Android| | [headers](#headers) | Android |
|[ignoreSilentSwitch](#ignoresilentswitch)|iOS| | [hideShutterView](#hideshutterview) | Android |
|[maxBitRate](#maxbitrate)|Android, iOS| | [ignoreSilentSwitch](#ignoresilentswitch) | iOS |
|[minLoadRetryCount](#minLoadRetryCount)|Android| | [maxBitRate](#maxbitrate) | Android, iOS |
|[mixWithOthers](#mixWithOthers)|iOS| | [minLoadRetryCount](#minLoadRetryCount) | Android |
|[muted](#muted)|All| | [mixWithOthers](#mixWithOthers) | iOS |
|[paused](#paused)|All| | [muted](#muted) | All |
|[pictureInPicture](#pictureinpicture)|iOS| | [paused](#paused) | All |
|[playInBackground](#playinbackground)|Android, iOS| | [pictureInPicture](#pictureinpicture) | iOS |
|[playWhenInactive](#playwheninactive)|iOS| | [playInBackground](#playinbackground) | Android, iOS |
|[poster](#poster)|All| | [playWhenInactive](#playwheninactive) | iOS |
|[posterResizeMode](#posterresizemode)|All| | [poster](#poster) | All |
|[preferredForwardBufferDuration](#preferredForwardBufferDuration)|iOS| | [posterResizeMode](#posterresizemode) | All |
|[preventsDisplaySleepDuringVideoPlayback](#preventsDisplaySleepDuringVideoPlayback)|iOS, Android| | [preferredForwardBufferDuration](#preferredForwardBufferDuration) | iOS |
|[progressUpdateInterval](#progressupdateinterval)|All| | [preventsDisplaySleepDuringVideoPlayback](#preventsDisplaySleepDuringVideoPlayback) | iOS, Android |
|[rate](#rate)|All| | [progressUpdateInterval](#progressupdateinterval) | All |
|[repeat](#repeat)|All| | [rate](#rate) | All |
|[reportBandwidth](#reportbandwidth)|Android| | [repeat](#repeat) | All |
|[resizeMode](#resizemode)|Android, iOS, Windows UWP| | [reportBandwidth](#reportbandwidth) | Android |
|[selectedAudioTrack](#selectedaudiotrack)|Android, iOS| | [resizeMode](#resizemode) | Android, iOS, Windows UWP |
|[selectedTextTrack](#selectedtexttrack)|Android, iOS| | [selectedAudioTrack](#selectedaudiotrack) | Android, iOS |
|[selectedVideoTrack](#selectedvideotrack)|Android| | [selectedTextTrack](#selectedtexttrack) | Android, iOS |
|[source](#source)|All| | [selectedVideoTrack](#selectedvideotrack) | Android |
|[subtitleStyle](#subtitleStyle)|Android| | [source](#source) | All |
|[textTracks](#texttracks)|Android, iOS| | [subtitleStyle](#subtitleStyle) | Android |
|[trackId](#trackId)|Android| | [textTracks](#texttracks) | Android, iOS |
|[useTextureView](#usetextureview)|Android| | [trackId](#trackId) | Android |
|[useSecureView](#useSecureView)|Android| | [useTextureView](#usetextureview) | Android |
|[volume](#volume)|All| | [useSecureView](#useSecureView) | Android |
|[localSourceEncryptionKeyScheme](#localSourceEncryptionKeyScheme)|All| | [volume](#volume) | All |
| [localSourceEncryptionKeyScheme](#localSourceEncryptionKeyScheme) | All |
### Event props ### Event props
| Name |Plateforms Support | | Name | Platforms Support |
|--|--| |-------------------------------------------------------------------------------------------------|---------------------------|
|[onAudioBecomingNoisy](#onaudiobecomingnoisy)|Android, iOS| | [onAudioBecomingNoisy](#onaudiobecomingnoisy) | Android, iOS |
|[onBandwidthUpdate](#onbandwidthupdate)|Android| | [onBandwidthUpdate](#onbandwidthupdate) | Android |
|[onBuffer](#onbuffer)|Android, iOS| | [onBuffer](#onbuffer) | Android, iOS |
|[onEnd](#onend)|All| | [onEnd](#onend) | All |
|[onExternalPlaybackChange](#onexternalplaybackchange)|iOS| | [onExternalPlaybackChange](#onexternalplaybackchange) | iOS |
|[onFullscreenPlayerWillPresent](#onfullscreenplayerwillpresent)|Android, iOS| | [onFullscreenPlayerWillPresent](#onfullscreenplayerwillpresent) | Android, iOS |
|[onFullscreenPlayerDidPresent](#onfullscreenplayerdidpresent)|Android, iOS| | [onFullscreenPlayerDidPresent](#onfullscreenplayerdidpresent) | Android, iOS |
|[onFullscreenPlayerWillDismiss](#onfullscreenplayerwilldismiss)|Android, iOS| | [onFullscreenPlayerWillDismiss](#onfullscreenplayerwilldismiss) | Android, iOS |
|[onFullscreenPlayerDidDismiss](#onfullscreenplayerdiddismiss)|Android, iOS| | [onFullscreenPlayerDidDismiss](#onfullscreenplayerdiddismiss) | Android, iOS |
|[onLoad](#onload)|All| | [onLoad](#onload) | All |
|[onLoadStart](#onloadstart)|All| | [onLoadStart](#onloadstart) | All |
|[onReadyForDisplay](#onreadyfordisplay)|Android, iOS, Web| | [onPictureInPictureStatusChanged](#onpictureinpicturestatuschanged) | iOS |
|[onPictureInPictureStatusChanged](#onpictureinpicturestatuschanged)|iOS| | [onPlaybackRateChange](#onplaybackratechange) | All |
|[onPlaybackRateChange](#onplaybackratechange)|All| | [onProgress](#onprogress) | All |
|[onProgress](#onprogress)|All| | [onReadyForDisplay](#onreadyfordisplay) | Android, iOS, Web |
|[onSeek](#onseek)|Android, iOS, Windows UWP| | [onReceiveAdEvent](#onReceiveAdEvent) | Android, iOS |
|[onRestoreUserInterfaceForPictureInPictureStop](#onrestoreuserinterfaceforpictureinpicturestop)|iOS| | [onRestoreUserInterfaceForPictureInPictureStop](#onrestoreuserinterfaceforpictureinpicturestop) | iOS |
|[onTimedMetadata](#ontimedmetadata)|Android, iOS| | [onSeek](#onseek) | Android, iOS, Windows UWP |
| [onTimedMetadata](#ontimedmetadata) | Android, iOS |
### Methods ### Methods
@ -356,6 +358,16 @@ var styles = StyleSheet.create({
### Configurable props ### Configurable props
#### adTagUrl
Sets the VAST uri to play AVOD ads.
Example:
```
adTagUrl="https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/vmap_ad_samples&sz=640x480&cust_params=sample_ar%3Dpremidpostoptimizedpodbumper&ciu_szs=300x250&gdfp_req=1&ad_rule=1&output=vmap&unviewed_position_start=1&env=vp&impl=s&cmsid=496&vid=short_onecue&correlator="
```
Platforms: Android, iOS
#### allowsExternalPlayback #### allowsExternalPlayback
Indicates whether the player allows switching to external playback mode such as AirPlay or HDMI. Indicates whether the player allows switching to external playback mode such as AirPlay or HDMI.
* **true (default)** - allow switching to external playback mode * **true (default)** - allow switching to external playback mode
@ -1149,16 +1161,6 @@ Example:
Platforms: Android Platforms: Android
#### onReadyForDisplay
Callback function that is called when the first video frame is ready for display. This is when the poster is removed.
Payload: none
* iOS: [readyForDisplay](https://developer.apple.com/documentation/avkit/avplayerviewcontroller/1615830-readyfordisplay?language=objc)
* Android [STATE_READY](https://exoplayer.dev/doc/reference/com/google/android/exoplayer2/Player.html#STATE_READY)
Platforms: Android, iOS, Web
#### onPictureInPictureStatusChanged #### onPictureInPictureStatusChanged
Callback function that is called when picture in picture becomes active or inactive. Callback function that is called when picture in picture becomes active or inactive.
@ -1191,7 +1193,6 @@ Example:
Platforms: all Platforms: all
#### onProgress #### onProgress
Callback function that is called every progressUpdateInterval milliseconds with info about which position the media is currently playing. Callback function that is called every progressUpdateInterval milliseconds with info about which position the media is currently playing.
@ -1212,6 +1213,41 @@ Example:
Platforms: all Platforms: all
#### onReadyForDisplay
Callback function that is called when the first video frame is ready for display. This is when the poster is removed.
Payload: none
* iOS: [readyForDisplay](https://developer.apple.com/documentation/avkit/avplayerviewcontroller/1615830-readyfordisplay?language=objc)
* Android [STATE_READY](https://exoplayer.dev/doc/reference/com/google/android/exoplayer2/Player.html#STATE_READY)
Platforms: Android, iOS, Web
#### onReceiveAdEvent
Callback function that is called when an AdEvent is received from the IMA's SDK.
Payload:
| Property | Type | Description |
|----------|--------|-----------------------|
| event | string | The ad event received |
Example:
```
{
"event": "LOADED"
}
```
Platforms: Android, iOS
#### onRestoreUserInterfaceForPictureInPictureStop
Callback function that corresponds to Apple's [`restoreUserInterfaceForPictureInPictureStopWithCompletionHandler`](https://developer.apple.com/documentation/avkit/avpictureinpicturecontrollerdelegate/1614703-pictureinpicturecontroller?language=objc). Call `restoreUserInterfaceForPictureInPictureStopCompleted` inside of this function when done restoring the user interface.
Payload: none
Platforms: iOS
#### onSeek #### onSeek
Callback function that is called when a seek completes. Callback function that is called when a seek completes.
@ -1235,13 +1271,6 @@ Both the currentTime & seekTime are reported because the video player may not se
Platforms: Android, iOS, Windows UWP Platforms: Android, iOS, Windows UWP
#### onRestoreUserInterfaceForPictureInPictureStop
Callback function that corresponds to Apple's [`restoreUserInterfaceForPictureInPictureStopWithCompletionHandler`](https://developer.apple.com/documentation/avkit/avpictureinpicturecontrollerdelegate/1614703-pictureinpicturecontroller?language=objc). Call `restoreUserInterfaceForPictureInPictureStopCompleted` inside of this function when done restoring the user interface.
Payload: none
Platforms: iOS
#### onTimedMetadata #### onTimedMetadata
Callback function that is called when timed metadata becomes available Callback function that is called when timed metadata becomes available
@ -1618,4 +1647,3 @@ allprojects {
} }
``` ```
If you encounter an error `Could not find com.android.support:support-annotations:27.0.0.` reinstall your Android Support Repository. If you encounter an error `Could not find com.android.support:support-annotations:27.0.0.` reinstall your Android Support Repository.