TextTrack_Objc

@objc(THEOplayerTextTrack)
public protocol TextTrack_Objc : Track_Objc

A TextTrack object is an element that represents a single text track that can be displayed in the player.

  • The text track in-band metadata track dispatch type of the text track that the TextTrack object represents.

    Declaration

    Swift

    var inBandMetadataTrackDispatchType: String { get }

  • The text track mode.

    Remark

    Declaration

    Swift

    var mode: TextTrackMode { get set }

  • The text track’s list of TextTrackCue objects as a TextTrackCueList. This list includes all of the text track’s known cues.

    Declaration

    Swift

    @objc(cues)
var cues_Objc: [TextTrackCue_Objc] { get }

  • The text track’s list of active TextTrackCue objects as a TextTrackCueList.

    Remark

    This list dynamically updates as time progresses so that it includes all cues that are currently active. Currently active cues are ones that start before the current playback position and end after it.

    Declaration

    Swift

    @objc(activeCues)
var activeCues_Objc: [TextTrackCue_Objc] { get }

  • The content type of the given track.

    Remark

    • webvtt: The track contains WebVTT (Web Video Text Tracks) content.

    Declaration

    Swift

    var type: String { get }