IndustryIcon

public protocol IndustryIcon

Represents industry icon object that encapsulates data from the ‘icon’ eleemnt of a VAST Documnet. This graphic overlays a small section of the ad’s video and may be clickable.

  • The program represented in the icon (e.g. “AdChoices”).

    Declaration

    Swift

    var program: String? { get }

  • The width of the icon asset.

    Declaration

    Swift

    var width: String? { get }

  • The height of the icon asset.

    Declaration

    Swift

    var height: String? { get }

  • The x-coordinate of the top, left corner of the icon asset relative to the ad display area. Values of “left” or “right” also accepted and indicate the leftmost or rightmost available position for the icon asset.

    Declaration

    Swift

    var xPosition: String? { get }

  • The y-coordinate of the top left corner of the icon asset relative to the ad display area. Values of “top” or “bottom” also accepted and indicate the topmost or bottommost available position for the icon asset.

    Declaration

    Swift

    var yPosition: String? { get }

  • The duration icon should be displayed unless clicked or ad is finished playing. Provided in the format HH:MM:SS.mmm or HH:MM:SS where .mmm is milliseconds (optional).

    Declaration

    Swift

    var duration: String? { get }

  • The time of delay from when the associated linear creative begins playing to when the icon should be displayed. Provided in the format HH:MM:SS.mmm or HH:MM:SS where .mmm is milliseconds (optional).

    Declaration

    Swift

    var offset: String? { get }

  • The apiFramework Identifies the API needed to execute the icon resource file if applicable.

    Declaration

    Swift

    var apiFramework: String? { get }

  • The alternative text for the image. In an html5 image tag this should be the text for the alt attribute. This should enable screen readers to properly read back a description of the icon for visually impaired users.

    Declaration

    Swift

    var altText: String? { get }

  • The URL of the image file for the icon (PNG is preferred).

    Declaration

    Swift

    var imageURL: String? { get }

  • It specifies the destination page URL to open when the user clicks on the industry icon. The output is eitther the click-through URL as a string or nil.

    Declaration

    Swift

    var clickThroughURL: String? { get }

  • The list of IconClickFallbackImage instances.

    Declaration

    Swift

    var fallbackImages: [IconClickFallbackImage]? { get }