Methods

(static) defaultSubtitleTrack(sortedSubtitles, selectedAudioLanguage, requireTextopt) → {integer}

defaultSubtitleTrack:

Parameters:
NameTypeAttributesDefaultDescription
sortedSubtitlesdynamic

array of subtitles sorted by type and language

selectedAudioLanguagestring

language for selected audio track

requireTextboolean<optional>
false

indicates if only text subtitles should be considered

Returns:

indicating the default track's server-side index. Defaults to {SubtitleSelection.NONE} if one is not found

Type: 
integer

(static) defaultSubtitleTrackFromVid(meta, selectedAudioIndex, mediaSourceIdopt) → {integer}

defaultSubtitleTrackFromVid: Identifies the default subtitle track given metadata and audio index

Parameters:
NameTypeAttributesDefaultDescription
metaobject

metadata object containing MediaSources with MediaStreams

selectedAudioIndexinteger

index of selected audio stream (used for Smart mode language matching)

mediaSourceIddynamic<optional>
invalid
Returns:

subtitle track index or SubtitleSelection.NONE if not found

Type: 
integer

(static) sortSubtitles(MediaStreams) → {dynamic}

Checks available subtitle tracks and puts subtitles in forced, default, and non-default/forced but preferred language at the top

Parameters:
NameTypeDescription
MediaStreamsdynamic
Returns:
Type: 
dynamic