Skip to main content

PlayerConfiguration

The player configuration.

See​

Player.open

Properties​

android​

android?: default;

Player options specific to the Android platform.

apple​

apple?: default;

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​

drm?: DrmConfiguration;

The DRM configuration.

liveConfiguration​

liveConfiguration?: default;

The live configuration to tweak live latency and others.

metaData​

metaData?: ContentMetaData;

The content metadata.

nowPlaying​

nowPlaying?: default;

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​

preferredAudioLanguage?: string;

The language code for the preferred audio language.

preferredTextLanguage​

preferredTextLanguage?: string;

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

remoteTextTracks​

remoteTextTracks?: [RemoteTextTrack];

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

remoteThumbnailTracks​

remoteThumbnailTracks?: [RemoteThumbnailTrack];

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

secondaryDisplayBehaviour​

secondaryDisplayBehaviour?: SecondaryDisplayBehaviour;

The behavior of the player when a secondary display is connected. Defaults to [SecondaryDisplayBehaviour.Never]([object Object]).

source​

source: Source;

The playback source.

startTimeMs​

startTimeMs?: number;

The start time of the stream in milliseconds.

userId​

userId?: string;

The unique identifier for the current user.