logo
THEOplayer
ABR
Miscellaneous
Ads
Caching
Content protection
Analytics
Casting
Media and Text Tracks
Source
BaseSourceSourceSourceChangeEventSourceConfigurationSourceDescriptionSourceIntegrationIdSourcesTypedSource
Verizon Media
Events
HESP
SSAI
Network
Presentation
Player
UI
VR

THEOplayer > SourceConfiguration

SourceConfiguration interface

Describes the configuration of a player's source.

Signature:

export interface SourceConfiguration 

Properties

Property

Type

Description

ads (optional)

AdDescription[]

List of AdDescriptions to be queued for playback.

analytics (optional)

AnalyticsDescription[]

List of AnalyticsDescriptions to configure analytics integrations for the media source.

blockContentIfAdError (optional)

boolean

Whether the player should be blocked when an ad-related error occurs.

contentProtection (optional)

DRMConfiguration

Content protection configuration.

drm (optional)

DRMConfiguration

Content protection configuration.

manifestMetadataTrack (optional)

boolean

Whether segments in a HLS manifest should be represented by cues in a metadata text track.

metadata (optional)

ChromecastMetadataDescription

Chromecast metadata configuration.

mutedAutoplay (optional)

MutedAutoplayConfiguration

The muted autoplay policy.

poster (optional)

string

The poster of the media source.

textTracks (optional)

TextTrackDescription[]

List of text tracks to be side-loaded with the media source.

timeServer (optional)

string

The URL of a time server used by the player to synchronise the time in DASH sources.

vr (optional)

VRConfiguration

Virtual reality configuration.

Property Details

ads

List of AdDescriptions to be queued for playback.

Signature:

ads?: AdDescription[];

analytics

List of AnalyticsDescriptions to configure analytics integrations for the media source.

Signature:

analytics?: AnalyticsDescription[];

blockContentIfAdError

Whether the player should be blocked when an ad-related error occurs.

Signature:

blockContentIfAdError?: boolean;

Remarks


- A blocked player is not usable anymore. This has the same effect as invoking ChromelessPlayer.destroy().

contentProtection

Content protection configuration.

Signature:

contentProtection?: DRMConfiguration;

drm

Warning: This API is deprecated.

Superseded by SourceConfiguration.contentProtection.

Content protection configuration.

Signature:

drm?: DRMConfiguration;

manifestMetadataTrack

Warning: This API is deprecated.

Do not use this feature without consulting THEO Technologies.

Whether segments in a HLS manifest should be represented by cues in a metadata text track.

Signature:

manifestMetadataTrack?: boolean;

metadata

Chromecast metadata configuration.

Signature:

metadata?: ChromecastMetadataDescription;

Remarks


- Available since v2.21.0.

mutedAutoplay

The muted autoplay policy.

Signature:

mutedAutoplay?: MutedAutoplayConfiguration;

Remarks


- The muted autoplay policy is impacted by this property and PlayerConfiguration.mutedAutoplay.

poster

The poster of the media source.

Signature:

poster?: string;

Remarks


- An empty string ('') clears the current poster.
- This poster has priority over ChromelessPlayer.poster.

textTracks

List of text tracks to be side-loaded with the media source.

Signature:

textTracks?: TextTrackDescription[];

Remarks


- A source change will reset side-loaded text tracks.

timeServer

The URL of a time server used by the player to synchronise the time in DASH sources.

Signature:

timeServer?: string;

Remarks


- The time server should return time in ISO-8601 format.
- Overrides the time server provided the DASH manifest's <UTCTiming>.
- All sources will use the time server. Alternatively, for one source use BaseSource.timeServer.

vr

Virtual reality configuration.

Signature:

vr?: VRConfiguration;
github
Make sure to follow us on GitHub!
THEO-logo-white
twitter
facebook
linkedin
Copyright © 2020. All Rights Reserved.
Leuven
New York
Singapore
Barcelona