Bitmovin Player React Native SDK - v1.4.0
    Preparing search index...

    Interface SubtitleTrack

    Describes a subtitle track.

    Android, iOS, tvOS

    interface SubtitleTrack {
        format?: SubtitleFormat;
        identifier?: string;
        isDefault?: boolean;
        isForced?: boolean;
        label?: string;
        language?: string;
        roles?: MediaTrackRole[];
        url?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    format? identifier? isDefault? isForced? label? language? roles? url?

    Properties

    format?: SubtitleFormat

    Specifies the file format to be used by this track.

    identifier?: string

    The unique identifier for this track. If no value is provided, a random UUIDv4 will be generated for it.

    isDefault?: boolean

    If set to true, this track would be considered as default. Default is false.

    isForced?: 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. Forced subtitles do not appear in Player.getAvailableSubtitles.

    Default is false.

    label?: string

    The label for this track.

    language?: string

    The IETF BCP 47 language tag associated with this track, e.g. pt, en, es etc.

    roles?: MediaTrackRole[]

    An array of MediaTrackRole objects, each describing a specific role or characteristic of the subtitle track. This property provides a unified way to understand track purposes (e.g., for accessibility) across platforms.

    url?: string

    The URL to the timed file, e.g. WebVTT file.

    Settings

    Member Visibility

    On This Page

    Properties