Interface MKSourceConfig

Source configuration interfcae.

Hierarchy

  • MKSourceConfig

Properties

analyticsConfig?: MKAnalyticsConfig

Bundled Bitmovin Analytics Configuration used to specify per-stream metadata and other settings.

cdnOptions?: MKCdnOptions

CDN Options.

Please note that these options only apply to registered.

dash?: string

The URL to the MPEG-DASH manifest file (MPD, Media Presentation Description) for the video to play.

The file has to be a valid MPD.

description?: string

The description of the video source.

drmConfig?: MKDrmConfig

DRM Configuration for encrypted sources.

Only to be used with hls or dash and not required for ull or registered.

hls?: string

An URL to an HLS playlist file (M3U8). The file has to be a valid M3U8 playlist.

poster?: string

The URL to a preview image which will be displayed until video starts playing.

Make sure JavaScript is allowed to access it, i.e. CORS (for the HTML5/JavaScript player) must be enabled and a crossdomain.xml has to be there if it's not the same server as the website.

registered?: MKRegisteredSource

Mediakind Registered source.

sessionId?: string

Unique session identifer for the playback session with this source configuration.

When no session identifier is provided the SDK will generate one internally.

sourceOptions?: MKSourceOptions

An object specifying advanced source specific options.

sourceType?: MKSourceType

Source type (Live, Event, Catchup, DVR or VOD)

For a registered player can auto detect source types Live, Event or VOD. For Catchup and DVR it is recommended the user set the correct source type in the source config.

For hls or dash the player can only determine whether the source type is Live or VOD.

It is recommended that the source type be correctly configured on the source so that some internal logic that depends on this setting can be correctly executed. One use case is when applying startOffset before starting playback.

subtitleTracks?: MKSubtitleTrack[]

An array of external subtitle tracks.

Example:

subtitleTracks: [{
url: 'http://path/to/subtitles/vtt/file.vtt',
}]
thumbnailTrack?: MKThumbnailTrack

Sideload thumbnail tracks.

Note: Sideloaded tracks if configured here will have preference over the thumbnail tracks found in the stream/manifest itself.

Example:

thumbnailTrack: {
url: 'http://path/to/thumbnail/vtt/file.vtt',
}
title?: string

Title of the video source.

Mediakind Ultra Low Latency (ULL) source.