Interface SourceConfig

Represents a source configuration that be loaded into a player instance.

interface SourceConfig {
    analyticsSourceMetadata?: SourceMetadata;
    description?: string;
    drmConfig?: DrmConfig;
    isPosterPersistent?: boolean;
    metadata?: Record<string, string>;
    nativeId?: string;
    options?: SourceOptions;
    poster?: string;
    subtitleTracks?: SideLoadedSubtitleTrack[];
    thumbnailTrack?: string;
    title?: string;
    type?: SourceType;
    url: string;
}

Hierarchy

  • NativeInstanceConfig
    • SourceConfig

Properties

analyticsSourceMetadata? description? drmConfig? isPosterPersistent? metadata? nativeId? options? poster? subtitleTracks? thumbnailTrack? title? type? url

Properties

Optional analyticsSourceMetadata

analyticsSourceMetadata?: SourceMetadata

The SourceMetadata for the Source to setup custom analytics tracking

Optional description

description?: string

The description of the video source.

Optional drmConfig

drmConfig?: DrmConfig

The DRM config for the source.

Optional isPosterPersistent

isPosterPersistent?: boolean

Indicates whether to show the poster image during playback. Useful, for example, for audio-only streams.

Optional metadata

metadata?: Record<string, string>

The optional custom metadata. Also sent to the cast receiver when loading the Source.

Optional nativeId

nativeId?: string

Optionally user-defined string id for the native instance. Used to access a certain native instance from any point in the source code then call methods/properties on it.

When left empty, a random UUIDv4 is generated for it.

Example

Accessing or creating the Player with nativeId equal to my-player:

const player = new Player({ nativeId: 'my-player' })
player.play(); // call methods and properties...

Optional options

options?: SourceOptions

The SourceOptions for this configuration.

Optional poster

poster?: string

The URL to a preview image displayed until the video starts.

Optional subtitleTracks

subtitleTracks?: SideLoadedSubtitleTrack[]

External subtitle tracks to be added into the player.

Optional thumbnailTrack

thumbnailTrack?: string

External thumbnails to be added into the player.

Optional title

title?: string

The title of the video source.

Optional type

type?: SourceType

The SourceType for this configuration.

url

url: string

The url for this source configuration.

Settings

Member Visibility

Theme

On This Page

analyticsSourceMetadatadescriptiondrmConfigisPosterPersistentmetadatanativeIdoptionspostersubtitleTracksthumbnailTracktitletypeurl