Other Enumerations

The following enumerations are available globally.

  • Describes the current lifecycle state of a APSMediaEvent.

    See more

    Declaration

    Objective-C

    enum APSMediaEventState {}

    Swift

    enum APSMediaEventState : Int

  • Describes the position the overlay should take when placed on-screen by the player.

    See more

    Declaration

    Objective-C

    enum APSMediaOverlayPosition {}

    Swift

    enum APSMediaOverlayPosition : Int

Available Tracking Events

  • Defines the viewability status of the player according to VAST 4 specifications

    See more

    Declaration

    Objective-C

    enum APSViewability {}

    Swift

    enum APSViewability : Int

  • Controls bar components.

    See more

    Declaration

    Objective-C

    enum APSControlsOverlayComponents {}

    Swift

    struct APSControlsOverlayComponents : OptionSet

  • Defines the action that the player should take when resuming playback after an interruption caused by user interaction, that determined the display of the in-app web browser.

    See more

    Declaration

    Objective-C

    enum APSWebviewDismissedAction {}

    Swift

    enum APSWebviewDismissedAction : Int

  • Specifies how the controls bar should be displayed for a media unit.

    See more

    Declaration

    Objective-C

    enum APSMediaControlsDisplay {}

    Swift

    enum APSMediaControlsDisplay : Int

  • Specifies how the unit should handle seeking through multiple ad breaks.

    See more

    Declaration

    Objective-C

    enum APSHandleSeekEvent {}

    Swift

    enum APSHandleSeekEvent : Int

  • If the movie source type is a stream, this identifies the type of stream (on-demand or live)

    See more

    Declaration

    Objective-C

    enum APSMovieStreamSourceType {}

  • The different playback states the player can be in

    See more

    Declaration

    Objective-C

    enum APSMoviePlaybackState {}

  • The different load states any media can have during its lifetime

    See more

    Declaration

    Objective-C

    enum APSMovieLoadState {}

  • The different movie source types available

    See more

    Declaration

    Objective-C

    enum APSMovieSourceType {}

  • Types of native controls that some backend renderers can use. These are provided by the OS, and are separate from the controls bar provided by the library.

    See more

    Declaration

    Objective-C

    enum APSMovieControlStyle {}

  • Types of possible media scaling modes

    See more

    Declaration

    Objective-C

    enum APSMovieScalingMode {}

  • Types of possible media playback finish reasons

    See more

    Declaration

    Objective-C

    enum APSMovieFinishReason {}

  • Possible settings for fullscreen orientation handling

    See more

    Declaration

    Objective-C

    enum APSFullscreenOrientationBehaviour {}

  • Defines how an APSVASTAdBreak should be placed relative to the main content units.

    See more

    Declaration

    Objective-C

    enum APSVASTAdBreakType {}

    Swift

    enum APSVASTAdBreakType : Int

  • The VMAP standard permits allowing only one ad from a certain ad source. This constant defines how the VAST builder plugin deals with situations when multiple valid ads are retrieved from a source that is disallowed to load several ads at one time.

    See more

    Declaration

    Objective-C

    enum APSResolvMultipleAdsConflictsBy {}

    Swift

    enum APSResolvMultipleAdsConflictsBy : Int

  • VAST 3.0 defines Ad Pods, with fallback mechanisms that allow loading an ad buffet of commercials to playback if the main ads fail. This value specifies how to treat backwards compatibility issues with VAST 2.0 and 1.0, by choosing what ads are promoted to the main Ad Pod if no valid Pods are detected.

    See more

    Declaration

    Objective-C

    enum APSAdPodFallback {}

    Swift

    enum APSAdPodFallback : Int

  • Defines where inside the skip overlay should the progress circle be rendered.

    See more

    Declaration

    Objective-C

    enum APSSkipOverlayProgressPosition {}

    Swift

    enum APSSkipOverlayProgressPosition : Int