Bitmovin Player API 8.268.0
    Preparing search index...

    Interface SubtitleTrack

    Definition of a subtitle/caption track.

    interface SubtitleTrack {
        enabled?: boolean;
        forced?: boolean;
        id: string;
        isFragmented?: boolean;
        isSideloaded?: boolean;
        kind: string;
        label: string;
        lang: string;
        metadata?: MediaTrackMetadata[];
        role?: MediaTrackRole[];
        url?: string;
    }

    Hierarchy (View Summary)

    Index
    enabled? forced? id isFragmented? isSideloaded? kind label lang metadata? role? url?
    enabled?: boolean

    Tells if a subtitle track is enabled or disabled. If set to true, the track will be enabled by default.

    forced?: boolean

    Tells if a subtitle track is forced. If set to true it means that the player should automatically select and switch this subtitle according to the selected audio language.

    id: string

    The id of the media track that is used to identify and set the track.

    isFragmented?: boolean

    Indicates whether the subtitle is fragmented.

    isSideloaded?: boolean

    Indicates whether the subtitle is sideloaded, i.e. it has been added through PlayerSubtitlesAPI.add or SourceConfig.subtitleTracks.

    8.177.0

    kind: string

    The subtitle type, either "caption" or "subtitle" (default: "subtitle").

    label: string

    The text used to represent this track to the user (e.g. in the UI).

    lang: string

    The language of the subtitle/caption track.

    metadata?: MediaTrackMetadata[]

    Optional custom metadata about the track. This is currently only supported for DASH manifests, where these are populated from SupplementalProperty elements.

    8.243.0

    role?: MediaTrackRole[]

    The optional roles of the track.

    url?: string

    The URL to the associated file.

    Settings
    Member Visibility

    On This Page
    Properties