IVSTextTrack

Objective-C


@interface IVSTextTrack : NSObject

Swift

class IVSTextTrack : NSObject, @unchecked Sendable

Represents a text track (subtitle or caption) available in the loaded source.

Note

This API is in beta and may change.
  • Unavailable

    Do not create instances of this class directly

    Declaration

    Objective-C

    IVS_INIT_UNAVAILABLE
  • Unavailable

    Do not create instances of this class directly

    Declaration

    Objective-C

    IVS_INIT_UNAVAILABLE
  • Unique identifier for the text track.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull trackId;

    Swift

    var trackId: String { get }
  • Display label for the text track, suitable for use in a user interface.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull label;

    Swift

    var label: String { get }
  • BCP-47 language tag for the text track.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull languageTag;

    Swift

    var languageTag: String { get }
  • Returns a boolean value that indicates whether a given text track is equal to another.

    Declaration

    Objective-C

    - (BOOL)isEqualToTextTrack:(nonnull IVSTextTrack *)other;

    Swift

    func isEqual(to other: IVSTextTrack) -> Bool

    Parameters

    other

    Another text track instance