Skip to main content

PlayerConfiguration

The player configuration.

See​

Player.open

Properties​

android?​

optional android: AndroidPlayerConfiguration

Player options specific to the Android platform.

apple?​

optional apple: ApplePlayerConfiguration

Player options specific to iOS and tvOS platforms.

autoPlay​

autoPlay: boolean

Set to true for playing the stream as soon as it is loaded.

drm?​

optional drm: DrmConfiguration

The DRM configuration.

liveConfiguration?​

optional liveConfiguration: LiveConfiguration

The live configuration to tweak live latency and others.

metaData?​

optional metaData: ContentMetaData

The content metadata.

nowPlaying?​

optional nowPlaying: NowPlayingConfiguration

The react-native-prestoplay-now-playing plugin configuration.

This plugin allows users to control stream playback via media controls in the notification center or on the lock screen for iOS and Android.

preferredAudioLanguage?​

optional preferredAudioLanguage: string

The language code for the preferred audio language.

preferredTextLanguage?​

optional preferredTextLanguage: string

The language code for the preferred text language. If this is specified, subtitles will be enabled at startup.

remoteTextTracks?​

optional remoteTextTracks: [RemoteTextTrack]

The side-loaded text tracks. Use Player.getTrackManager to select a text track.

remoteThumbnailTracks?​

optional remoteThumbnailTracks: [RemoteThumbnailTrack]

The side-loaded thumbnail tracks. Use the react-native-prestoplay-thumbnails plugin to display thumbnails.

secondaryDisplayBehaviour?​

optional secondaryDisplayBehaviour: SecondaryDisplayBehaviour

The behavior of the player when a secondary display is connected. Defaults to SecondaryDisplayBehaviour.Never.

source​

source: Source

The playback source.

startTimeMs?​

optional startTimeMs: number

The start time of the stream in milliseconds.

userId?​

optional userId: string

The unique identifier for the current user.