Enumerations

The following enumerations are available globally.

  • Represents type of Ad

    See more

    Declaration

    Swift

    public enum AdPosition : String, Codable

  • Ad tracking events

    See more

    Declaration

    Swift

    public enum AdTrackingEvent : String, Codable

  • The purpose of the overlay. One of PLAYBACK_CONTROLS_UI_SCOPE, CLOSE_AD_UI_SCOPE, OTHER_UI_SCOPE or NOT_VISIBLE_UI_SCOPE.

    See more

    Declaration

    Swift

    public enum AdOverlayPurpose

  • Undocumented

    See more

    Declaration

    Swift

    public enum AdInsertionType

  • Rules that enforce ad playback policy when the user performs fast forward operation.

    See more

    Declaration

    Swift

    public enum PlaybackFastForwardRule : String, Codable, CaseIterable

  • Rules that enforce ad playback policy when the user performs rewind operation.

    See more

    Declaration

    Swift

    public enum PlaybackRewindRule : String, Codable, CaseIterable

  • Rules that enforce ad playback policy when the playback is interrupted.

    See more

    Declaration

    Swift

    public enum PlaybackInterruptedRule : String, Codable, CaseIterable

  • Rules that enforce ad playback policy when the user has a “bookmarked” time for a piece of content, then plays the content again, and the player auto-seeking to the bookmark triggers the ads.

    See more

    Declaration

    Swift

    public enum PlaybackAutoSeekRule : String, Codable, CaseIterable

  • Rules that enforce ad playback for repeated ad playback in a single playback session.

    See more

    Declaration

    Swift

    public enum PlaybackRepeatedRule : String, Codable, CaseIterable

  • Subtitle media track type for subtitle tracks in the player

    See more

    Declaration

    Swift

    public enum AdditionalSubtitleFormat
    extension AdditionalSubtitleFormat: Equatable

  • Blackout Action

    See more

    Declaration

    Swift

    public enum BlackoutAction : String, Codable

  • Mode enum. Primarily used for BookmarkRecord content identification.

    See more

    Declaration

    Swift

    public enum Mode : String, Codable

  • Support key delivery types

    See more

    Declaration

    Swift

    public enum KeyDeliveryType

  • Defines the different types of media tracks available in a media stream.

    Media tracks represent different content streams within a media file or stream, such as audio, video, subtitles, or closed captions. Each track type serves a specific purpose in media playback and accessibility.

    See more

    Declaration

    Swift

    public enum MediaTrackType : Codable

  • Defines media characteristics that describe special properties of media tracks.

    Media characteristics provide metadata about tracks that describe their purpose, accessibility features, or other special properties. These characteristics help media players and accessibility systems understand how to handle specific tracks.

    See more

    Declaration

    Swift

    public enum MediaTrackCharacteristic : String, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum PALFlag

  • Player States

    See more

    Declaration

    Swift

    public enum PlayerState : Int

  • Player’s current context

    See more

    Declaration

    Swift

    public enum PlayerContext

  • Describes the reason for an audio session interruption.

    See more

    Declaration

    Swift

    public enum AudioInterruptionState

  • Player preferences

    See more

    Declaration

    Swift

    public enum PlayerPreference : Preference

  • Represents the possible actions for the main remote control button.

    See more

    Declaration

    Swift

    public enum RemoteMainAction

  • Undocumented

    See more

    Declaration

    Swift

    public enum PreferedIntervals : Double

  • Defines how the player handles audiovisual content when the app transitions to background.

    Use this policy to control playback behavior when your app enters the background or when the device locks.

    Note

    Available on iOS 15.0+ and tvOS 15.0+.
    See more

    Declaration

    Swift

    public enum PlayerAudiovisualBackgroundPlaybackPolicy

  • Represents Stream timeline based events

    See more

    Declaration

    Swift

    public enum StreamTimelineEvent : String, Codable

  • Represents actions that client could perform in response to handling a StreamTimelineEvent

    See more

    Declaration

    Swift

    public enum Action : String, Codable

  • enum for streamStartUpTime data

    See more

    Declaration

    Swift

    public enum StartUpEventType : String