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

Package-level declarations

Types

data class AdBreakInfo(val adBreakID: String, val contentTimePosition: AdContentTimePosition, val adSequencePosition: Int, val adBreakStartTimeOffsetMs: Double = TIME_VALUE_UNKNOWN, val remainingTimeMs: Double = TIME_VALUE_UNKNOWN, val durationMs: Double = TIME_VALUE_UNKNOWN, val totalAds: Int, val adBreakIndex: Int = VALUE_UNKNOWN) : Parcelable

Represents information about an Ad, and the Ad Break it is composed in.

AdComposedPlayer

interface AdComposedPlayer : Player, AdsManager

A Player that is composed of Main Content Playback and Ad Management functionality exposed via AdsManager.

AdContentTimePosition

enum AdContentTimePosition : Enum<AdContentTimePosition> , Parcelable

Represents an Ad position in a Video.

AdControllable

interface AdControllable

Represents AdComposedPlayer protocol to support ad playback's advanced scenarios.

AdEventListener

interface AdEventListener

Ad Player interface providing the client with the notification about the ad related events.

AdInfo

data class AdInfo(val adID: String, val sequence: Int, val adStartTimeOffsetMs: Double = TIME_VALUE_UNKNOWN, val durationMs: Double = TIME_VALUE_UNKNOWN, val remainingTimeMs: Double = TIME_VALUE_UNKNOWN, val isSkippable: Boolean = false, val skipOffsetMs: Double? = TIME_VALUE_UNKNOWN, val isFiller: Boolean = false, val adBreakInfo: AdBreakInfo? = null, val adVastProperties: AdVASTProperties? = null) : Parcelable

Represents information about a particular Ad in and Ad Break.

AdInsertionType

enum AdInsertionType : Enum<AdInsertionType>

Type of Ad insertion

AdOverlayUIScope

data class AdOverlayUIScope(val view: View, val uiScope: Int)

Provides the UI scope for an overlay view shown on top of an ad view group.

AdPlaybackPolicy

interface AdPlaybackPolicy

Policy rules for Ads handling.

AdProgressInfo

data class AdProgressInfo(val adBreakDurationMs: Long, val numberOfAds: Int, val currentAdPosition: Int, val currentAdDurationMs: Long, val currentAdProgressMs: Long)

Represents information about the progress within a particular Ad Break.

AdRequest

interface AdRequest

Represents base Ads request.

AdsManager

interface AdsManager

Manages some aspects of ad playback.

AdTrackingEvent

enum AdTrackingEvent : Enum<AdTrackingEvent>

Represents Ad state tracking events.

AdVASTProperties

data class AdVASTProperties(val adSystem: String? = null, val adTitle: String? = null, val adServingId: String? = null, val adId: String? = null, val creativeId: String? = null, val category: String? = null, val description: String? = null, val advertiser: String? = null, val pricing: String? = null, val survey: String? = null, val expires: String? = null, val industryIcons: List<IndustryIcon>? = emptyList(), val companionAds: List<CompanionAd>? = emptyList(), val extensions: Extensions? = null)

Represents key VAST properties to be shared with all registered analytics providers.

CompanionAd

data class CompanionAd(val width: Int? = 0, val height: Int? = 0, val resourceURI: String? = null, val altText: String? = null, val clickThroughURL: String? = null, val clickTrackingURL: String? = null, val apiFramework: String? = null)

Representation of VAST document's element.

ContentTimeline

data class ContentTimeline(val timeOffsetBeforeContentStartMs: Long = DEFAULT_LONG_VAL, val timeOffsetInContentMs: Long = DEFAULT_LONG_VAL, val timeOffsetAfterContentEndMs: Long = DEFAULT_LONG_VAL)

Represents main content timeline offsets for a VOD stream with ads.

Extensions

data class Extensions(val clickFallbackImages: List<IconClickFallbackImage> = emptyList())

Represents the custom VAST extensions properties.

IconClickFallbackImage

data class IconClickFallbackImage(val width: String, val height: String, val altText: String? = null, val imageURL: String? = null, val program: String? = null)

In cases where the icon representing the cause for ad showing can not display the "Ad Settings" page, such as when the platform does not support a browser, shows users a fallback image that contains the same disclosure information as the "Ad Settings" page. When an icon click occurs, the ad must pause and the image must be rendered above the video. The player must provide a means for the user to close the dialogue, for example by pressing the back button. The image must not be obstructed and should not be downloaded unless a click-action occurs. obstructed and should not be downloaded unless a click-action occurs.

IconClickFallbackImageProperty

enum IconClickFallbackImageProperty : Enum<IconClickFallbackImageProperty>

IMAAdUIVisibilityPreference

enum IMAAdUIVisibilityPreference : Enum<IMAAdUIVisibilityPreference>

Represents the Ad UI element visibility preference that determines if a given element should be visible or not during Ad playback.

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.

IndustryIconProperty

enum IndustryIconProperty : Enum<IndustryIconProperty>

Represents IndustryIcon property name

Properties

DEFAULT_TIME_POSITION_POSTROLL

const val DEFAULT_TIME_POSITION_POSTROLL: Long

PARAM_AD_BREAK_INFO

const val PARAM_AD_BREAK_INFO: String

PARAM_AD_INFO

const val PARAM_AD_INFO: String

TEXT_VALUE_UNKNOWN

const val TEXT_VALUE_UNKNOWN: String

TIME_VALUE_UNKNOWN

const val TIME_VALUE_UNKNOWN: Double

VALUE_UNKNOWN

const val VALUE_UNKNOWN: Int

Functions

contentTimeToAdContentTimePosition

fun contentTimeToAdContentTimePosition(timeOffset: Double): AdContentTimePosition