JWAdEventKey

@objc
public enum JWAdEventKey : Int, CaseIterable
extension JWAdEventKey: CustomStringConvertible

Keys into the JWAdEvent payload.

  • The position of the ad within the content.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a String.

    Declaration

    Swift

    case adPosition

  • Ad system referenced inside of the VAST XML.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a String.

    Declaration

    Swift

    case adSystem

  • The title of the ad.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a String.

    Declaration

    Swift

    case adTitle

  • The url which will be visited when the ad is tapped.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a String.

    Declaration

    Swift

    case clickThroughUrl

  • Descriptions of the ad’s companions.

    Note

    When used in conjunction with JWAdEvent, the value is returned as an array of JWAdCompanion.

    Declaration

    Swift

    case companions

  • The ad identifier.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a String.

    Declaration

    Swift

    case creativeAdId

  • The creative id.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a String.

    Declaration

    Swift

    case creativeId

  • The type of ad being displayed for the ad.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a String.

    Declaration

    Swift

    case creativetype
  • id

    A descriptive name of the ad.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a String.

    Declaration

    Swift

    case id
  • ima

    A verbose description of Google IMA properties.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a Dictionary.

    Declaration

    Swift

    case ima

  • A description of the ad impression.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a JWAdImpression.

    Declaration

    Swift

    case impression

  • A value indicating whether the ad is linear or nonlinear. Nonlinear ads are not supported in the SDK.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a String.

    Declaration

    Swift

    case linear

  • Object containing the metadata from the ad. The values contained within the object will vary based on the ad.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a Dictionary.

    Declaration

    Swift

    case metadata

  • The new state of the ad.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a String.

    Declaration

    Swift

    case newState

  • Tne old state of the ad prior to the current event.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a String.

    Declaration

    Swift

    case oldState

  • The reason for pausing.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a JWPauseReason.

    Declaration

    Swift

    case pauseReason

  • Value sent in a bid request that identifies the location of a player.

    Note

    When used in conjunction with JWAdEvent, the value is returned as an Int.

    Declaration

    Swift

    case placement

  • The reason for playing.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a JWPlayReason.

    Declaration

    Swift

    case playReason

  • The pod count total.

    Note

    When used in conjunction with JWAdEvent, the value is returned as an Int.

    Declaration

    Swift

    case podCount

  • The current playback position in the ad creative in seconds.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a Double.

    Declaration

    Swift

    case position

  • An array representing the schedule of the ads within the content, and information on each.

    Note

    When used in conjunction with JWAdEvent, the value is returned as an array of JWAdBreak.

    Declaration

    Swift

    case schedule

  • The index of the current ad in the ad pod.

    Note

    When used in conjunction with JWAdEvent, the value is returned as an Int.

    Declaration

    Swift

    case sequence

  • The number of seconds before the user is allowed to skip the ad.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a Double.

    Declaration

    Swift

    case skipOffset
  • tag

    The URL of the ad tag.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a URL.

    Declaration

    Swift

    case tag

  • The type of creative being displayed.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a String.

    Declaration

    Swift

    case type

  • Whether or not the player is currently visible. A 0 indicates it is 50% or less viewable, while a 1 indicates it is 50% or greater viewable.

    Note

    When used in conjunction with JWAdEvent, the value is returned as an Int.

    Declaration

    Swift

    case viewable
  • xml

    The raw VAST XML string.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a String. Only available for JWPlayer Ads.

    Declaration

    Swift

    case xml

  • Time the ad took to load in milliseconds.

    Note

    When used in conjunction with JWAdEvent, the value is returned as a Double. Only available for JWPlayer Ads.

    Declaration

    Swift

    case timeLoading

  • Returns a string describing the constant

    Declaration

    Swift

    public var description: String { get }