Skip to main content

PlayerConfiguration

Properties​

analyticsMetaData​

analyticsMetaData?: AnalyticsMetadata;

The analytics metadata of the stream.

autoPlay​

autoPlay?: boolean;

Sets whether the player should start playback as soon as enough content has loaded to allow it to do so without interruption.

bufferConfiguration​

bufferConfiguration?: BufferConfiguration;

The buffer configuration to tweak buffer size and others.

Remarks​

Not supported on iOS/tvOS.

contentParameters​

contentParameters?: Object;

Sets the manifest header parameters.

Remarks​

Not supported on iOS/tvOS.

contentQueryParameters​

contentQueryParameters?: Object;

Sets the query parameters to add to content (manifest) requests.

Remarks​

Not supported on iOS/tvOS.

contentType​

contentType?: ContentType;

The content type of the stream.

contentUrl​

contentUrl: string;

The URL of the stream.

drmConfiguration​

drmConfiguration?: DrmTodayConfiguration | DrmTodayOnboardConfiguration | CustomDrmConfiguration;

The DRM configuration.

If the drmType is DRMTODAY, the configuration should be DrmTodayConfiguration. If the drmType is DRMTODAY_ONBOARD, the configuration should be DrmTodayOnboardConfiguration. If the drmType is CUSTOM, the configuration should be CustomDrmConfiguration.

drmSystem​

drmSystem?: DrmSystem;

The DRM system.

drmType​

drmType?: DrmType;

The DRM type.

forceInStreamDrmInitData​

forceInStreamDrmInitData?: boolean;

Sets whether to use DRM init data coming from segments or from the manifest.

Remarks​

Limited to DASH streams. Not supported on iOS/tvOS.

ignoreSilentSwitch​

ignoreSilentSwitch?: SilentSwitchBehaviour;

Specifies whether to ignore or obey the physical silent switch on Apple devices. If not defined, a default system behaviour is left.

Remarks​

Not supported on Android.

live​

live?: boolean;

Sets whether this is live content.

liveConfiguration​

liveConfiguration?: LiveConfiguration;

The live configuration to tweak live latency and others.

metaData​

metaData?: Metadata;

The metadata of the stream.

preferredTextLanguage​

preferredTextLanguage?: string;

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

segmentParameters​

segmentParameters?: Object;

Sets the segment header parameters.

Remarks​

Not supported on iOS/tvOS.

segmentQueryParameters​

segmentQueryParameters?: Object;

Sets the segment query parameters.

Remarks​

Not supported on iOS/tvOS.

sideloadedTracks​

sideloadedTracks?: SideloadedTrack[];

The side-loaded thumbnail or text tracks

startTimeMs​

startTimeMs?: number;

The start time of the stream in milliseconds.

threesixty​

threesixty?: boolean;

Sets whether this is 360 content.

userId​

userId?: string;

Sets the user ID of the stream.