Constants

The following constants are available globally.

Error domain

  • Domain used by all errors produced by the player.

    At minimum, these errors will have a useful localized failure reason (localizedFailureReason property) and description (localizedDescription property) as well as a unique error code (code property). Other data may be provided in the userInfo via the NSErrorUserInfoKey constants defined in this library.

    Declaration

    Objective-C

    extern const NSErrorDomain _Nonnull IVSPlayerErrorDomain

    Swift

    let IVSPlayerErrorDomain: String

Error user info keys

  • NSString, short text describing the component that encountered the error.

    Declaration

    Objective-C

    extern const NSErrorUserInfoKey _Nonnull IVSSourceDescriptionErrorKey

    Swift

    let IVSSourceDescriptionErrorKey: String

  • NSString, short text describing the type of error encountered.

    Declaration

    Objective-C

    extern const NSErrorUserInfoKey _Nonnull IVSResultDescriptionErrorKey

    Swift

    let IVSResultDescriptionErrorKey: String

  • Subtitles and captions, implemented as IVSTextCue.

    Declaration

    Objective-C

    extern const IVSCueType _Nonnull IVSCueTypeText

    Swift

    static let text: IVSCue.CueType

  • Plaintext timed metadata, implemented as IVSTextMetadataCue.

    Declaration

    Objective-C

    extern const IVSCueType _Nonnull IVSCueTypeTextMetadata

    Swift

    static let textMetadata: IVSCue.CueType

  • Metadata injected out of band via the AWS HTTP API

    Declaration

    Objective-C

    extern NSString *const _Nonnull IVSCueID3MetadataID

    Swift

    let IVSCueID3MetadataID: String

  • Metadata injected into the RTMP connection by the broadcaster directly

    Declaration

    Objective-C

    extern NSString *const _Nonnull IVSCueInbandID3MetadataID

    Swift

    let IVSCueInbandID3MetadataID: String