ima/com.brightcove.ima/GoogleIMAComponent

GoogleIMAComponent

open class GoogleIMAComponent : BaseIMAComponent

Constructors

constructor(baseVideoView: BaseVideoView, eventEmitter: EventEmitter)

constructor(baseVideoView: BaseVideoView, eventEmitter: EventEmitter, useAdRules: Boolean, imaSdkSettings: ImaSdkSettings, adsRenderingSettings: AdsRenderingSettings)

constructor(baseVideoView: BaseVideoView, eventEmitter: EventEmitter, useAdRules: Boolean, imaSdkSettings: ImaSdkSettings)

constructor(baseVideoView: BaseVideoView, eventEmitter: EventEmitter, useAdRules: Boolean, adsRenderingSettings: AdsRenderingSettings)

constructor(baseVideoView: BaseVideoView, eventEmitter: EventEmitter, useAdRules: Boolean)

constructor(baseVideoView: BaseVideoView, eventEmitter: EventEmitter, imaSdkSettings: ImaSdkSettings)

Types

Builder

open class Builder

Properties

AD_EVENT

val AD_EVENT: String = "adEvent"

val ~~AD_EVENT~~: String = "adEvent"

AD_PLAYHEAD_POSITION

val AD_PLAYHEAD_POSITION: String = "adPlayheadPosition"

val ~~AD_PLAYHEAD_POSITION~~: String = "adPlayheadPosition"

AD_TAG_URL

val AD_TAG_URL: String = "adTagUrl"

val ~~AD_TAG_URL~~: String = "adTagUrl"

AD_WAS_PLAYING

val AD_WAS_PLAYING: String = "adWasPlaying"

val ~~AD_WAS_PLAYING~~: String = "adWasPlaying"

ADS_MANAGER

val ADS_MANAGER: String = "adsManager"

val ~~ADS_MANAGER~~: String = "adsManager"

ADS_REQUESTS

val ADS_REQUESTS: String = "adsRequests"

val ~~ADS_REQUESTS~~: String = "adsRequests"

imaAnalytics

open var imaAnalytics: IMAAnalytics

TAG_FOR_USERS_UNDER_AGE

val TAG_FOR_USERS_UNDER_AGE: String = "tfua"

IMA tag for users under the edge consent in Europe(TFUA)

TAG_GOOGLE_RDP_SIGNAL

val TAG_GOOGLE_RDP_SIGNAL: String = "rdp"

IMA tag to use Google signal for RDP

TAG_IAB_RDP_SIGNAL

val TAG_IAB_RDP_SIGNAL: String = "us_privacy"

IMA tag to use IAB signal for RDP

TAG_LIMITED_ADS

val TAG_LIMITED_ADS: String = "ltd"

IMA tag to serve limited ads

TAG_NON_PERSONALIZED_ADS

val TAG_NON_PERSONALIZED_ADS: String = "npa"

IMA tag for Non-personalized ads

Functions

addCallback

open fun addCallback(callback: VideoAdPlayerCallback)

clean

open fun clean()

Releases the resources created in this component.

getAdDisplayContainer

open fun getAdDisplayContainer(): AdDisplayContainer

Returns the current AdDisplayContainer, or null if it has not been created yet.

getAdPosition

open fun ~~getAdPosition~~(): Int

Deprecated.

getAdPositionLong

open fun getAdPositionLong(): Long

getAdsRenderingSettings

open fun getAdsRenderingSettings(): AdsRenderingSettings

getContentPosition

open fun ~~getContentPosition~~(): Int

getContentPositionLong

open fun getContentPositionLong(): Long

getContentProgress

open fun getContentProgress(): VideoProgressUpdate

getCurrentAdIndex

open fun getCurrentAdIndex(): Int

getCurrentAdsRequests

open fun getCurrentAdsRequests(): List<AdsRequest>

getImaSdkSettings

open fun getImaSdkSettings(): ImaSdkSettings

getSupportedProgressiveMimeTypes

open fun getSupportedProgressiveMimeTypes(): List<String>

getVideoAdPlayer

open fun getVideoAdPlayer(): GoogleIMAVideoAdPlayer

Returns the current GoogleIMAVideoAdPlayer, or null if it has not been created yet.

initializeAdsRequests

open fun ~~initializeAdsRequests~~()

isPlayingAd

open fun isPlayingAd(): Boolean

onAdError

open fun onAdError(event: AdErrorEvent)

onAdEvent

open fun onAdEvent(event: AdEvent)

onAdsManagerLoaded

open fun onAdsManagerLoaded(event: AdsManagerLoadedEvent)

onContentPauseRequested

open fun onContentPauseRequested()

onContentResumeRequested

open fun onContentResumeRequested()

reloadAdsRequest

open fun reloadAdsRequest()

Creates a request to reload the Ads.

removeCallback

open fun removeCallback(callback: VideoAdPlayerCallback)

setAdPosition

open fun setAdPosition(adPosition: Long)

setContentPosition

open fun setContentPosition(position: Long)

setSpringServeMacrosMap

open fun setSpringServeMacrosMap(springServeMacros: HashMap<String, Any>)

skipCurrentAd

open fun skipCurrentAd()

skipCurrentAds

open fun skipCurrentAds()

updateAdTargetingValues

open fun updateAdTargetingValues(adTargetingValues: Map<String, String>)

Updates the key/value pairs used for audience segment targeting.

useAdRules

open fun useAdRules(useAdRules: Boolean)