Interface SourceConfiguration

Describes the configuration of a player's source.

interface SourceConfiguration {
    ads?: AdDescription[];
    analytics?: AnalyticsDescription[];
    cmcd?: CmcdConfiguration;
    contentProtection?: DRMConfiguration;
    hlsDateRange?: boolean;
    metadata?: MetadataDescription;
    poster?: string;
    textTracks?: TextTrackDescription[];
    timeServer?: string;
}

Hierarchy (view full)

Properties

ads? analytics? cmcd? contentProtection? hlsDateRange? metadata? poster? textTracks? timeServer?

Properties

Optional ads

ads?: AdDescription[]

List of AdDescriptions to be queued for playback.

Optional analytics

analytics?: AnalyticsDescription[]

List of AnalyticsDescriptions to configure source-related properties for analytics connectors.

Optional cmcd

cmcd?: CmcdConfiguration

The configuration for transmitting information to Content Delivery Networks (CDNs) through Common Media Client Data (CMCD) (CTA-5004)

Optional contentProtection

contentProtection?: DRMConfiguration

Content protection configuration.

Optional hlsDateRange

hlsDateRange?: boolean

Whether the player should parse and expose date ranges from HLS playlists.

Default Value

false

Optional metadata

metadata?: MetadataDescription

Describes the metadata of a source.

Optional poster

poster?: string

The poster of the media source.

Remarks


- An empty string ('') clears the current poster.

Optional textTracks

textTracks?: TextTrackDescription[]

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

Remarks


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

Optional timeServer

timeServer?: string

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

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.

Settings

Member Visibility

Theme

On This Page

adsanalyticscmcdcontentProtectionhlsDateRangemetadatapostertextTrackstimeServer