fl-player-interface/com.quickplay.vstb7.player.ad/IndustryIcon

IndustryIcon

data class IndustryIcon(val program: String? = null, val width: String? = null, val height: String? = null, val xPosition: String? = null, val yPosition: String? = null, val offset: String? = null, val duration: String? = null, val apiFramework: String? = null, val altText: String? = null, val imageURL: String? = null, val clickThroughURL: String, val fallbackImages: List<IconClickFallbackImage> = emptyList())

Represents VAST response metadata related to WTA (Why This Ad?) privacy disclosures. These disclosures are returned inside the IndustryIcon element of the VAST response. WTA related attributes are part of the relevant tag and are used to render the Industry icon.

Constructors

IndustryIcon

constructor(program: String? = null, width: String? = null, height: String? = null, xPosition: String? = null, yPosition: String? = null, offset: String? = null, duration: String? = null, apiFramework: String? = null, altText: String? = null, imageURL: String? = null, clickThroughURL: String, fallbackImages: List<IconClickFallbackImage> = emptyList())

Properties

altText

val altText: String? = null

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.

apiFramework

val apiFramework: String? = null

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

clickThroughURL

val clickThroughURL: String

The URL of the action that occurs when a user clicks the Industry icon. In most cases,the user sees the "Ad Settings" page. that the media player opens when the icon is clicked.

duration

val duration: String? = null

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).

fallbackImages

val fallbackImages: List<IconClickFallbackImage>

The IconClickFallbackImage instance.

height

val height: String? = null

The pixel height of the icon asset.

imageURL

val imageURL: String? = null

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

offset

val offset: String? = null

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).

program

val program: String? = null

The program represented in the icon.

width

val width: String? = null

The pixel width of the icon asset.

xPosition

val xPosition: String? = null

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.

yPosition

val yPosition: String? = null

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.