Add documenation for the selectedTextTrack prop
This commit is contained in:
parent
a8c7fb70d1
commit
ed79b790b5
33
README.md
33
README.md
@ -230,6 +230,7 @@ var styles = StyleSheet.create({
|
||||
* [rate](#rate)
|
||||
* [repeat](#repeat)
|
||||
* [resizeMode](#resize-mode)
|
||||
* [selectedTextTrack](#selectedtexttrack)
|
||||
* [volume](#volume)
|
||||
|
||||
#### ignoreSilentSwitch
|
||||
@ -304,6 +305,38 @@ Determines how to resize the video when the frame doesn't match the raw video di
|
||||
|
||||
Platforms: Android ExoPlayer, Android MediaPlayer, iOS, Windows UWP
|
||||
|
||||
#### selectedTextTrack
|
||||
Configure which text track (caption or subtitle), if any, is shown.
|
||||
|
||||
```
|
||||
selectedTextTrack={{
|
||||
type: Type,
|
||||
value: Value
|
||||
}}
|
||||
```
|
||||
|
||||
Example:
|
||||
```
|
||||
selectedTextTrack={{
|
||||
type: "title",
|
||||
value: "English Subtitles"
|
||||
}}
|
||||
```
|
||||
|
||||
Type | Description
|
||||
--- | ---
|
||||
"system" | (default) Display captions only if the system preference for captions is enabled
|
||||
"disabled" | Don't display a text track
|
||||
"title" | Display the text track with the title specified as the Value, e.g. "French 1"
|
||||
"language" | Display the text track with the language specified as the Value, e.g. "fr"
|
||||
"index" | Display the text track with the index specified as the value, e.g. 0
|
||||
|
||||
Both iOS & Android 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 ExoPlayer, iOS
|
||||
|
||||
#### volume
|
||||
Adjust the volume.
|
||||
* **1.0 (default)** - Play at full volume
|
||||
|
Loading…
Reference in New Issue
Block a user