Methods
(static) defaultSubtitleTrack(sortedSubtitles, selectedAudioLanguage, requireTextopt, originalLanguageopt, languageMatchesopt) → {integer}
defaultSubtitleTrack:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
sortedSubtitles | dynamic | array of subtitles sorted by type and language | ||
selectedAudioLanguage | string | language for selected audio track | ||
requireText | boolean | <optional> | false | indicates if only text subtitles should be considered |
originalLanguage | string | <optional> | "" | the item's OriginalLanguage (JellyfinBaseItem.originalLanguage) |
languageMatches | dynamic | <optional> | invalid | sortSubtitles()' languageMatches, computed over ALL the item's subtitles; derived from sortedSubtitles when omitted |
- Source
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
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
meta | object | metadata object containing MediaSources with MediaStreams | ||
selectedAudioIndex | integer | index of selected audio stream (used for Smart mode language matching) | ||
mediaSourceId | dynamic | <optional> | invalid |
- Source
subtitle track index or SubtitleSelection.NONE if not found
- Type:
- integer
(static) sortSubtitles(MediaStreams, originalLanguageopt, withLabelsopt) → {dynamic}
Checks available subtitle tracks and puts subtitles in forced, default, and non-default/forced but preferred language at the top
withLabels = false leaves each Track.Description empty, for a caller that only picks a track: the labels are most of this function's cost on a Task thread.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
MediaStreams | dynamic | |||
originalLanguage | string | <optional> | "" | |
withLabels | boolean | <optional> | true |
- Source
- Type:
- dynamic