Interface MKSourceConfig

Source configuration interfcae.

Hierarchy

  • MKSourceConfig

Properties

analyticsConfig?: MKAnalyticsConfig

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

assetType?: MKAssetType

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

For a registered source assetType must be correctly specified and not required for other source types.

It is recommended that the asset type be correctly configured on the source so that some internal logic that depends on this setting can be correctly executed.

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, dash or smooth and not required for ull, registered, progressive or whep sources.

The SDK applies the necessary drm config for registered source internally so there is no need to configure it externally. Doing so can cause unexpected errors.

hls?: string

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

Labeling config for the different stream types.

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.

progressive?: string | MKProgressiveSource[]

An Array of objects to video files, used for progressive download as fallback.

Is only used when all other methods fail. Multiple progressive files can be used, e.g. .mp4 and .webm files to support as many browsers as possible.

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.

smooth?: string

An URL to a SmoothStreaming manifest file (xml or ismc). The file has to be a valid smooth streaming manifest file.

sourceOptions?: MKSourceOptions

An object specifying advanced source specific options.

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.

whep?: string

An URL pointing to a WHEP endpoint.