BMPCue

Objective-C


@interface BMPCue : NSObject <NSCopying>

Swift

class Cue : NSObject, NSCopying

Describes a subtitle cue.

  • The start time of the cue in seconds

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval startTime;

    Swift

    var startTime: TimeInterval { get set }

  • The end time of the cue in seconds

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval endTime;

    Swift

    var endTime: TimeInterval { get set }

  • The cue text as HTML. May be nil.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *html;

    Swift

    var html: String? { get set }

  • The cue text. May be nil.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *text;

    Swift

    var text: String? { get set }

  • The cue image. May be nil.

    Declaration

    Objective-C

    @property (nonatomic, nullable) UIImage *image;

    Swift

    var image: UIImage? { get set }

  • The position of the cue. May be nil.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *position;

    Swift

    var position: String? { get set }

  • The region of the cue. May be nil.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *region;

    Swift

    var region: String? { get set }

  • The region style of the cue. May be nil.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *regionStyle;

    Swift

    var regionStyle: String? { get set }
  • vtt

    The vtt positioning properties for this cue

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) BMPVttProperties *vtt;

    Swift

    @NSCopying var vtt: VttProperties? { get set }

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    + (instancetype)new NS_UNAVAILABLE;

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithStartTime:(NSTimeInterval)startTime
                          endTime:(NSTimeInterval)endTime
                             html:(nullable NSString *)html
                             text:(nullable NSString *)text
                            image:(nullable UIImage *)image
                         position:(nullable NSString *)position
                           region:(nullable NSString *)region
                      regionStyle:(nullable NSString *)regionStyle;

    Swift

    convenience init(startTime: TimeInterval, endTime: TimeInterval, html: String?, text: String?, image: UIImage?, position: String?, region: String?, regionStyle: String?)

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithStartTime:(NSTimeInterval)startTime
                          endTime:(NSTimeInterval)endTime
                             html:(nullable NSString *)html
                             text:(nullable NSString *)text
                            image:(nullable UIImage *)image
                         position:(nullable NSString *)position
                           region:(nullable NSString *)region
                      regionStyle:(nullable NSString *)regionStyle
                    vttProperties:(nullable BMPVttProperties *)vttProperties NS_DESIGNATED_INITIALIZER;

    Swift

    init(startTime: TimeInterval, endTime: TimeInterval, html: String?, text: String?, image: UIImage?, position: String?, region: String?, regionStyle: String?, vttProperties: VttProperties?)

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithStartTime:(NSTimeInterval)startTime
                          endTime:(NSTimeInterval)endTime
                             text:(NSString *)text;

    Swift

    convenience init(startTime: TimeInterval, endTime: TimeInterval, text: String)

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithStartTime:(NSTimeInterval)startTime
                          endTime:(NSTimeInterval)endTime
                             text:(NSString *)text
                    vttProperties:(nullable BMPVttProperties *)vttProperties;

    Swift

    convenience init(startTime: TimeInterval, endTime: TimeInterval, text: String, vttProperties: VttProperties?)

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithStartTime:(NSTimeInterval)startTime
                          endTime:(NSTimeInterval)endTime
                             html:(NSString *)html;

    Swift

    convenience init(startTime: TimeInterval, endTime: TimeInterval, html: String)

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)initWithStartTime:(NSTimeInterval)startTime
                          endTime:(NSTimeInterval)endTime
                            image:(UIImage *)image;

    Swift

    convenience init(startTime: TimeInterval, endTime: TimeInterval, image: UIImage)