feat: move docs to github pages (#3296)
* feat(docs): setup nextra * feat(docs): add pages * docs: update introduction page * docs: fix typos * docs: fix links * docs: update README * docs: sync with master * docs: remove old docs * fix(ci/docs): fix typos * fix(ci/docs): fix docs setup * fix(docs): update next config * chore(ci/docs): clean up * chore(docs): add meta tags * chore: apply review changes * docs: move drm into api section * docs: fix next config * docs: fix links * docs: add methods section * chore: sync with main * docs: add missing onAudio events
This commit is contained in:
Krzysztof Moch
GitHub
parent
0f8467f51d
commit
85e30f0335
34
.github/actions/setup-bun/action.yml
vendored
Normal file
34
.github/actions/setup-bun/action.yml
vendored
Normal file
@ -0,0 +1,34 @@
|
||||
name: setup bun
|
||||
description: Setup bun and install dependencies
|
||||
|
||||
inputs:
|
||||
working-directory:
|
||||
description: 'working directory for action'
|
||||
default: ./
|
||||
required: false
|
||||
|
||||
runs:
|
||||
using: composite
|
||||
steps:
|
||||
- name: Setup Bun
|
||||
uses: oven-sh/setup-bun@v1
|
||||
with:
|
||||
bun-version: 1.0.4
|
||||
|
||||
- name: Cache dependencies
|
||||
id: bun-cache
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: |
|
||||
**/node_modules
|
||||
key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lockb') }}-${{ hashFiles('**/package.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-bun-${{ hashFiles('**/bun.lockb') }}
|
||||
${{ runner.os }}-bun-
|
||||
|
||||
- name: Install dependencies
|
||||
working-directory: github.event.inputs.working-directory
|
||||
if: steps.bun-cache.outputs.cache-hit != 'true'
|
||||
run: bun install
|
||||
shell: bash
|
||||
|
||||
1
.github/workflows/ci.yml
vendored
1
.github/workflows/ci.yml
vendored
@ -3,6 +3,7 @@ on: [push, pull_request]
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/setup-node@v3
|
||||
|
||||
46
.github/workflows/deploy-docs.yml
vendored
Normal file
46
.github/workflows/deploy-docs.yml
vendored
Normal file
@ -0,0 +1,46 @@
|
||||
|
||||
name: deploy docs
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
paths:
|
||||
- '.github/workflows/deploy-docs.yml'
|
||||
- 'docs/**'
|
||||
|
||||
jobs:
|
||||
deploy-docs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Setup
|
||||
uses: ./.github/actions/setup-bun
|
||||
with:
|
||||
working-directory: ./docs
|
||||
|
||||
- name: Cache build
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: |
|
||||
docs/.next/cache
|
||||
key: ${{ runner.os }}-nextjs-${{ hashFiles('**/bun.lockb') }}-${{ hashFiles('**/package.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-nextjs-${{ hashFiles('**/bun.lockb') }}
|
||||
${{ runner.os }}-nextjs-
|
||||
|
||||
- name: Build docs
|
||||
run: |
|
||||
bun --cwd docs build
|
||||
touch docs/out/.nojekyll
|
||||
|
||||
- name: Deploy docs to GitHub Pages
|
||||
uses: JamesIves/github-pages-deploy-action@v4
|
||||
with:
|
||||
branch: gh-pages
|
||||
folder: docs/out
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
65
README.md
65
README.md
@ -1,31 +1,50 @@
|
||||
# react-native-video
|
||||
🎬 `<Video>` component for React Native
|
||||
|
||||
> :warning: **Version 6 Alpha**: The following documentation may refer to features only available through the v6.0.0 alpha releases, [please see version 5.2.x](https://github.com/react-native-video/react-native-video/blob/v5.2.0/README.md) for the current documentation!
|
||||
> **Note:** version 5.2.1 won't have any updates. We are currently working on making a alpha 6.0.0 stable
|
||||
|
||||
## A `<Video>` component for react-native.
|
||||
Version 6.x recommends react-native >= 0.68.2.
|
||||
<br>For older versions of react-native, [please use version 5.x](https://github.com/react-native-video/react-native-video/tree/v5.2.0).
|
||||
## Documentation
|
||||
Documentation is available at [react-native-video.github.io/react-native-video](https://react-native-video.github.io/react-native-video/).
|
||||
|
||||
### Version 6.0.0 breaking changes
|
||||
## Usage
|
||||
|
||||
Version 6.0.0 is introducing dozens of breaking changes, mostly through updated dependecies and significant refactoring. While the API remains compatible, the significant internal changes require full testing with your app to ensure all functionality remains operational. Please view the [Changelog](CHANGELOG.md) for specific breaking changes.
|
||||
```javascript
|
||||
// Load the module
|
||||
|
||||
### Installing Version 6.0.0 Alphas
|
||||
Whilst we finalise version 6.0.0 you can install the latest alpha from npm
|
||||
Using npm:
|
||||
```
|
||||
npm install --save react-native-video@alpha
|
||||
```
|
||||
using yarn:
|
||||
```
|
||||
yarn add react-native-video@alpha
|
||||
import Video, {VideoRef} from 'react-native-video';
|
||||
|
||||
// Within your render function, assuming you have a file called
|
||||
// "background.mp4" in your project. You can include multiple videos
|
||||
// on a single screen if you like.
|
||||
|
||||
const VideoPlayer = () => {
|
||||
const videoRef = useRef<VideoRef>(null);
|
||||
const background = require('./background.mp4');
|
||||
|
||||
return (
|
||||
<Video
|
||||
// Can be a URL or a local file.
|
||||
source={background}
|
||||
// Store reference
|
||||
ref={videoRef}
|
||||
// Callback when remote video is buffering
|
||||
onBuffer={onBuffer}
|
||||
// Callback when video cannot be loaded
|
||||
onError={onError}
|
||||
style={styles.backgroundVideo}
|
||||
/>
|
||||
)
|
||||
}
|
||||
|
||||
// Later on in your styles..
|
||||
var styles = StyleSheet.create({
|
||||
backgroundVideo: {
|
||||
position: 'absolute',
|
||||
top: 0,
|
||||
left: 0,
|
||||
bottom: 0,
|
||||
right: 0,
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
## Useful resources
|
||||
- [Documentation](API.md)
|
||||
- [Changelog](CHANGELOG.md)
|
||||
- [Contribution guide](CONTRIBUTING.md)
|
||||
- [Usefull Side Project](./docs/PROJECTS.md)
|
||||
- [Advanced debugging](./docs/DEBUGGING.md)
|
||||
|
||||
**react-native-video** was originally created by [Brent Vatne](https://github.com/brentvatne)
|
||||
|
||||
3
docs/.gitignore
vendored
Normal file
3
docs/.gitignore
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
node_modules/
|
||||
out/
|
||||
.next/
|
||||
15
docs/README.md
Normal file
15
docs/README.md
Normal file
@ -0,0 +1,15 @@
|
||||
# react-native-video-docs
|
||||
|
||||
This is the documentation for the [react-native-video](github.com/react-native-video/react-native-video).
|
||||
Project is using [bun](https://bun.sh) to build and run the documentation.
|
||||
Framework for static site generation is [Nextra](https://nextra.site/docs)
|
||||
|
||||
```bash
|
||||
bun install
|
||||
```
|
||||
|
||||
To run:
|
||||
|
||||
```bash
|
||||
bun run dev
|
||||
```
|
||||
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 45 KiB |
|
Before Width: | Height: | Size: 74 KiB After Width: | Height: | Size: 74 KiB |
|
Before Width: | Height: | Size: 77 KiB After Width: | Height: | Size: 77 KiB |
BIN
docs/bun.lockb
Executable file
BIN
docs/bun.lockb
Executable file
Binary file not shown.
5
docs/next-env.d.ts
vendored
Normal file
5
docs/next-env.d.ts
vendored
Normal file
@ -0,0 +1,5 @@
|
||||
/// <reference types="next" />
|
||||
/// <reference types="next/image-types/global" />
|
||||
|
||||
// NOTE: This file should not be edited
|
||||
// see https://nextjs.org/docs/basic-features/typescript for more information.
|
||||
28
docs/next.config.js
Normal file
28
docs/next.config.js
Normal file
@ -0,0 +1,28 @@
|
||||
/* eslint-disable @typescript-eslint/no-var-requires */
|
||||
|
||||
const withNextra = require('nextra')({
|
||||
theme: 'nextra-theme-docs',
|
||||
themeConfig: './theme.config.jsx',
|
||||
});
|
||||
|
||||
let assetPrefix = '';
|
||||
let basePath = '';
|
||||
|
||||
// If we're in a GitHub Action, we need to set the assetPrefix and basePath
|
||||
// to add repo_name to the path.
|
||||
// eg. https://<organization>.github.io/<repo_name>
|
||||
if (process.env.GITHUB_ACTIONS) {
|
||||
const repo_name = 'react-native-video';
|
||||
|
||||
assetPrefix = `/${repo_name}/`;
|
||||
basePath = `/${repo_name}`;
|
||||
}
|
||||
|
||||
module.exports = withNextra({
|
||||
output: 'export',
|
||||
images: {
|
||||
unoptimized: true,
|
||||
},
|
||||
assetPrefix,
|
||||
basePath,
|
||||
});
|
||||
20
docs/package.json
Normal file
20
docs/package.json
Normal file
@ -0,0 +1,20 @@
|
||||
{
|
||||
"name": "react-native-video-docs",
|
||||
"version": "0.0.1",
|
||||
"private": true,
|
||||
"description": "Documentation for react-native-video",
|
||||
"scripts": {
|
||||
"dev": "bun next dev",
|
||||
"build": "bun next build"
|
||||
},
|
||||
"dependencies": {
|
||||
"next": "^13.5.4",
|
||||
"nextra": "^2.13.2",
|
||||
"nextra-theme-docs": "^2.13.2",
|
||||
"react": "^18.2.0",
|
||||
"react-dom": "^18.2.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"bun-types": "latest"
|
||||
}
|
||||
}
|
||||
21
docs/pages/_meta.json
Normal file
21
docs/pages/_meta.json
Normal file
@ -0,0 +1,21 @@
|
||||
{
|
||||
"index": "Introduction",
|
||||
"installation": "Installation",
|
||||
"component": "API",
|
||||
"other": "Other",
|
||||
"separator_versions": {
|
||||
"type": "separator",
|
||||
"title": ""
|
||||
},
|
||||
"updating": "Updating",
|
||||
"changelog": {
|
||||
"title": "Changelog",
|
||||
"newWindow": true,
|
||||
"href": "https://github.com/react-native-video/react-native-video/blob/master/CHANGELOG.md"
|
||||
},
|
||||
"separator_community": {
|
||||
"type": "separator",
|
||||
"title": ""
|
||||
},
|
||||
"projects": "Useful projects"
|
||||
}
|
||||
6
docs/pages/component/_meta.json
Normal file
6
docs/pages/component/_meta.json
Normal file
@ -0,0 +1,6 @@
|
||||
{
|
||||
"props": "Properties",
|
||||
"drm": "DRM",
|
||||
"events": "Events",
|
||||
"methods": "Methods"
|
||||
}
|
||||
@ -31,7 +31,10 @@ Platforms: iOS
|
||||
|
||||
### `getLicense`
|
||||
|
||||
`licenseServer` and `headers` will be ignored. You will obtain as argument the `SPC` (as ASCII string, you will probably need to convert it to base 64) obtained from your `contentId` + the provided certificate via `[loadingRequest streamingContentKeyRequestDataForApp:certificateData contentIdentifier:contentIdData options:nil error:&spcError];`.
|
||||
`licenseServer` and `headers` will be ignored. You will obtain as argument the `SPC` (as ASCII string, you will probably need to convert it to base 64) obtained from your `contentId` + the provided certificate via
|
||||
```objc
|
||||
[loadingRequest streamingContentKeyRequestDataForApp:certificateData contentIdentifier:contentIdData options:nil error:&spcError];
|
||||
```
|
||||
|
||||
Also, you will receive the `contentId` and a `licenseUrl` URL defined as `loadingRequest.request.URL.absoluteString ` or as the `licenseServer` prop if it's passed.
|
||||
|
||||
510
docs/pages/component/events.md
Normal file
510
docs/pages/component/events.md
Normal file
@ -0,0 +1,510 @@
|
||||
# Events
|
||||
This page shows the list of available callbacks to handle player notifications
|
||||
|
||||
## List
|
||||
| Name | Platforms Support |
|
||||
|-------------------------------------------------------------------------------------------------|---------------------------|
|
||||
| [onAudioBecomingNoisy](#onaudiobecomingnoisy) | Android, iOS |
|
||||
| [onAudioFocusChanged](#onaudiofocuschanged) | Android |
|
||||
| [onAudioTracks](#onaudiotracks) | Android |
|
||||
| [onBandwidthUpdate](#onbandwidthupdate) | Android |
|
||||
| [onBuffer](#onbuffer) | Android, iOS |
|
||||
| [onEnd](#onend) | All |
|
||||
| [onError](#onerror) | Android, iOS, Windows UWP |
|
||||
| [onExternalPlaybackChange](#onexternalplaybackchange) | iOS |
|
||||
| [onFullscreenPlayerWillPresent](#onfullscreenplayerwillpresent) | Android, iOS |
|
||||
| [onFullscreenPlayerDidPresent](#onfullscreenplayerdidpresent) | Android, iOS |
|
||||
| [onFullscreenPlayerWillDismiss](#onfullscreenplayerwilldismiss) | Android, iOS |
|
||||
| [onFullscreenPlayerDidDismiss](#onfullscreenplayerdiddismiss) | Android, iOS |
|
||||
| [onLoad](#onload) | All |
|
||||
| [onLoadStart](#onloadstart) | All |
|
||||
| [onPictureInPictureStatusChanged](#onpictureinpicturestatuschanged) | iOS |
|
||||
| [onPlaybackRateChange](#onplaybackratechange) | All |
|
||||
| [onPlaybackStateChanged](#onplaybackstatechanged) | Android, iOS |
|
||||
| [onProgress](#onprogress) | All |
|
||||
| [onReadyForDisplay](#onreadyfordisplay) | Android, iOS, Web |
|
||||
| [onReceiveAdEvent](#onreceiveadevent) | Android, iOS |
|
||||
| [onRestoreUserInterfaceForPictureInPictureStop](#onrestoreuserinterfaceforpictureinpicturestop) | iOS |
|
||||
| [onSeek](#onseek) | Android, iOS, Windows UWP |
|
||||
| [onTimedMetadata](#ontimedmetadata) | Android, iOS |
|
||||
| [onTextTracks](#ontexttracks) | Android |
|
||||
| [onVideoTracks](#onvideotracks) | Android |
|
||||
|
||||
|
||||
## Details
|
||||
### `onAudioBecomingNoisy`
|
||||
Callback function that is called when the audio is about to become 'noisy' due to a change in audio outputs. Typically this is called when audio output is being switched from an external source like headphones back to the internal speaker. It's a good idea to pause the media when this happens so the speaker doesn't start blasting sound.
|
||||
|
||||
Payload: none
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `onAudioFocusChanged`
|
||||
Callback function that is called when the audio focus changes. This is called when the audio focus is gained or lost. This is useful for determining if the media should be paused or not.
|
||||
|
||||
Payload:
|
||||
Property | Type | Description
|
||||
--- | --- | ---
|
||||
hasAudioFocus | boolean | Boolean indicating whether the media has audio focus
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
{
|
||||
hasAudioFocus: true
|
||||
}
|
||||
```
|
||||
|
||||
### `onAudioTracks`
|
||||
Callback function that is called when audio tracks change
|
||||
|
||||
Payload:
|
||||
|
||||
An **array** of
|
||||
Property | Type | Description
|
||||
--- | --- | ---
|
||||
index | number | Index number of the track
|
||||
title | string | Description of the track
|
||||
language | string | 2 letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) or 3 letter [ISO 639-2](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) language code
|
||||
type | string | Mime type of track
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
{
|
||||
audioTracks: [
|
||||
{ language: 'es', title: 'Spanish', type: 'audio/mpeg', index: 0 },
|
||||
{ language: 'en', title: 'English', type: 'audio/mpeg', index: 1 }
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### `onBandwidthUpdate`
|
||||
Callback function that is called when the available bandwidth changes.
|
||||
|
||||
Payload:
|
||||
|
||||
Property | Type | Description
|
||||
--- | --- | ---
|
||||
bitrate | number | The estimated bitrate in bits/sec
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
{
|
||||
bitrate: 1000000
|
||||
}
|
||||
```
|
||||
|
||||
Note: On Android, you must set the [reportBandwidth](#reportbandwidth) prop to enable this event. This is due to the high volume of events generated.
|
||||
|
||||
Platforms: Android
|
||||
|
||||
### `onBuffer`
|
||||
Callback function that is called when the player buffers.
|
||||
|
||||
Payload:
|
||||
|
||||
Property | Type | Description
|
||||
--- | --- | ---
|
||||
isBuffering | boolean | Boolean indicating whether buffering is active
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
{
|
||||
isBuffering: true
|
||||
}
|
||||
```
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `onEnd`
|
||||
Callback function that is called when the player reaches the end of the media.
|
||||
|
||||
Payload: none
|
||||
|
||||
Platforms: all
|
||||
|
||||
### `onError`
|
||||
Callback function that is called when the player experiences a playback error.
|
||||
|
||||
Payload:
|
||||
|
||||
Property | Type | Description
|
||||
--- | --- | ---
|
||||
error | object | Object containing properties with information about the error
|
||||
|
||||
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:
|
||||
```javascript
|
||||
{
|
||||
isExternalPlaybackActive: true
|
||||
}
|
||||
```
|
||||
|
||||
Platforms: iOS
|
||||
|
||||
### `onFullscreenPlayerWillPresent`
|
||||
Callback function that is called when the player is about to enter fullscreen mode.
|
||||
|
||||
Payload: none
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `onFullscreenPlayerDidPresent`
|
||||
Callback function that is called when the player has entered fullscreen mode.
|
||||
|
||||
Payload: none
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `onFullscreenPlayerWillDismiss`
|
||||
Callback function that is called when the player is about to exit fullscreen mode.
|
||||
|
||||
Payload: none
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `onFullscreenPlayerDidDismiss`
|
||||
Callback function that is called when the player has exited fullscreen mode.
|
||||
|
||||
Payload: none
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `onLoad`
|
||||
Callback function that is called when the media is loaded and ready to play.
|
||||
|
||||
Payload:
|
||||
|
||||
Property | Type | Description
|
||||
--- | --- | ---
|
||||
currentTime | number | Time in seconds where the media will start
|
||||
duration | number | Length of the media in seconds
|
||||
naturalSize | object | Properties:<br> * width - Width in pixels that the video was encoded at<br> * height - Height in pixels that the video was encoded at<br> * orientation - "portrait" or "landscape"
|
||||
audioTracks | array | An array of audio track info objects with the following properties:<br> * index - Index number<br> * title - Description of the track<br> * language - 2 letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) or 3 letter [ISO639-2](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) language code<br> * type - Mime type of track
|
||||
textTracks | array | An array of text track info objects with the following properties:<br> * index - Index number<br> * title - Description of the track<br> * language - 2 letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) or 3 letter [ISO 639-2](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) language code<br> * type - Mime type of track
|
||||
videoTracks | array | An array of video track info objects with the following properties:<br> * trackId - ID for the track<br> * bitrate - Bit rate in bits per second<br> * codecs - Comma separated list of codecs<br> * height - Height of the video<br> * width - Width of the video
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
{
|
||||
canPlaySlowForward: true,
|
||||
canPlayReverse: false,
|
||||
canPlaySlowReverse: false,
|
||||
canPlayFastForward: false,
|
||||
canStepForward: false,
|
||||
canStepBackward: false,
|
||||
currentTime: 0,
|
||||
duration: 5910.208984375,
|
||||
naturalSize: {
|
||||
height: 1080
|
||||
orientation: 'landscape'
|
||||
width: '1920'
|
||||
},
|
||||
audioTracks: [
|
||||
{ language: 'es', title: 'Spanish', type: 'audio/mpeg', index: 0 },
|
||||
{ language: 'en', title: 'English', type: 'audio/mpeg', index: 1 }
|
||||
],
|
||||
textTracks: [
|
||||
{ title: '#1 French', language: 'fr', index: 0, type: 'text/vtt' },
|
||||
{ title: '#2 English CC', language: 'en', index: 1, type: 'text/vtt' },
|
||||
{ title: '#3 English Director Commentary', language: 'en', index: 2, type: 'text/vtt' }
|
||||
],
|
||||
videoTracks: [
|
||||
{ bitrate: 3987904, codecs: "avc1.640028", height: 720, trackId: "f1-v1-x3", width: 1280 },
|
||||
{ bitrate: 7981888, codecs: "avc1.640028", height: 1080, trackId: "f2-v1-x3", width: 1920 },
|
||||
{ bitrate: 1994979, codecs: "avc1.4d401f", height: 480, trackId: "f3-v1-x3", width: 848 }
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Platforms: all
|
||||
|
||||
### `onLoadStart`
|
||||
Callback function that is called when the media starts loading.
|
||||
|
||||
Payload:
|
||||
|
||||
Property | Description
|
||||
--- | ---
|
||||
isNetwork | boolean | Boolean indicating if the media is being loaded from the network
|
||||
type | string | Type of the media. Not available on Windows
|
||||
uri | string | URI for the media source. Not available on Windows
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
{
|
||||
isNetwork: true,
|
||||
type: '',
|
||||
uri: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8'
|
||||
}
|
||||
```
|
||||
|
||||
Platforms: all
|
||||
|
||||
### `onPlaybackStateChanged`
|
||||
Callback function that is called when the playback state changes.
|
||||
|
||||
Payload:
|
||||
|
||||
Property | Description
|
||||
--- | ---
|
||||
isPlaying | boolean | Boolean indicating if the media is playing or not
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
{
|
||||
isPlaying: true,
|
||||
}
|
||||
```
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `onPictureInPictureStatusChanged`
|
||||
Callback function that is called when picture in picture becomes active or inactive.
|
||||
|
||||
Property | Type | Description
|
||||
--- | --- | ---
|
||||
isActive | boolean | Boolean indicating whether picture in picture is active
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
{
|
||||
isActive: true
|
||||
}
|
||||
```
|
||||
|
||||
Platforms: iOS
|
||||
|
||||
### `onPlaybackRateChange`
|
||||
Callback function that is called when the rate of playback changes - either paused or starts/resumes.
|
||||
|
||||
Property | Type | Description
|
||||
--- | --- | ---
|
||||
playbackRate | number | 0 when playback is paused, 1 when playing at normal speed. Other values when playback is slowed down or sped up
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
{
|
||||
playbackRate: 0, // indicates paused
|
||||
}
|
||||
```
|
||||
|
||||
Platforms: all
|
||||
|
||||
### `onProgress`
|
||||
Callback function that is called every progressUpdateInterval milliseconds with info about which position the media is currently playing.
|
||||
|
||||
Property | Type | Description
|
||||
--- | --- | ---
|
||||
currentTime | number | Current position in seconds
|
||||
playableDuration | number | Position to where the media can be played to using just the buffer in seconds
|
||||
seekableDuration | number | Position to where the media can be seeked to in seconds. Typically, the total length of the media
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
{
|
||||
currentTime: 5.2,
|
||||
playableDuration: 34.6,
|
||||
seekableDuration: 888
|
||||
}
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
Enum `AdEvent` possible values for [Android](https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/reference/js/google.ima.AdEvent) and [iOS](https://developers.google.com/interactive-media-ads/docs/sdks/ios/client-side/reference/Enums/IMAAdEventType):
|
||||
|
||||
<details>
|
||||
<summary>Events</summary>
|
||||
|
||||
| Event | Platform | Description |
|
||||
|----------------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `AD_BREAK_ENDED` | iOS | Fired the first time each ad break ends. Applications must reenable seeking when this occurs (only used for dynamic ad insertion). |
|
||||
| `AD_BREAK_READY` | Android, iOS | Fires when an ad rule or a VMAP ad break would have played if autoPlayAdBreaks is false. |
|
||||
| `AD_BREAK_STARTED` | iOS | Fired first time each ad break begins playback. If an ad break is watched subsequent times this will not be fired. Applications must disable seeking when this occurs (only used for dynamic ad insertion). |
|
||||
| `AD_BUFFERING` | Android | Fires when the ad has stalled playback to buffer. |
|
||||
| `AD_CAN_PLAY` | Android | Fires when the ad is ready to play without buffering, either at the beginning of the ad or after buffering completes. |
|
||||
| `AD_METADATA` | Android | Fires when an ads list is loaded. |
|
||||
| `AD_PERIOD_ENDED` | iOS | Fired every time the stream switches from advertising or slate to content. This will be fired even when an ad is played a second time or when seeking into an ad (only used for dynamic ad insertion). |
|
||||
| `AD_PERIOD_STARTED` | iOS | Fired every time the stream switches from content to advertising or slate. This will be fired even when an ad is played a second time or when seeking into an ad (only used for dynamic ad insertion). |
|
||||
| `AD_PROGRESS` | Android | Fires when the ad's current time value changes. Calling getAdData() on this event will return an AdProgressData object. |
|
||||
| `ALL_ADS_COMPLETED` | Android, iOS | Fires when the ads manager is done playing all the valid ads in the ads response, or when the response doesn't return any valid ads. |
|
||||
| `CLICK` | Android, iOS | Fires when the ad is clicked. |
|
||||
| `COMPLETE` | Android, iOS | Fires when the ad completes playing. |
|
||||
| `CONTENT_PAUSE_REQUESTED` | Android | Fires when content should be paused. This usually happens right before an ad is about to cover the content. |
|
||||
| `CONTENT_RESUME_REQUESTED` | Android | Fires when content should be resumed. This usually happens when an ad finishes or collapses. |
|
||||
| `CUEPOINTS_CHANGED` | iOS | Cuepoints changed for VOD stream (only used for dynamic ad insertion). |
|
||||
| `DURATION_CHANGE` | Android | Fires when the ad's duration changes. |
|
||||
| `FIRST_QUARTILE` | Android, iOS | Fires when the ad playhead crosses first quartile. |
|
||||
| `IMPRESSION` | Android | Fires when the impression URL has been pinged. |
|
||||
| `INTERACTION` | Android | Fires when an ad triggers the interaction callback. Ad interactions contain an interaction ID string in the ad data. |
|
||||
| `LINEAR_CHANGED` | Android | Fires when the displayed ad changes from linear to nonlinear, or the reverse. |
|
||||
| `LOADED` | Android, iOS | Fires when ad data is available. |
|
||||
| `LOG` | Android, iOS | Fires when a non-fatal error is encountered. The user need not take any action since the SDK will continue with the same or next ad playback depending on the error situation. |
|
||||
| `MIDPOINT` | Android, iOS | Fires when the ad playhead crosses midpoint. |
|
||||
| `PAUSED` | Android, iOS | Fires when the ad is paused. |
|
||||
| `RESUMED` | Android, iOS | Fires when the ad is resumed. |
|
||||
| `SKIPPABLE_STATE_CHANGED` | Android | Fires when the displayed ads skippable state is changed. |
|
||||
| `SKIPPED` | Android, iOS | Fires when the ad is skipped by the user. |
|
||||
| `STARTED` | Android, iOS | Fires when the ad starts playing. |
|
||||
| `STREAM_LOADED` | iOS | Stream request has loaded (only used for dynamic ad insertion). |
|
||||
| `TAPPED` | iOS | Fires when the ad is tapped. |
|
||||
| `THIRD_QUARTILE` | Android, iOS | Fires when the ad playhead crosses third quartile. |
|
||||
| `UNKNOWN` | iOS | An unknown event has fired |
|
||||
| `USER_CLOSE` | Android | Fires when the ad is closed by the user. |
|
||||
| `VIDEO_CLICKED` | Android | Fires when the non-clickthrough portion of a video ad is clicked. |
|
||||
| `VIDEO_ICON_CLICKED` | Android | Fires when a user clicks a video icon. |
|
||||
| `VOLUME_CHANGED` | Android | Fires when the ad volume has changed. |
|
||||
| `VOLUME_MUTED` | Android | Fires when the ad volume has been muted. |
|
||||
</details>
|
||||
|
||||
Payload:
|
||||
|
||||
| Property | Type | Description |
|
||||
|----------|---------|-----------------------|
|
||||
| event | AdEvent | The ad event received |
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
{
|
||||
"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`
|
||||
Callback function that is called when a seek completes.
|
||||
|
||||
Payload:
|
||||
|
||||
Property | Type | Description
|
||||
--- | --- | ---
|
||||
currentTime | number | The current time after the seek
|
||||
seekTime | number | The requested time
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
{
|
||||
currentTime: 100.5
|
||||
seekTime: 100
|
||||
}
|
||||
```
|
||||
|
||||
Both the currentTime & seekTime are reported because the video player may not seek to the exact requested position in order to improve seek performance.
|
||||
|
||||
|
||||
Platforms: Android, iOS, Windows UWP
|
||||
|
||||
### `onTimedMetadata`
|
||||
Callback function that is called when timed metadata becomes available
|
||||
|
||||
Payload:
|
||||
|
||||
Property | Type | Description
|
||||
--- | --- | ---
|
||||
metadata | array | Array of metadata objects
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
{
|
||||
metadata: [
|
||||
{ value: 'Streaming Encoder', identifier: 'TRSN' },
|
||||
{ value: 'Internet Stream', identifier: 'TRSO' },
|
||||
{ value: 'Any Time You Like', identifier: 'TIT2' }
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `onTextTracks`
|
||||
Callback function that is called when text tracks change
|
||||
|
||||
Payload:
|
||||
|
||||
Property | Type | Description
|
||||
--- | --- | ---
|
||||
index | number | Internal track ID
|
||||
title | string | Descriptive name for the track
|
||||
language | string | 2 letter [ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) representing the language
|
||||
type | string | Mime type of the track<br> * TextTrackType.SRT - SubRip (.srt)<br> * TextTrackType.TTML - TTML (.ttml)<br> * TextTrackType.VTT - WebVTT (.vtt)<br>iOS only supports VTT, Android supports all 3
|
||||
selected | boolean | true if track is playing
|
||||
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
{
|
||||
textTracks: [
|
||||
{
|
||||
index: 0,
|
||||
title: 'Any Time You Like',
|
||||
type: 'srt',
|
||||
selected: true
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Platforms: Android
|
||||
|
||||
### `onVideoTracks`
|
||||
Callback function that is called when video tracks change
|
||||
|
||||
Payload:
|
||||
|
||||
Property | Type | Description
|
||||
--- | --- | ---
|
||||
trackId | number | Internal track ID
|
||||
codecs | string | MimeType of codec used for this track
|
||||
width | number | Track width
|
||||
height | number | Track height
|
||||
bitrate | number | Bitrate in bps
|
||||
selected | boolean | true if track is selected for playing
|
||||
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
{
|
||||
videoTracks: [
|
||||
{
|
||||
trackId: 0,
|
||||
codecs: 'video/mp4',
|
||||
width: 1920,
|
||||
height: 1080,
|
||||
bitrate: 10000,
|
||||
selected: true
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Platforms: Android
|
||||
182
docs/pages/component/methods.md
Normal file
182
docs/pages/component/methods.md
Normal file
@ -0,0 +1,182 @@
|
||||
# Methods
|
||||
This page shows the list of available methods
|
||||
|
||||
## Component methods
|
||||
|
||||
| Name |Platforms Support |
|
||||
|-------------------------------------------------------------------------------------------|-------------------|
|
||||
|[dismissFullscreenPlayer](#dismissfullscreenplayer) |Android, iOS |
|
||||
|[presentFullscreenPlayer](#presentfullscreenplayer) |Android, iOS |
|
||||
|[pause](#pause) |Android, iOS |
|
||||
|[play](#play) |Android, iOS |
|
||||
|[save](#save) |iOS |
|
||||
|[restoreUserInterfaceForPictureInPictureStop](#restoreuserinterfaceforpictureinpicturestop)|iOS |
|
||||
|[seek](#seek) |All |
|
||||
|
||||
### `dismissFullscreenPlayer`
|
||||
`dismissFullscreenPlayer(): Promise<void>`
|
||||
|
||||
Take the player out of fullscreen mode.
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `presentFullscreenPlayer`
|
||||
`presentFullscreenPlayer(): Promise<void>`
|
||||
|
||||
Put the player in fullscreen mode.
|
||||
|
||||
On iOS, this displays the video in a fullscreen view controller with controls.
|
||||
|
||||
On Android, this puts the navigation controls in fullscreen mode. It is not a complete fullscreen implementation, so you will still need to apply a style that makes the width and height match your screen dimensions to get a fullscreen video.
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `pause`
|
||||
`pause(): Promise<void>`
|
||||
|
||||
Pause the video.
|
||||
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `play`
|
||||
`play(): Promise<void>`
|
||||
|
||||
Play the video.
|
||||
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `save`
|
||||
`save(): Promise<{ uri: string }>`
|
||||
|
||||
Save video to your Photos with current filter prop. Returns promise.
|
||||
|
||||
|
||||
Notes:
|
||||
- Currently only supports highest quality export
|
||||
- Currently only supports MP4 export
|
||||
- Currently only supports exporting to user's cache directory with a generated UUID filename.
|
||||
- User will need to remove the saved video through their Photos app
|
||||
- Works with cached videos as well. (Checkout video-caching example)
|
||||
- If the video is has not began buffering (e.g. there is no internet connection) then the save function will throw an error.
|
||||
- If the video is buffering then the save function promise will return after the video has finished buffering and processing.
|
||||
|
||||
Future:
|
||||
- Will support multiple qualities through options
|
||||
- Will support more formats in the future through options
|
||||
- Will support custom directory and file name through options
|
||||
|
||||
Platforms: iOS
|
||||
|
||||
### `restoreUserInterfaceForPictureInPictureStopCompleted`
|
||||
`restoreUserInterfaceForPictureInPictureStopCompleted(restored)`
|
||||
|
||||
This function corresponds to the completion handler in Apple's [restoreUserInterfaceForPictureInPictureStop](https://developer.apple.com/documentation/avkit/avpictureinpicturecontrollerdelegate/1614703-pictureinpicturecontroller?language=objc). IMPORTANT: This function must be called after `onRestoreUserInterfaceForPictureInPictureStop` is called.
|
||||
|
||||
|
||||
Platforms: iOS
|
||||
|
||||
### `seek`
|
||||
`seek(seconds)`
|
||||
|
||||
Seek to the specified position represented by seconds. seconds is a float value.
|
||||
|
||||
`seek()` can only be called after the `onLoad` event has fired. Once completed, the [onSeek](#onseek) event will be called.
|
||||
|
||||
|
||||
Platforms: all
|
||||
|
||||
#### Exact seek
|
||||
|
||||
By default iOS seeks within 100 milliseconds of the target position. If you need more accuracy, you can use the seek with tolerance method:
|
||||
|
||||
`seek(seconds, tolerance)`
|
||||
|
||||
tolerance is the max distance in milliseconds from the seconds position that's allowed. Using a more exact tolerance can cause seeks to take longer. If you want to seek exactly, set tolerance to 0.
|
||||
|
||||
Platforms: iOS
|
||||
|
||||
|
||||
|
||||
### Example Usage
|
||||
```tsx
|
||||
const videoRef = useRef<VideoRef>(null);
|
||||
|
||||
const someCoolFunctions = async () => {
|
||||
if(!videoRef.current) {
|
||||
return;
|
||||
}
|
||||
|
||||
// present or dismiss fullscreen player
|
||||
videoRef.current.presentFullscreenPlayer();
|
||||
videoRef.current.dismissFullscreenPlayer();
|
||||
|
||||
// pause or play the video
|
||||
videoRef.current.play();
|
||||
videoRef.current.pause();
|
||||
|
||||
// save video to your Photos with current filter prop
|
||||
const response = await videoRef.current.save();
|
||||
const path = response.uri;
|
||||
|
||||
// seek to the specified position represented by seconds
|
||||
videoRef.current.seek(200);
|
||||
// or on iOS you can seek with tolerance
|
||||
videoRef.current.seek(200, 10);
|
||||
};
|
||||
|
||||
return (
|
||||
<Video
|
||||
ref={videoRef}
|
||||
source={{ uri: 'https://www.w3schools.com/html/mov_bbb.mp4' }}
|
||||
/>
|
||||
);
|
||||
```
|
||||
|
||||
## Static methods
|
||||
|
||||
### `getWidevineLevel`
|
||||
Indicates whether the widevine level supported by device.
|
||||
|
||||
Possible values are:
|
||||
- 0 - unable to determine widevine support (typically not supported)
|
||||
- 1, 2, 3 - Widevine level supported
|
||||
|
||||
Platform: Android
|
||||
|
||||
### `isCodecSupported`
|
||||
Indicates whether the provided codec is supported level supported by device.
|
||||
|
||||
parameters:
|
||||
- `mimetype`: mime type of codec to query
|
||||
- `width`, `height`: resolution to query
|
||||
|
||||
Possible results:
|
||||
- `hardware` - codec is supported by hardware
|
||||
- `software` - codec is supported by software only
|
||||
- `unsupported` - codec is not supported
|
||||
|
||||
Platform: Android
|
||||
|
||||
### `isHEVCSupported`
|
||||
Helper which Indicates whether the provided HEVC/1920*1080 is supported level supported by device. It uses isCodecSupported internally.
|
||||
|
||||
Platform: Android
|
||||
|
||||
### Example Usage
|
||||
```tsx
|
||||
import { VideoDecoderProperties } from 'react-native-video';
|
||||
|
||||
VideoDecoderProperties.getWidevineLevel().then((level) => {
|
||||
...
|
||||
});
|
||||
|
||||
VideoDecoderProperties.isCodecSupported('video/hevc', 1920, 1080).then((support) => {
|
||||
...
|
||||
});
|
||||
|
||||
VideoDecoderProperties.isHEVCSupported().then((support) => {
|
||||
...
|
||||
});
|
||||
```
|
||||
795
docs/pages/component/props.md
Normal file
795
docs/pages/component/props.md
Normal file
@ -0,0 +1,795 @@
|
||||
# Configurable props
|
||||
This page shows the list of available properties to configure player
|
||||
|
||||
## List
|
||||
|
||||
| Name | Platforms Support |
|
||||
|-------------------------------------------------------------------------------------|---------------------------|
|
||||
| [adTagUrl](#adtagurl) | Android, iOS |
|
||||
| [allowsExternalPlayback](#allowsexternalplayback) | iOS |
|
||||
| [audioOnly](#audioonly) | All |
|
||||
| [audioOutput](#audioOutput) | Android, iOS |
|
||||
| [automaticallyWaitsToMinimizeStalling](#automaticallywaitstominimizestalling) | iOS |
|
||||
| [backBufferDurationMs](#backbufferdurationms) | Android |
|
||||
| [bufferConfig](#bufferconfig) | Android |
|
||||
| [contentStartTime](#contentstarttime) | Android |
|
||||
| [controls](#controls) | Android, iOS |
|
||||
| [currentPlaybackTime](#currentplaybacktime) | Android |
|
||||
| [debug](#debug) | Android |
|
||||
| [disableFocus](#disablefocus) | Android, iOS |
|
||||
| [disableDisconnectError](#disabledisconnecterror) | Android |
|
||||
| [filter](#filter) | iOS |
|
||||
| [filterEnabled](#filterenabled) | iOS |
|
||||
| [focusable](#focusable) | Android |
|
||||
| [fullscreen](#fullscreen) | Android, iOS |
|
||||
| [fullscreenAutorotate](#fullscreenautorotate) | iOS |
|
||||
| [fullscreenOrientation](#fullscreenorientation) | iOS |
|
||||
| [headers](#headers) | Android |
|
||||
| [hideShutterView](#hideshutterview) | Android |
|
||||
| [ignoreSilentSwitch](#ignoresilentswitch) | iOS |
|
||||
| [maxBitRate](#maxbitrate) | Android, iOS |
|
||||
| [minLoadRetryCount](#minloadretrycount) | Android |
|
||||
| [mixWithOthers](#mixwithothers) | iOS |
|
||||
| [muted](#muted) | All |
|
||||
| [paused](#paused) | All |
|
||||
| [pictureInPicture](#pictureinpicture) | iOS |
|
||||
| [playInBackground](#playinbackground) | Android, iOS |
|
||||
| [playWhenInactive](#playwheninactive) | iOS |
|
||||
| [poster](#poster) | All |
|
||||
| [posterResizeMode](#posterresizemode) | All |
|
||||
| [preferredForwardBufferDuration](#preferredforwardbufferduration) | iOS |
|
||||
| [preventsDisplaySleepDuringVideoPlayback](#preventsdisplaysleepduringvideoplayback) | iOS, Android |
|
||||
| [progressUpdateInterval](#progressupdateinterval) | All |
|
||||
| [rate](#rate) | All |
|
||||
| [repeat](#repeat) | All |
|
||||
| [reportBandwidth](#reportbandwidth) | Android |
|
||||
| [resizeMode](#resizemode) | Android, iOS, Windows UWP |
|
||||
| [selectedAudioTrack](#selectedaudiotrack) | Android, iOS |
|
||||
| [selectedTextTrack](#selectedtexttrack) | Android, iOS |
|
||||
| [selectedVideoTrack](#selectedvideotrack) | Android |
|
||||
| [shutterColor](#shutterColor) | Android |
|
||||
| [source](#source) | All |
|
||||
| [subtitleStyle](#subtitlestyle) | Android |
|
||||
| [textTracks](#texttracks) | Android, iOS |
|
||||
| [trackId](#trackid) | Android |
|
||||
| [useTextureView](#usetextureview) | Android |
|
||||
| [useSecureView](#usesecureview) | Android |
|
||||
| [volume](#volume) | All |
|
||||
| [localSourceEncryptionKeyScheme](#localsourceencryptionkeyscheme) | All |
|
||||
|
||||
## Details
|
||||
### `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="
|
||||
```
|
||||
|
||||
Note: On android, you need enable IMA SDK in gradle file, see: [enable client side ads insertion](#enable-client-side-ads-insertion)
|
||||
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `allowsExternalPlayback`
|
||||
Indicates whether the player allows switching to external playback mode such as AirPlay or HDMI.
|
||||
* **true (default)** - allow switching to external playback mode
|
||||
* **false** - Don't allow switching to external playback mode
|
||||
|
||||
Platforms: iOS
|
||||
|
||||
### `audioOnly`
|
||||
Indicates whether the player should only play the audio track and instead of displaying the video track, show the poster instead.
|
||||
* **false (default)** - Display the video as normal
|
||||
* **true** - Show the poster and play the audio
|
||||
|
||||
For this to work, the poster prop must be set.
|
||||
|
||||
Platforms: all
|
||||
|
||||
### `audioOutput`
|
||||
Changes the audio output.
|
||||
* **speaker (default)** - plays through speaker
|
||||
* **earpiece** - plays through earpiece
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `automaticallyWaitsToMinimizeStalling`
|
||||
A Boolean value that indicates whether the player should automatically delay playback in order to minimize stalling. For clients linked against iOS 10.0 and later
|
||||
* **false** - Immediately starts playback
|
||||
* **true (default)** - Delays playback in order to minimize stalling
|
||||
|
||||
Platforms: iOS
|
||||
|
||||
### `backBufferDurationMs`
|
||||
The number of milliseconds of buffer to keep before the current position. This allows rewinding without rebuffering within that duration.
|
||||
|
||||
Platforms: Android
|
||||
|
||||
### `bufferConfig`
|
||||
Adjust the buffer settings. This prop takes an object with one or more of the properties listed below.
|
||||
|
||||
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.
|
||||
maxBufferMs | number | The default maximum duration of media that the player will attempt to buffer, 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.
|
||||
bufferForPlaybackAfterRebufferMs | 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.
|
||||
maxHeapAllocationPercent | number | The percentage of available heap that the video can use to buffer, between 0 and 1
|
||||
minBackBufferMemoryReservePercent | number | The percentage of available app memory at which during startup the back buffer will be disabled, between 0 and 1
|
||||
minBufferMemoryReservePercent | number | The percentage of available app memory to keep in reserve that prevents buffer from using it, between 0 and 1
|
||||
|
||||
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:
|
||||
```javascript
|
||||
bufferConfig={{
|
||||
minBufferMs: 15000,
|
||||
maxBufferMs: 50000,
|
||||
bufferForPlaybackMs: 2500,
|
||||
bufferForPlaybackAfterRebufferMs: 5000
|
||||
}}
|
||||
```
|
||||
|
||||
Platforms: Android
|
||||
|
||||
### `chapters`
|
||||
To provide a custom chapter source for tvOS. This prop takes an array of objects with the properties listed below.
|
||||
|
||||
| Property | Type | Description |
|
||||
|-----------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| title | string | The title of the chapter to create |
|
||||
| startTime | number | The start time of the chapter in seconds |
|
||||
| endTime | number | The end time of the chapter in seconds |
|
||||
| uri | string? | Optional: Provide an http orl or the some base64 string to override the image of the chapter. For some media files the images are generated automatically |
|
||||
|
||||
|
||||
Platforms: tvOS
|
||||
|
||||
### `currentPlaybackTime`
|
||||
When playing an HLS live stream with a `EXT-X-PROGRAM-DATE-TIME` tag configured, then this property will contain the epoch value in msec.
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `controls`
|
||||
Determines whether to show player controls.
|
||||
* **false (default)** - Don't show player controls
|
||||
* **true** - Show player controls
|
||||
|
||||
Note on iOS, controls are always shown when in fullscreen mode.
|
||||
Note on Android, native controls are available by default.
|
||||
If needed, you can also add your controls or use a package like [react-native-video-controls](https://github.com/itsnubix/react-native-video-controls) or [react-native-media-console](https://github.com/criszz77/react-native-media-console), see [Useful Side Project](/projects).
|
||||
|
||||
### `contentStartTime`
|
||||
The start time in ms for SSAI content. This determines at what time to load the video info like resolutions. Use this only when you have SSAI stream where ads resolution is not the same as content resolution.
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `debug`
|
||||
|
||||
Enable more verbosity in logs.
|
||||
|
||||
> [!WARNING]
|
||||
> Do not use this open in production build
|
||||
|
||||
| Property | Type | Description |
|
||||
| ------------------ | ------ | ------------------------------------------------------------------------------------------- |
|
||||
| `enable` | boolean | when true, display logs with verbosity higher |
|
||||
| `thread` | boolean | enable thread display |
|
||||
|
||||
|
||||
Example with default values:
|
||||
```javascript
|
||||
debug={{
|
||||
enable: true,
|
||||
thread: true,
|
||||
}}
|
||||
```
|
||||
Platforms: Android
|
||||
|
||||
|
||||
### `disableFocus`
|
||||
Determines whether video audio should override background music/audio in Android devices.
|
||||
* **false (default)** - Override background audio/music
|
||||
* **true** - Let background audio/music from other apps play
|
||||
|
||||
Note: Allows multiple videos to play if set to `true`. If `false`, when one video is playing and another is started, the first video will be paused.
|
||||
|
||||
Platforms: Android
|
||||
|
||||
### `disableDisconnectError`
|
||||
Determines if the player needs to throw an error when connection is lost or not
|
||||
* **false (default)** - Player will throw an error when connection is lost
|
||||
* **true** - Player will keep trying to buffer when network connect is lost
|
||||
|
||||
Platforms: Android
|
||||
|
||||
### `DRM`
|
||||
To setup DRM please follow [this guide](/component/drm)
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `filter`
|
||||
Add video filter
|
||||
* **FilterType.NONE (default)** - No Filter
|
||||
* **FilterType.INVERT** - CIColorInvert
|
||||
* **FilterType.MONOCHROME** - CIColorMonochrome
|
||||
* **FilterType.POSTERIZE** - CIColorPosterize
|
||||
* **FilterType.FALSE** - CIFalseColor
|
||||
* **FilterType.MAXIMUMCOMPONENT** - CIMaximumComponent
|
||||
* **FilterType.MINIMUMCOMPONENT** - CIMinimumComponent
|
||||
* **FilterType.CHROME** - CIPhotoEffectChrome
|
||||
* **FilterType.FADE** - CIPhotoEffectFade
|
||||
* **FilterType.INSTANT** - CIPhotoEffectInstant
|
||||
* **FilterType.MONO** - CIPhotoEffectMono
|
||||
* **FilterType.NOIR** - CIPhotoEffectNoir
|
||||
* **FilterType.PROCESS** - CIPhotoEffectProcess
|
||||
* **FilterType.TONAL** - CIPhotoEffectTonal
|
||||
* **FilterType.TRANSFER** - CIPhotoEffectTransfer
|
||||
* **FilterType.SEPIA** - CISepiaTone
|
||||
|
||||
For more details on these filters refer to the [iOS docs](https://developer.apple.com/library/archive/documentation/GraphicsImaging/Reference/CoreImageFilterReference/index.html#//apple_ref/doc/uid/TP30000136-SW55).
|
||||
|
||||
Notes:
|
||||
1. Using a filter can impact CPU usage. A workaround is to save the video with the filter and then load the saved video.
|
||||
2. Video filter is currently not supported on HLS playlists.
|
||||
3. `filterEnabled` must be set to `true`
|
||||
|
||||
Platforms: iOS
|
||||
|
||||
### `filterEnabled`
|
||||
Enable video filter.
|
||||
|
||||
* **false (default)** - Don't enable filter
|
||||
* **true** - Enable filter
|
||||
|
||||
Platforms: iOS
|
||||
|
||||
### `Focusable`
|
||||
Whether this video view should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
|
||||
* **false** - Makes view unfocusable
|
||||
* **true (default)** - Makes view focusable
|
||||
|
||||
Platforms: Android
|
||||
|
||||
|
||||
### `fullscreen`
|
||||
Controls whether the player enters fullscreen on play.
|
||||
See [presentFullscreenPlayer](#presentfullscreenplayer) for details.
|
||||
|
||||
* **false (default)** - Don't display the video in fullscreen
|
||||
* **true** - Display the video in fullscreen
|
||||
|
||||
Platforms: iOS, Android
|
||||
|
||||
### `fullscreenAutorotate`
|
||||
If a preferred [fullscreenOrientation](#fullscreenorientation) is set, causes the video to rotate to that orientation but permits rotation of the screen to orientation held by user. Defaults to TRUE.
|
||||
|
||||
Platforms: iOS
|
||||
|
||||
### `fullscreenOrientation`
|
||||
|
||||
* **all (default)** -
|
||||
* **landscape**
|
||||
* **portrait**
|
||||
|
||||
Platforms: iOS
|
||||
|
||||
### `headers`
|
||||
Pass headers to the HTTP client. Can be used for authorization. Headers must be a part of the source object.
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
source={{
|
||||
uri: "https://www.example.com/video.mp4",
|
||||
headers: {
|
||||
Authorization: 'bearer some-token-value',
|
||||
'X-Custom-Header': 'some value'
|
||||
}
|
||||
}}
|
||||
```
|
||||
|
||||
Platforms: Android
|
||||
|
||||
### `hideShutterView`
|
||||
Controls whether the ExoPlayer shutter view (black screen while loading) is enabled.
|
||||
|
||||
* **false (default)** - Show shutter view
|
||||
* **true** - Hide shutter view
|
||||
|
||||
Platforms: Android
|
||||
|
||||
### `ignoreSilentSwitch`
|
||||
Controls the iOS silent switch behavior
|
||||
* **"inherit" (default)** - Use the default AVPlayer behavior
|
||||
* **"ignore"** - Play audio even if the silent switch is set
|
||||
* **"obey"** - Don't play audio if the silent switch is set
|
||||
|
||||
Platforms: iOS
|
||||
|
||||
### `maxBitRate`
|
||||
Sets the desired limit, in bits per second, of network bandwidth consumption when multiple video streams are available for a playlist.
|
||||
|
||||
Default: 0. Don't limit the maxBitRate.
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
maxBitRate={2000000} // 2 megabits
|
||||
```
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `minLoadRetryCount`
|
||||
Sets the minimum number of times to retry loading data before failing and reporting an error to the application. Useful to recover from transient internet failures.
|
||||
|
||||
Default: 3. Retry 3 times.
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
minLoadRetryCount={5} // retry 5 times
|
||||
```
|
||||
|
||||
Platforms: Android
|
||||
|
||||
### `mixWithOthers`
|
||||
Controls how Audio mix with other apps.
|
||||
* **"inherit" (default)** - Use the default AVPlayer behavior
|
||||
* **"mix"** - Audio from this video mixes with audio from other apps.
|
||||
* **"duck"** - Reduces the volume of other apps while audio from this video plays.
|
||||
|
||||
Platforms: iOS
|
||||
|
||||
### `muted`
|
||||
Controls whether the audio is muted
|
||||
* **false (default)** - Don't mute audio
|
||||
* **true** - Mute audio
|
||||
|
||||
Platforms: all
|
||||
|
||||
### `paused`
|
||||
Controls whether the media is paused
|
||||
* **false (default)** - Don't pause the media
|
||||
* **true** - Pause the media
|
||||
|
||||
Platforms: all
|
||||
|
||||
### `pictureInPicture`
|
||||
Determine whether the media should played as picture in picture.
|
||||
* **false (default)** - Don't not play as picture in picture
|
||||
* **true** - Play the media as picture in picture
|
||||
|
||||
NOTE: Video ads cannot start when you are using the PIP on iOS (more info available at [Google IMA SDK Docs](https://developers.google.com/interactive-media-ads/docs/sdks/ios/client-side/picture_in_picture?hl=en#starting_ads)). If you are using custom controls, you must hide your PIP button when you receive the ```STARTED``` event from ```onReceiveAdEvent``` and show it again when you receive the ```ALL_ADS_COMPLETED``` event.
|
||||
|
||||
Platforms: iOS
|
||||
|
||||
### `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
|
||||
|
||||
To use this feature on iOS, you must:
|
||||
* [Enable Background Audio](https://developer.apple.com/library/archive/documentation/Audio/Conceptual/AudioSessionProgrammingGuide/AudioSessionBasics/AudioSessionBasics.html#//apple_ref/doc/uid/TP40007875-CH3-SW3) in your Xcode project
|
||||
* Set the ignoreSilentSwitch prop to "ignore"
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `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/"
|
||||
|
||||
Platforms: all
|
||||
|
||||
### `posterResizeMode`
|
||||
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).
|
||||
* **"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).
|
||||
* **"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.
|
||||
|
||||
Platforms: all
|
||||
|
||||
### `preferredForwardBufferDuration`
|
||||
The duration the player should buffer media from the network ahead of the playhead to guard against playback disruption. Sets the [preferredForwardBufferDuration](https://developer.apple.com/documentation/avfoundation/avplayeritem/1643630-preferredforwardbufferduration) instance property on AVPlayerItem.
|
||||
|
||||
Default: 0
|
||||
|
||||
Platforms: iOS
|
||||
|
||||
### `preventsDisplaySleepDuringVideoPlayback`
|
||||
Controls whether or not the display should be allowed to sleep while playing the video. Default is not to allow display to sleep.
|
||||
|
||||
Default: true
|
||||
|
||||
Platforms: iOS, Android
|
||||
|
||||
### `progressUpdateInterval`
|
||||
Delay in milliseconds between onProgress events in milliseconds.
|
||||
|
||||
Default: 250.0
|
||||
|
||||
Platforms: all
|
||||
|
||||
### `rate`
|
||||
Speed at which the media should play.
|
||||
* **0.0** - Pauses the video
|
||||
* **1.0** - Play at normal speed
|
||||
* **Other values** - Slow down or speed up playback
|
||||
|
||||
Platforms: all
|
||||
|
||||
### `repeat`
|
||||
Determine whether to repeat the video when the end is reached
|
||||
* **false (default)** - Don't repeat the video
|
||||
* **true** - Repeat the video
|
||||
|
||||
Platforms: all
|
||||
|
||||
|
||||
### `onAudioTracks`
|
||||
Callback function that is called when audio tracks change
|
||||
|
||||
Payload:
|
||||
|
||||
Property | Type | Description
|
||||
--- | --- | ---
|
||||
index | number | Internal track ID
|
||||
title | string | Descriptive name for the track
|
||||
language | string | 2 letter [ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) representing the language
|
||||
bitrate | number | bitrate of track
|
||||
type | string | Mime type of track
|
||||
selected | boolean | true if track is playing
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
{
|
||||
audioTracks: [
|
||||
{ language: 'es', title: 'Spanish', type: 'audio/mpeg', index: 0, selected: true },
|
||||
{ language: 'en', title: 'English', type: 'audio/mpeg', index: 1 }
|
||||
],
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
Platforms: Android
|
||||
|
||||
### `reportBandwidth`
|
||||
Determine whether to generate onBandwidthUpdate events. This is needed due to the high frequency of these events on ExoPlayer.
|
||||
|
||||
* **false (default)** - Don't generate onBandwidthUpdate events
|
||||
* **true** - Generate onBandwidthUpdate events
|
||||
|
||||
Platforms: Android
|
||||
|
||||
### `resizeMode`
|
||||
Determines how to resize the video when the frame doesn't match the raw video dimensions.
|
||||
* **"none" (default)** - Don't apply resize
|
||||
* **"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 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).
|
||||
* **"stretch"** - Scale width and height independently, This may change the aspect ratio of the src.
|
||||
|
||||
Platforms: Android, iOS, Windows UWP
|
||||
|
||||
### `selectedAudioTrack`
|
||||
Configure which audio track, if any, is played.
|
||||
|
||||
```javascript
|
||||
selectedAudioTrack={{
|
||||
type: Type,
|
||||
value: Value
|
||||
}}
|
||||
```
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
selectedAudioTrack={{
|
||||
type: "title",
|
||||
value: "Dubbing"
|
||||
}}
|
||||
```
|
||||
|
||||
Type | Value | Description
|
||||
--- | --- | ---
|
||||
"system" (default) | N/A | Play the audio track that matches the system language. If none match, play the first track.
|
||||
"disabled" | N/A | Turn off audio
|
||||
"title" | string | Play the audio track with the title specified as the Value, e.g. "French"
|
||||
"language" | string | Play the audio track with the language specified as the Value, e.g. "fr"
|
||||
"index" | number | Play the audio track with the index specified as the value, e.g. 0
|
||||
|
||||
If a track matching the specified Type (and Value if appropriate) is unavailable, the first audio track will be played. If multiple tracks match the criteria, the first match will be used.
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `selectedTextTrack`
|
||||
Configure which text track (caption or subtitle), if any, is shown.
|
||||
|
||||
```javascript
|
||||
selectedTextTrack={{
|
||||
type: Type,
|
||||
value: Value
|
||||
}}
|
||||
```
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
selectedTextTrack={{
|
||||
type: "title",
|
||||
value: "English Subtitles"
|
||||
}}
|
||||
```
|
||||
|
||||
Type | Value | Description
|
||||
--- | --- | ---
|
||||
"system" (default) | N/A | Display captions only if the system preference for captions is enabled
|
||||
"disabled" | N/A | Don't display a text track
|
||||
"title" | string | Display the text track with the title specified as the Value, e.g. "French 1"
|
||||
"language" | string | Display the text track with the language specified as the Value, e.g. "fr"
|
||||
"index" | number | Display the text track with the index specified as the value, e.g. 0
|
||||
|
||||
Both iOS & Android (only 4.4 and higher) offer Settings to enable Captions for hearing impaired people. If "system" is selected and the Captions Setting is enabled, iOS/Android will look for a caption that matches that customer's language and display it.
|
||||
|
||||
If a track matching the specified Type (and Value if appropriate) is unavailable, no text track will be displayed. If multiple tracks match the criteria, the first match will be used.
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `selectedVideoTrack`
|
||||
Configure which video track should be played. By default, the player uses Adaptive Bitrate Streaming to automatically select the stream it thinks will perform best based on available bandwidth.
|
||||
|
||||
```javascript
|
||||
selectedVideoTrack={{
|
||||
type: Type,
|
||||
value: Value
|
||||
}}
|
||||
```
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
selectedVideoTrack={{
|
||||
type: "resolution",
|
||||
value: 480
|
||||
}}
|
||||
```
|
||||
|
||||
Type | Value | Description
|
||||
--- | --- | ---
|
||||
"auto" (default) | N/A | Let the player determine which track to play using ABR
|
||||
"disabled" | N/A | Turn off video
|
||||
"resolution" | number | Play the video track with the height specified, e.g. 480 for the 480p stream
|
||||
"index" | number | Play the video track with the index specified as the value, e.g. 0
|
||||
|
||||
If a track matching the specified Type (and Value if appropriate) is unavailable, ABR will be used.
|
||||
|
||||
Platforms: Android
|
||||
|
||||
### `shutterColor`
|
||||
Apply color to shutter view, if you see black flashes before video start then set
|
||||
|
||||
```javascript
|
||||
shutterColor='transparent'
|
||||
```
|
||||
|
||||
- black (default)
|
||||
|
||||
Platforms: Android
|
||||
|
||||
### `source`
|
||||
Sets the media source. You can pass an asset loaded via require or an object with a uri.
|
||||
|
||||
Setting the source will trigger the player to attempt to load the provided media with all other given props. Please be sure that all props are provided before/at the same time as setting the source.
|
||||
|
||||
Rendering the player component with a null source will init the player, and start playing once a source value is provided.
|
||||
|
||||
Providing a null source value after loading a previous source will stop playback, and clear out the previous source content.
|
||||
|
||||
The docs for this prop are incomplete and will be updated as each option is investigated and tested.
|
||||
|
||||
|
||||
#### Asset loaded via require
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
const sintel = require('./sintel.mp4');
|
||||
|
||||
source={sintel}
|
||||
```
|
||||
|
||||
#### URI string
|
||||
|
||||
A number of URI schemes are supported by passing an object with a `uri` attribute.
|
||||
|
||||
##### Web address (http://, https://)
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
source={{uri: 'https://www.sample-videos.com/video/mp4/720/big_buck_bunny_720p_10mb.mp4' }}
|
||||
```
|
||||
|
||||
Platforms: all
|
||||
|
||||
##### File path (file://)
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
source={{ uri: 'file:///sdcard/Movies/sintel.mp4' }}
|
||||
```
|
||||
|
||||
Note: Your app will need to request permission to read external storage if you're accessing a file outside your app.
|
||||
|
||||
Platforms: Android, possibly others
|
||||
|
||||
##### iPod Library (ipod-library://)
|
||||
|
||||
Path to a sound file in your iTunes library. Typically shared from iTunes to your app.
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
source={{ uri: 'ipod-library:///path/to/music.mp3' }}
|
||||
```
|
||||
|
||||
Note: Using this feature adding an entry for NSAppleMusicUsageDescription to your Info.plist file as described [here](https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html)
|
||||
|
||||
Platforms: iOS
|
||||
|
||||
##### Explicit mimetype for the stream
|
||||
|
||||
Provide a member `type` with value (`mpd`/`m3u8`/`ism`) inside the source object.
|
||||
Sometimes is needed when URL extension does not match with the mimetype that you are expecting, as seen on the next example. (Extension is .ism -smooth streaming- but file served is on format mpd -mpeg dash-)
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
source={{ uri: 'http://host-serving-a-type-different-than-the-extension.ism/manifest(format=mpd-time-csf)',
|
||||
type: 'mpd' }}
|
||||
```
|
||||
|
||||
##### Other protocols
|
||||
|
||||
The following other types are supported on some platforms, but aren't fully documented yet:
|
||||
`content://, ms-appx://, ms-appdata://, assets-library://`
|
||||
|
||||
|
||||
#### Playing only a portion of the video (start & end time)
|
||||
|
||||
Provide an optional `startTime` and/or `endTime` for the video. Value is in milliseconds. Useful when you want to play only a portion of a large video.
|
||||
|
||||
Example
|
||||
```javascript
|
||||
source={{ uri: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8', startTime: 36012, endTime: 48500 }}
|
||||
|
||||
source={{ uri: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8', startTime: 36012 }}
|
||||
|
||||
source={{ uri: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8', endTime: 48500 }}
|
||||
```
|
||||
|
||||
Platforms: iOS, Android
|
||||
|
||||
#### Overriding the metadata of a source
|
||||
|
||||
Provide an optional `title`, `subtitle`, `customImageUri` and/or `description` properties for the video.
|
||||
Useful when to adapt the tvOS playback experience.
|
||||
|
||||
Example:
|
||||
|
||||
```javascript
|
||||
source={{
|
||||
uri: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8',
|
||||
title: 'Custom Title',
|
||||
subtitle: 'Custom Subtitle',
|
||||
description: 'Custom Description',
|
||||
customImageUri: 'https://pbs.twimg.com/profile_images/1498641868397191170/6qW2XkuI_400x400.png'
|
||||
}}
|
||||
```
|
||||
|
||||
Platforms: tvOS
|
||||
|
||||
### `subtitleStyle`
|
||||
|
||||
Property | Description | Platforms
|
||||
--- | --- | ---
|
||||
fontSize | Adjust the font size of the subtitles. Default: font size of the device | Android
|
||||
paddingTop | Adjust the top padding of the subtitles. Default: 0| Android
|
||||
paddingBottom | Adjust the bottom padding of the subtitles. Default: 0| Android
|
||||
paddingLeft | Adjust the left padding of the subtitles. Default: 0| Android
|
||||
paddingRight | Adjust the right padding of the subtitles. Default: 0| Android
|
||||
|
||||
|
||||
Example:
|
||||
|
||||
```javascript
|
||||
subtitleStyle={{ paddingBottom: 50, fontSize: 20 }}
|
||||
```
|
||||
|
||||
### `textTracks`
|
||||
Load one or more "sidecar" text tracks. This takes an array of objects representing each track. Each object should have the format:
|
||||
|
||||
Property | Description
|
||||
--- | ---
|
||||
title | Descriptive name for the track
|
||||
language | 2 letter [ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) representing the language
|
||||
type | Mime type of the track<br> * TextTrackType.SRT - SubRip (.srt)<br> * TextTrackType.TTML - TTML (.ttml)<br> * TextTrackType.VTT - WebVTT (.vtt)<br>iOS only supports VTT, Android supports all 3
|
||||
uri | URL for the text track. Currently, only tracks hosted on a webserver are supported
|
||||
|
||||
On iOS, sidecar text tracks are only supported for individual files, not HLS playlists. For HLS, you should include the text tracks as part of the playlist.
|
||||
|
||||
Note: Due to iOS limitations, sidecar text tracks are not compatible with Airplay. If textTracks are specified, AirPlay support will be automatically disabled.
|
||||
|
||||
Example:
|
||||
```javascript
|
||||
import { TextTrackType }, Video from 'react-native-video';
|
||||
|
||||
textTracks={[
|
||||
{
|
||||
title: "English CC",
|
||||
language: "en",
|
||||
type: TextTrackType.VTT, // "text/vtt"
|
||||
uri: "https://bitdash-a.akamaihd.net/content/sintel/subtitles/subtitles_en.vtt"
|
||||
},
|
||||
{
|
||||
title: "Spanish Subtitles",
|
||||
language: "es",
|
||||
type: TextTrackType.SRT, // "application/x-subrip"
|
||||
uri: "https://durian.blender.org/wp-content/content/subtitles/sintel_es.srt"
|
||||
}
|
||||
]}
|
||||
```
|
||||
|
||||
|
||||
Platforms: Android, iOS
|
||||
|
||||
### `trackId`
|
||||
Configure an identifier for the video stream to link the playback context to the events emitted.
|
||||
|
||||
Platforms: Android
|
||||
|
||||
### `useTextureView`
|
||||
Controls whether to output to a TextureView or SurfaceView.
|
||||
|
||||
SurfaceView is more efficient and provides better performance but has two limitations:
|
||||
* It can't be animated, transformed or scaled
|
||||
* You can't overlay multiple SurfaceViews
|
||||
|
||||
useTextureView can only be set at same time you're setting the source.
|
||||
|
||||
* **true (default)** - Use a TextureView
|
||||
* **false** - Use a SurfaceView
|
||||
|
||||
Platforms: Android
|
||||
|
||||
### `useSecureView`
|
||||
Force the output to a SurfaceView and enables the secure surface.
|
||||
|
||||
This will override useTextureView flag.
|
||||
|
||||
SurfaceView is is the only one that can be labeled as secure.
|
||||
|
||||
* **true** - Use security
|
||||
* **false (default)** - Do not use security
|
||||
|
||||
Platforms: Android
|
||||
|
||||
### `volume`
|
||||
Adjust the volume.
|
||||
* **1.0 (default)** - Play at full volume
|
||||
* **0.0** - Mute the audio
|
||||
* **Other values** - Reduce volume
|
||||
|
||||
Platforms: all
|
||||
|
||||
### `localSourceEncryptionKeyScheme`
|
||||
Set the url scheme for stream encryption key for local assets
|
||||
|
||||
Type: String
|
||||
|
||||
Example:
|
||||
```
|
||||
localSourceEncryptionKeyScheme="my-offline-key"
|
||||
```
|
||||
|
||||
Platforms: iOS
|
||||
77
docs/pages/index.md
Normal file
77
docs/pages/index.md
Normal file
@ -0,0 +1,77 @@
|
||||
# A `<Video>` component for React Native
|
||||
|
||||
## About
|
||||
`react-native-video` is a React Native library that provides a Video component that renders media content such as videos and streams
|
||||
|
||||
## Alpha Information
|
||||
> ⚠️ **Version 6 Alpha**: The following documentation may refer to features only available through the v6.0.0 alpha releases, [please see version 5.2.x](https://github.com/react-native-video/react-native-video/blob/v5.2.0/README.md) for the current documentation!
|
||||
|
||||
Version 6.x recommends react-native >= 0.68.2.
|
||||
|
||||
For older versions of react-native, [please use version 5.x](https://github.com/react-native-video/react-native-video/tree/v5.2.0).
|
||||
|
||||
## Usage
|
||||
|
||||
```javascript
|
||||
// Load the module
|
||||
|
||||
import Video, {VideoRef} from 'react-native-video';
|
||||
|
||||
// Within your render function, assuming you have a file called
|
||||
// "background.mp4" in your project. You can include multiple videos
|
||||
// on a single screen if you like.
|
||||
|
||||
const VideoPlayer = () => {
|
||||
const videoRef = useRef<VideoRef>(null);
|
||||
const background = require('./background.mp4');
|
||||
|
||||
return (
|
||||
<Video
|
||||
// Can be a URL or a local file.
|
||||
source={background}
|
||||
// Store reference
|
||||
ref={videoRef}
|
||||
// Callback when remote video is buffering
|
||||
onBuffer={onBuffer}
|
||||
// Callback when video cannot be loaded
|
||||
onError={onError}
|
||||
style={styles.backgroundVideo}
|
||||
/>
|
||||
)
|
||||
}
|
||||
|
||||
// Later on in your styles..
|
||||
var styles = StyleSheet.create({
|
||||
backgroundVideo: {
|
||||
position: 'absolute',
|
||||
top: 0,
|
||||
left: 0,
|
||||
bottom: 0,
|
||||
right: 0,
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
### Version 6.0.0 breaking changes
|
||||
|
||||
Version 6.0.0 is introducing dozens of breaking changes, mostly through updated dependencies and significant refactoring. While the API remains compatible, the significant internal changes require full testing with your app to ensure all functionality remains operational. Please view the [Changelog](CHANGELOG.md) for specific breaking changes.
|
||||
|
||||
### Installing Version 6.0.0 Alphas
|
||||
|
||||
Whilst we finalise version 6.0.0 you can install the latest alpha from npm
|
||||
|
||||
Using npm:
|
||||
|
||||
```bash
|
||||
|
||||
npm install --save react-native-video@alpha
|
||||
|
||||
```
|
||||
|
||||
using yarn:
|
||||
|
||||
```bash
|
||||
|
||||
yarn add react-native-video@alpha
|
||||
|
||||
```
|
||||
247
docs/pages/installation.md
Normal file
247
docs/pages/installation.md
Normal file
@ -0,0 +1,247 @@
|
||||
|
||||
|
||||
# Installation
|
||||
Using npm:
|
||||
|
||||
```shell
|
||||
npm install --save react-native-video
|
||||
```
|
||||
|
||||
or using yarn:
|
||||
|
||||
```shell
|
||||
yarn add react-native-video
|
||||
```
|
||||
|
||||
Then follow the instructions for your platform to link react-native-video into your project
|
||||
|
||||
# Specific platform installation
|
||||
<details>
|
||||
<summary>iOS</summary>
|
||||
|
||||
## iOS
|
||||
|
||||
### Standard Method
|
||||
|
||||
**React Native 0.60 and above**
|
||||
|
||||
Run `npx pod-install`. Linking is not required in React Native 0.60 and above.
|
||||
|
||||
**React Native 0.59 and below**
|
||||
|
||||
Run `react-native link react-native-video` to link the react-native-video library.
|
||||
|
||||
### Enable Static Linking for dependencies in your ios project Podfile
|
||||
|
||||
Add `use_frameworks! :linkage => :static` just under `platform :ios` in your ios project Podfile.
|
||||
|
||||
[See the example ios project for reference](examples/basic/ios/Podfile#L5)
|
||||
|
||||
### Using CocoaPods (required to enable caching)
|
||||
|
||||
Setup your Podfile like it is described in the [react-native documentation](https://facebook.github.io/react-native/docs/integration-with-existing-apps#configuring-cocoapods-dependencies).
|
||||
|
||||
Depending on your requirements you have to choose between the two possible subpodspecs:
|
||||
|
||||
Video only:
|
||||
|
||||
```diff
|
||||
pod 'Folly', :podspec => '../node_modules/react-native/third-party-podspecs/Folly.podspec'
|
||||
+ `pod 'react-native-video', :path => '../node_modules/react-native-video/react-native-video.podspec'`
|
||||
end
|
||||
```
|
||||
|
||||
Video with caching ([more info](docs/caching.md)):
|
||||
|
||||
```diff
|
||||
pod 'Folly', :podspec => '../node_modules/react-native/third-party-podspecs/Folly.podspec'
|
||||
+ `pod 'react-native-video/VideoCaching', :path => '../node_modules/react-native-video/react-native-video.podspec'`
|
||||
end
|
||||
```
|
||||
### Enable custom feature in podfile file
|
||||
|
||||
#### Google IMA
|
||||
|
||||
Google IMA is the google SDK to support Client Side Ads Integration (CSAI), see [google documentation](https://developers.google.com/interactive-media-ads/docs/sdks/ios/client-side) for more information.
|
||||
|
||||
To enable google IMA usage define add following line in your podfile:
|
||||
```podfile
|
||||
$RNVideoUseGoogleIMA=true
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Android</summary>
|
||||
|
||||
## Android
|
||||
|
||||
### Autolinking
|
||||
|
||||
Linking is not required in React Native 0.60 and above.
|
||||
|
||||
If your project is using React Native < 0.60, run `react-native link react-native-video` to link the react-native-video library.
|
||||
|
||||
If you have trouble, make the following additions to the given files manually:
|
||||
|
||||
`android/settings.gradle`
|
||||
|
||||
Add player source in build configuration
|
||||
|
||||
```gradle
|
||||
include ':react-native-video'
|
||||
project(':react-native-video').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-video/android')
|
||||
```
|
||||
|
||||
`android/app/build.gradle`
|
||||
|
||||
From version >= 5.0.0, you have to apply these changes:
|
||||
|
||||
```diff
|
||||
dependencies {
|
||||
...
|
||||
compile project(':react-native-video')
|
||||
+ implementation "androidx.appcompat:appcompat:1.0.0"
|
||||
- implementation "com.android.support:appcompat-v7:${rootProject.ext.supportLibVersion}"
|
||||
|
||||
}
|
||||
```
|
||||
|
||||
`android/gradle.properties`
|
||||
|
||||
Migrating to AndroidX (needs version >= 5.0.0):
|
||||
|
||||
```gradle.properties
|
||||
android.useAndroidX=true
|
||||
android.enableJetifier=true
|
||||
```
|
||||
|
||||
`MainApplication.java`
|
||||
|
||||
If using com.facebook.react.PackageList to auto import native dependencies, there are no updates required here. Please see the [android example project](https://github.com/react-native-video/react-native-video/tree/master/examples/basic/android/app/src/main/java/com/videoplayer/MainApplication.java) for more details.
|
||||
|
||||
### For manual linking
|
||||
|
||||
On top, where imports are:
|
||||
|
||||
```java
|
||||
import com.brentvatne.react.ReactVideoPackage;
|
||||
```
|
||||
|
||||
Add the `ReactVideoPackage` class to your list of exported packages.
|
||||
|
||||
```java
|
||||
@Override
|
||||
protected List<ReactPackage> getPackages() {
|
||||
return Arrays.asList(
|
||||
new MainReactPackage(),
|
||||
new ReactVideoPackage()
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### Enable custom feature in gradle file
|
||||
|
||||
#### Enable client side ads insertion
|
||||
To enable client side ads insertion CSAI with google IMA SDK, you need to enable it in your gradle file.
|
||||
|
||||
```gradle
|
||||
buildscript {
|
||||
ext {
|
||||
...
|
||||
RNVUseExoplayerIMA = true
|
||||
...
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Windows</summary>
|
||||
|
||||
## Windows
|
||||
|
||||
### Autolinking
|
||||
|
||||
**React Native Windows 0.63 and above**
|
||||
|
||||
Autolinking should automatically add react-native-video to your app.
|
||||
|
||||
### Manual Linking
|
||||
|
||||
**React Native Windows 0.62**
|
||||
|
||||
Make the following additions to the given files manually:
|
||||
|
||||
`windows\myapp.sln`
|
||||
|
||||
Add the _ReactNativeVideoCPP_ project to your solution (eg. `windows\myapp.sln`):
|
||||
|
||||
1. Open your solution in Visual Studio 2019
|
||||
2. Right-click Solution icon in Solution Explorer > Add > Existing Project...
|
||||
3. Select `node_modules\react-native-video\windows\ReactNativeVideoCPP\ReactNativeVideoCPP.vcxproj`
|
||||
|
||||
`windows\myapp\myapp.vcxproj`
|
||||
|
||||
Add a reference to _ReactNativeVideoCPP_ to your main application project (eg. `windows\myapp\myapp.vcxproj`):
|
||||
|
||||
1. Open your solution in Visual Studio 2019
|
||||
2. Right-click main application project > Add > Reference...
|
||||
3. Check _ReactNativeVideoCPP_ from Solution Projects
|
||||
|
||||
`pch.h`
|
||||
|
||||
Add `#include "winrt/ReactNativeVideoCPP.h"`.
|
||||
|
||||
`app.cpp`
|
||||
|
||||
Add `PackageProviders().Append(winrt::ReactNativeVideoCPP::ReactPackageProvider());` before `InitializeComponent();`.
|
||||
|
||||
**React Native Windows 0.61 and below**
|
||||
|
||||
Follow the manual linking instructions for React Native Windows 0.62 above, but substitute _ReactNativeVideoCPP61_ for _ReactNativeVideoCPP_.
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>tvOS</summary>
|
||||
|
||||
## tvOS
|
||||
|
||||
`react-native link react-native-video` doesn’t work properly with the tvOS target so we need to add the library manually.
|
||||
|
||||
First select your project in Xcode.
|
||||
|
||||
|
||||
|
||||
After that, select the tvOS target of your application and select « General » tab
|
||||
|
||||
|
||||
|
||||
Scroll to « Linked Frameworks and Libraries » and tap on the + button
|
||||
|
||||
|
||||
|
||||
Select RCTVideo-tvOS
|
||||
|
||||
|
||||
</details>
|
||||
</details>
|
||||
|
||||
## Examples
|
||||
|
||||
Run `yarn xbasic install` in the root directory before running any of the examples.
|
||||
|
||||
### iOS Example
|
||||
```bash
|
||||
yarn xbasic ios
|
||||
```
|
||||
|
||||
### Android Example
|
||||
```bash
|
||||
yarn xbasic android
|
||||
```
|
||||
|
||||
### Windows Example
|
||||
```bash
|
||||
yarn xbasic windows
|
||||
```
|
||||
|
||||
5
docs/pages/other/_meta.json
Normal file
5
docs/pages/other/_meta.json
Normal file
@ -0,0 +1,5 @@
|
||||
{
|
||||
"caching": "Caching",
|
||||
"misc": "Misc",
|
||||
"debug": "Debugging"
|
||||
}
|
||||
@ -2,21 +2,21 @@
|
||||
|
||||
Caching is currently only supported on `iOS` platforms with a CocoaPods setup.
|
||||
|
||||
# Technology
|
||||
## Technology
|
||||
|
||||
The cache is backed by [SPTPersistentCache](https://github.com/spotify/SPTPersistentCache) and [DVAssetLoaderDelegate](https://github.com/vdugnist/DVAssetLoaderDelegate).
|
||||
|
||||
# How Does It Work
|
||||
## How Does It Work
|
||||
|
||||
The caching is based on the url of the asset.
|
||||
SPTPersistentCache is a LRU ([Least Recently Used](https://en.wikipedia.org/wiki/Cache_replacement_policies#Least_recently_used_(LRU))) cache.
|
||||
|
||||
# Restrictions
|
||||
## Restrictions
|
||||
|
||||
Currently, caching is only supported for URLs that end in a `.mp4`, `.m4v`, or `.mov` extension. In future versions, URLs that end in a query string (e.g. test.mp4?resolution=480p) will be support once dependencies allow access to the `Content-Type` header. At this time, HLS playlists (.m3u8) and videos that sideload text tracks are not supported and will bypass the cache.
|
||||
|
||||
You will also receive warnings in the Xcode logs by using the `debug` mode. So if you are not 100% sure if your video is cached, check your Xcode logs!
|
||||
|
||||
By default files expire after 30 days and the maxmimum cache size is 100mb.
|
||||
By default files expire after 30 days and the maximum cache size is 100mb.
|
||||
|
||||
In a future release the cache might have more configurable options.
|
||||
In a future release the cache might have more configurable options.
|
||||
@ -1,18 +1,18 @@
|
||||
# Advanced debuging and common issues
|
||||
# Debugging
|
||||
|
||||
### HTTP playback doesn't work or Black Screen on Release build (Android)
|
||||
## HTTP playback doesn't work or Black Screen on Release build (Android)
|
||||
If your video work on Debug mode, but on Release you see only black screen, please, check the link to your video. If you use 'http' protocol there, you will need to add next string to your AndroidManifest.xml file. [Details here](https://developer.android.com/guide/topics/manifest/application-element#usesCleartextTraffic)
|
||||
|
||||
```
|
||||
```xml
|
||||
<application
|
||||
...
|
||||
android:usesCleartextTraffic="true"
|
||||
>
|
||||
```
|
||||
|
||||
### Decoder Issue (Android)
|
||||
## Decoder Issue (Android)
|
||||
|
||||
Devices have a maximum of simulataneous possible playback. It means you have reach this limit. Exoplayer returns: 'Unable to instantiate decoder'
|
||||
Devices have a maximum of simultaneous possible playback. It means you have reach this limit. Exoplayer returns: 'Unable to instantiate decoder'
|
||||
|
||||
**known issue**: This issue happen really often in debug mode.
|
||||
|
||||
@ -20,28 +20,28 @@ Devices have a maximum of simulataneous possible playback. It means you have rea
|
||||
|
||||
Here are the steps to consider before opening a ticket in issue tracker
|
||||
|
||||
### Check you can access to remote file
|
||||
## Check you can access to remote file
|
||||
|
||||
Ensure you can download to manifest / content file with a browser for exemple
|
||||
Ensure you can download to manifest / content file with a browser for example
|
||||
|
||||
### Check another player can read the content
|
||||
## Check another player can read the content
|
||||
|
||||
Usually clear playback can be read with all Video player. Then you should ensure content can be played without any issue with another player ([VideoLan/VLC](https://www.videolan.org/vlc/) is a good reference implementation)
|
||||
|
||||
## You cannot play protected content (all OS)
|
||||
|
||||
### Protected content gives error (token error / access forbidden)
|
||||
## Protected content gives error (token error / access forbidden)
|
||||
|
||||
If content is protected with an access token or any other http header, ensure you can access to you data with a wget call or a rest client app. You need to provide all needed access token / authentication parameters.
|
||||
|
||||
### Everything seems correct but content cannot be accessed
|
||||
## Everything seems correct but content cannot be accessed
|
||||
|
||||
You need to record network trace to ensure communications with server is correct.
|
||||
[Charles proxy](https://www.charlesproxy.com/) is a simple and usefull tool to sniff all http/https calls.
|
||||
With this tool you should be able to analyze what is going on with network. You will see all access to content and DRM, audio / vido chuncks, ...
|
||||
[Charles proxy](https://www.charlesproxy.com/) is a simple and useful tool to sniff all http/https calls.
|
||||
With this tool you should be able to analyze what is going on with network. You will see all access to content and DRM, audio / video chunks, ...
|
||||
|
||||
Then try to compare exchanges with previous tests you made.
|
||||
|
||||
### It's still not working
|
||||
## It's still not working
|
||||
|
||||
You can try to open a ticket now !
|
||||
78
docs/pages/other/misc.md
Normal file
78
docs/pages/other/misc.md
Normal file
@ -0,0 +1,78 @@
|
||||
# Miscellaneous
|
||||
|
||||
## iOS App Transport Security
|
||||
|
||||
- By default, iOS will only load encrypted (https) urls. If you want to load content from an unencrypted (http) source, you will need to modify your Info.plist file and add the following entry:
|
||||
|
||||
|
||||
|
||||
For more detailed info check this [article](https://cocoacasts.com/how-to-add-app-transport-security-exception-domains)
|
||||
</details>
|
||||
|
||||
## Audio Mixing
|
||||
|
||||
At some point in the future, react-native-video will include an Audio Manager for configuring how videos mix with other apps playing sounds on the device.
|
||||
|
||||
On iOS, if you would like to allow other apps to play music over your video component, make the following change:
|
||||
|
||||
**AppDelegate.m**
|
||||
|
||||
```objective-c
|
||||
#import <AVFoundation/AVFoundation.h> // import
|
||||
|
||||
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
|
||||
{
|
||||
...
|
||||
[[AVAudioSession sharedInstance] setCategory:AVAudioSessionCategoryAmbient error:nil]; // allow
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
You can also use the [ignoreSilentSwitch](#ignoresilentswitch) prop.
|
||||
</details>
|
||||
|
||||
## Android Expansion File Usage
|
||||
Expansions files allow you to ship assets that exceed the 100MB apk size limit and don't need to be updated each time you push an app update.
|
||||
|
||||
This only supports mp4 files and they must not be compressed. Example command line for preventing compression:
|
||||
```bash
|
||||
zip -r -n .mp4 *.mp4 player.video.example.com
|
||||
```
|
||||
|
||||
```javascript
|
||||
// Within your render function, assuming you have a file called
|
||||
// "background.mp4" in your expansion file. Just add your main and (if applicable) patch version
|
||||
<Video source={{uri: "background", mainVer: 1, patchVer: 0}} // Looks for .mp4 file (background.mp4) in the given expansion version.
|
||||
resizeMode="cover" // Fill the whole screen at aspect ratio.
|
||||
style={styles.backgroundVideo} />
|
||||
```
|
||||
|
||||
## Load files with the RN Asset System
|
||||
|
||||
The asset system [introduced in RN `0.14`](http://www.reactnative.com/react-native-v0-14-0-released/) allows loading image resources shared across iOS and Android without touching native code. As of RN `0.31` [the same is true](https://github.com/facebook/react-native/commit/91ff6868a554c4930fd5fda6ba8044dbd56c8374) of mp4 video assets for Android. As of [RN `0.33`](https://github.com/facebook/react-native/releases/tag/v0.33.0) iOS is also supported. Requires `react-native-video@0.9.0`.
|
||||
|
||||
```javascript
|
||||
<Video
|
||||
source={require('../assets/video/turntable.mp4')}
|
||||
/>
|
||||
```
|
||||
|
||||
## Play in background on iOS
|
||||
|
||||
To enable audio to play in background on iOS the audio session needs to be set to `AVAudioSessionCategoryPlayback`. See [Apple documentation][3] for additional details. (NOTE: there is now a ticket to [expose this as a prop]( https://github.com/react-native-community/react-native-video/issues/310) )
|
||||
|
||||
## Examples
|
||||
|
||||
- See an [Example integration][1] in `react-native-login` *note that this example uses an older version of this library, before we used `export default` -- if you use `require` you will need to do `require('react-native-video').default` as per instructions above.*
|
||||
- Try the included [VideoPlayer example][2] yourself:
|
||||
|
||||
```sh
|
||||
git clone git@github.com:react-native-community/react-native-video.git
|
||||
cd react-native-video/example
|
||||
npm install
|
||||
open ios/VideoPlayer.xcodeproj
|
||||
```
|
||||
|
||||
Then `Cmd+R` to start the React Packager, build and run the project in the simulator.
|
||||
|
||||
- [Lumpen Radio](https://github.com/jhabdas/lumpen-radio) contains another example integration using local files and full screen background video.
|
||||
@ -1,9 +1,11 @@
|
||||
This page links other open source projects which can be usefull for your player implementation
|
||||
# Useful projects
|
||||
This page links other open source projects which can be useful for your player implementation. <br>
|
||||
If you have a project which can be useful for other users, feel free to open a PR to add it here.
|
||||
|
||||
# UI over react-native-video
|
||||
## UI over react-native-video
|
||||
- [react-native-video-controls](https://github.com/itsnubix/react-native-video-controls): First reference player UI
|
||||
- [react-native-media-console](https://github.com/criszz77/react-native-media-console): React-native-video-controls updated and rewritten in typescript
|
||||
- [react-native-corner-video](https://github.com/Lg0gs/react-native-corner-video): A floating video player
|
||||
|
||||
# Other tools
|
||||
## Other tools
|
||||
- [react-native-music-control](https://github.com/tanguyantoine/react-native-music-control): A toolbox to control player over media session
|
||||
107
docs/pages/updating.md
Normal file
107
docs/pages/updating.md
Normal file
@ -0,0 +1,107 @@
|
||||
# Updating
|
||||
|
||||
### Version 6.0.0
|
||||
|
||||
#### iOS
|
||||
|
||||
In your project Podfile add support for static dependency linking. This is required to support the new Promises subdependency in the iOS swift conversion.
|
||||
|
||||
Add `use_frameworks! :linkage => :static` just under `platform :ios` in your ios project Podfile.
|
||||
|
||||
[See the example ios project for reference](examples/basic/ios/Podfile#L5)
|
||||
|
||||
### Version 5.0.0
|
||||
|
||||
Probably you want to update your gradle version:
|
||||
#### gradle-wrapper.properties
|
||||
```diff
|
||||
- distributionUrl=https\://services.gradle.org/distributions/gradle-3.3-all.zip
|
||||
+ distributionUrl=https\://services.gradle.org/distributions/gradle-5.1.1-all.zip
|
||||
```
|
||||
|
||||
#### **android/app/build.gradle**
|
||||
|
||||
From version >= 5.0.0, you have to apply this changes:
|
||||
|
||||
```diff
|
||||
dependencies {
|
||||
...
|
||||
compile project(':react-native-video')
|
||||
+ implementation "androidx.appcompat:appcompat:1.0.0"
|
||||
- implementation "com.android.support:appcompat-v7:${rootProject.ext.supportLibVersion}"
|
||||
|
||||
}
|
||||
```
|
||||
|
||||
#### **android/gradle.properties**
|
||||
|
||||
Migrating to AndroidX (needs version >= 5.0.0):
|
||||
|
||||
```groovy
|
||||
android.useAndroidX=true
|
||||
android.enableJetifier=true
|
||||
```
|
||||
|
||||
#### Gradle 3 and target SDK 26 requirement
|
||||
In order to support ExoPlayer 2.9.0, you must use version 3 or higher of the Gradle plugin. This is included by default in React Native 0.57.
|
||||
|
||||
#### ExoPlayer 2.9.0 Java 1.8 requirement
|
||||
ExoPlayer 2.9.0 uses some Java 1.8 features, so you may need to enable support for Java 1.8 in your app/build.gradle file. If you get an error, compiling with ExoPlayer like:
|
||||
`Default interface methods are only supported starting with Android N (--min-api 24)`
|
||||
|
||||
Add the following to your app/build.gradle file:
|
||||
```groovy
|
||||
android {
|
||||
... // Various other settings go here
|
||||
compileOptions {
|
||||
targetCompatibility JavaVersion.VERSION_1_8
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### ExoPlayer no longer detaches
|
||||
When using a router like the react-navigation TabNavigator, switching between tab routes would previously cause ExoPlayer to detach causing the video player to pause. We now don't detach the view, allowing the video to continue playing in a background tab. This matches the behavior for iOS.
|
||||
|
||||
#### useTextureView now defaults to true
|
||||
The SurfaceView, which ExoPlayer has been using by default has a number of quirks that people are unaware of and often cause issues. This includes not supporting animations or scaling. It also causes strange behavior if you overlay two videos on top of each other, because the SurfaceView will [punch a hole](https://developer.android.com/reference/android/view/SurfaceView) through other views. Since TextureView doesn't have these issues and behaves in the way most developers expect, it makes sense to make it the default.
|
||||
|
||||
TextureView is not as fast as SurfaceView, so you may still want to enable SurfaceView support. To do this, you can set `useTextureView={false}`.
|
||||
|
||||
|
||||
### Version 3.0.0
|
||||
|
||||
#### All platforms now auto-play
|
||||
Previously, on Android ExoPlayer if the paused prop was not set, the media would not automatically start playing. The only way it would work was if you set `paused={false}`. This has been changed to automatically play if paused is not set so that the behavior is consistent across platforms.
|
||||
|
||||
#### All platforms now keep their paused state when returning from the background
|
||||
Previously, on Android MediaPlayer if you setup an AppState event when the app went into the background and set a paused prop so that when you returned to the app the video would be paused it would be ignored.
|
||||
|
||||
Note, Windows does not have a concept of an app going into the background, so this doesn't apply there.
|
||||
|
||||
#### Use Android target SDK 27 by default
|
||||
Version 3.0 updates the Android build tools and SDK to version 27. React Native is in the process of [switching over](https://github.com/facebook/react-native/issues/18095#issuecomment-395596130) to SDK 27 in preparation for Google's requirement that new Android apps [use SDK 26](https://android-developers.googleblog.com/2017/12/improving-app-security-and-performance.html) by August 2018.
|
||||
|
||||
You will either need to install the version 27 SDK and version 27.0.3 buildtools or modify your build.gradle file to configure react-native-video to use the same build settings as the rest of your app as described below.
|
||||
|
||||
##### Using app build settings
|
||||
You will need to create a `project.ext` section in the top-level build.gradle file (not app/build.gradle). Fill in the values from the example below using the values found in your app/build.gradle file.
|
||||
```groovy
|
||||
// Top-level build file where you can add configuration options common to all sub-projects/modules.
|
||||
|
||||
buildscript {
|
||||
... // Various other settings go here
|
||||
}
|
||||
|
||||
allprojects {
|
||||
... // Various other settings go here
|
||||
|
||||
project.ext {
|
||||
compileSdkVersion = 31
|
||||
buildToolsVersion = "30.0.2"
|
||||
|
||||
minSdkVersion = 21
|
||||
targetSdkVersion = 22
|
||||
}
|
||||
}
|
||||
```
|
||||
If you encounter an error `Could not find com.android.support:support-annotations:27.0.0.` reinstall your Android Support Repository.
|
||||
39
docs/theme.config.jsx
Normal file
39
docs/theme.config.jsx
Normal file
@ -0,0 +1,39 @@
|
||||
import React from 'react';
|
||||
|
||||
export default {
|
||||
head: (
|
||||
<>
|
||||
<meta name="language" content="en" />
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
||||
<meta name="description" content="Video component for React Native" />
|
||||
<meta name="og:title" content="React Native Video" />
|
||||
<meta
|
||||
name="og:description"
|
||||
content="A Video component for React Native"
|
||||
/>
|
||||
</>
|
||||
),
|
||||
logo: (
|
||||
<span>
|
||||
🎬 <strong>Video component</strong> for React Native
|
||||
</span>
|
||||
),
|
||||
faviconGlyph: '🎬',
|
||||
project: {
|
||||
link: 'https://github.com/react-native-video/react-native-video',
|
||||
},
|
||||
docsRepositoryBase:
|
||||
'https://github.com/react-native-video/react-native-video/tree/master/docs/',
|
||||
footer: {
|
||||
text: (
|
||||
<span>
|
||||
Built with love ❤️ by <strong>React Native Community</strong>
|
||||
</span>
|
||||
),
|
||||
},
|
||||
useNextSeoProps() {
|
||||
return {
|
||||
titleTemplate: '%s – Video',
|
||||
};
|
||||
},
|
||||
};
|
||||
@ -39,6 +39,7 @@
|
||||
"lint": "yarn eslint .",
|
||||
"build": "yarn tsc",
|
||||
"xbasic": "yarn --cwd examples/basic",
|
||||
"docs": "yarn --cwd docs build",
|
||||
"test": "echo no test available"
|
||||
},
|
||||
"files": [
|
||||
|
||||
Loading…
Reference in New Issue
Block a user