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

docs: review and clean up (#3730)

Browse Source 
* fix(ts): onPlaybackRateChangeData was not correctly typed

* fix: ensure tracks are well displayed in the sample

* chore: reorder drm props

* chore: reorder events

* docs: move onAudioTracks to events

* docs: reorder and clean <PlatformsList from methods

* docs: fix props case naming

* docs: fix ordering

* docs: fix ordering & remove trackId

* chore: remove sample build from installation page

* docs: remove outdated information

* docs: remove beta information from doc landing page
This commit is contained in:
Olivier Bouillet
2024-05-04 14:36:39 +02:00
committed by GitHub
parent edbb3b60aa
commit 4c63988d12
9 changed files with 104 additions and 182 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
docs/pages/component/props.mdx
View File

@@ -161,7 +161,7 @@ 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
### `DRM`
### `drm`
<PlatformsList types={['Android', 'iOS']} />
@@ -209,7 +209,7 @@ Enable video filter.
- **false (default)** - Don't enable filter
- **true** - Enable filter
### `Focusable`
### `focusable`
<PlatformsList types={['Android']} />
@@ -280,6 +280,20 @@ Controls the iOS silent switch behavior
- **"ignore"** - Play audio even if the silent switch is set
- **"obey"** - Don't play audio if the silent switch is set
### `localSourceEncryptionKeyScheme`
<PlatformsList types={['iOS']} />
Set the url scheme for stream encryption key for local assets
Type: String
Example:
```
localSourceEncryptionKeyScheme="my-offline-key"
```
### `maxBitRate`
<PlatformsList types={['Android', 'iOS', 'visionOS']} />
@@ -434,34 +448,6 @@ Determine whether to repeat the video when the end is reached
- **false (default)** - Don't repeat the video
- **true** - Repeat the video
### `onAudioTracks`
<PlatformsList types={['Android']} />
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 }
],
}
```
### `reportBandwidth`
<PlatformsList types={['Android']} />
@@ -782,11 +768,18 @@ textTracks={[
]}
```
### `trackId`
### `useSecureView`
<PlatformsList types={['Android']} />
Configure an identifier for the video stream to link the playback context to the events emitted.
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
### `useTextureView`
@@ -804,19 +797,6 @@ useTextureView can only be set at same time you're setting the source.
- **true (default)** - Use a TextureView
- **false** - Use a SurfaceView
### `useSecureView`
<PlatformsList types={['Android']} />
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
### `volume`
<PlatformsList types={['All']} />
@@ -826,17 +806,3 @@ Adjust the volume.
- **1.0 (default)** - Play at full volume
- **0.0** - Mute the audio
- **Other values** - Reduce volume
### `localSourceEncryptionKeyScheme`
<PlatformsList types={['iOS']} />
Set the url scheme for stream encryption key for local assets
Type: String
Example:
```
localSourceEncryptionKeyScheme="my-offline-key"
```