Changes for .github/PULL_REQUEST_TEMPLATE.md: 20 added lines, 0 removed lines.
Original line number
Diff line number
Diff line
Thanks for opening a PR!
Since this is a volunteer project and is very active, anything you can do to reduce the amount of time needed to review and merge your PR is appreciated.
The following steps will help get your PR merged quickly:
#### Update the documentation
If you've added new functionality, update the README.md with an entry for your prop or event.
The entry should be inserted in alphabetical order.
#### Update the changelog
After you open the PR, update the CHANGELOG.md file with an entry pointing to your PR.
#### Provide an example of how to test the change
If the PR requires special testing setup provide all the relevant instructions and files. This may include a sample video file or URL, configuration, or setup steps.
#### Focus the PR on only one area
Testing multiple features takes longer than isolated changes and if there is a bug in one feature, prevents the other parts of your PR from getting merged until it gets fixed.
If you're touching multiple different areas that aren't related, break the changes up into multiple PRs.
#### Describe the changes
Add a note describing what your PR does. If there is a change to the behavior of the code, explain why it needs to be updated.
*** false (default)** - Don't show player controls
***true** - Show player controls
Note on iOS, controls are always shown when in fullscreen mode.
Platforms: DOM, iOS
#### fullscreen
Controls whether the player enters fullscreen on play.
***false (default)** - Don't display the video in fullscreen
***true** - Display the video in fullscreen
Platforms: iOS
#### fullscreenOrientation
***all (default)** -
***landscape**
***portrait**
Platforms: iOS
#### headers
Pass headers to the HTTP client. Can be used for authorization.
To enable this on iOS, you will need to manually edit RCTVideo.m and uncomment the header code in the playerItemForSource function. This is because the code used a private API and may cause your app to be rejected by the App Store. Use at your own risk.
Example:
```
headers={{
Authorization: 'bearer some-token-value',
'X-Custom-Header': 'some value'
}}
```
Platforms: Android ExoPlayer
#### id
Set the DOM id element so you can use document.getElementById on web platforms. Accepts string values.
Example:
```
id="video"
```
Platforms: DOM
#### ignoreSilentSwitch
Controls the iOS silent switch behavior
***"inherit" (default)** - Use the default AVPlayer behavior
@@ -586,6 +666,31 @@ Payload: none
Platforms: Android ExoPlayer, iOS
#### onEnd
Callback function that is called when the player reaches the end of the media.
Payload: none
Platforms: all
#### onExternalPlaybackChange
Callback function that is called when external playback mode for current playing video has changed. Mostly useful when connecting/disconnecting to Apple TV – it's called on connection/disconnection.
Payload:
Property | Type | Description
--- | --- | ---
isExternalPlaybackActive | boolean | Boolean indicating whether external playback mode is active
Example:
```
{
isExternalPlaybackActive: true
}
```
Platforms: iOS
#### onFullscreenPlayerWillPresent
Callback function that is called when the player is about to enter fullscreen mode.
@@ -680,7 +785,7 @@ Example:
Platforms: all
#### onProgress
Callback function that is called every progressInterval seconds with info about which position the media is currently playing.
Callback function that is called every progressUpdateInterval seconds with info about which position the media is currently playing.
Property | Type | Description
--- | --- | ---
@@ -697,6 +802,8 @@ Example:
}
```
Platforms: all
#### onTimedMetadata
Callback function that is called when timed metadata becomes available
