BMPSubtitleTrack


@interface BMPSubtitleTrack : BMPTrack

Describes a subtitle track.

  • The IETF BCP 47 language tag associated with the subtitle track.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic, nullable) NSString *language;

    Swift

    var language: String? { get }

  • The subtitle track controller for this track.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic, nonnull) id<BMPSubtitleTrackController>
    controller;

    Swift

    var controller: SubtitleTrackController { get }

  • Creates a new subtitle track based on the given URL and provided metadata.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUrl:(nullable NSURL *)url
                              label:(nonnull NSString *)label
                         identifier:(nonnull NSString *)identifier
                     isDefaultTrack:(BOOL)isDefaultTrack
                           language:(nullable NSString *)language;

    Swift

    init(url: NSURL?, label: String, identifier: String, isDefaultTrack: Bool, language: String?)

    Parameters

    url

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

    The label for this track.
    identifier

    The unique identifier for this track.
    isDefaultTrack

    If set to YES, this track would be considered as default.
    language

    The IETF BCP 47 language tag associated with this track

    Return Value

    A new subtitle track initialized with the given subtitle URL and the provided metadata.