Cue

@objcMembers
@objc(BMPCue)
public class Cue : NSObject, NSCopying

Describes a subtitle cue.

  • The start time of the cue in seconds

    Declaration

    Swift

    public var startTime: TimeInterval

  • The end time of the cue in seconds

    Declaration

    Swift

    public var endTime: TimeInterval

  • The cue text as HTML

    Declaration

    Swift

    public var html: String?

  • The cue text

    Declaration

    Swift

    public var text: String?

  • The cue image

    Declaration

    Swift

    public var image: UIImage?

  • The position of the cue. Only relevant for CEA-captions, provides information about where the cue should be positioned on a grid of 15 character rows times 32 columns

    Declaration

    Swift

    public var position: CuePosition?

  • The region of the cue

    Declaration

    Swift

    public var region: String?

  • The region style of the cue

    Declaration

    Swift

    public var regionStyle: String?
  • vtt

    The vtt positioning properties for this cue

    Declaration

    Swift

    public var vtt: VttProperties?

  • Declaration

    Swift

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

    Parameters

    startTime

    The start time of the cue in seconds
    endTime

    The end time of the cue in seconds
    html

    The cue text as HTML
    text

    The cue text
    image

    The cue image
    position

    The position of the cue. Only relevant for CEA captions
    region

    The region of the cue
    regionStyle

    The region style of the cue
    vttProperties

    The vtt positioning properties for this cue

    Return Value

    A new subtitle cue

  • Declaration

    Swift

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

  • Declaration

    Swift

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

  • Declaration

    Swift

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

  • Declaration

    Swift

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

  • Declaration

    Swift

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