ogplayer-core/com.ogplayer.api.ads/TimelineAdsProvider

TimelineAdsProvider

interface TimelineAdsProvider : AdsProvider

Providers that splice ads into the Media3 timeline (IMA). The content engine plays the ad media; the provider supplies the Media3 ads loader.

Functions

clickAd

open fun clickAd()

Opens the current ad's clickthrough, firing the provider's click tracking. Default no-op (IMA renders and handles its own click UI).

createAdsLoader

abstract fun createAdsLoader(callbacks: AdsProviderCallbacks): Any

Creates the underlying Media3 ads loader, reporting events through callbacks. Returns an androidx.media3.exoplayer.source.ads.AdsLoader.

focusUi

open fun focusUi(): Boolean

Remote-control UIs: moves the provider's OWN focus onto its interactive elements — IMA: the skip button when present, else its icons ("About this ad") — so a D-pad can operate them. Returns false when the provider has no such UI. Called by the SDK's TV chrome on a deliberate step.

release

abstract fun release()

Releases all provider resources. Called from OGPlayer.release().

setAdVolume

open fun setAdVolume(volume: Float, muted: Boolean)

The viewer changed the volume while this provider's ad is on screen. A provider that renders the creative in its OWN surface (FreeWheel) must apply it there — the content engine is held under the break, so changing its volume is inaudible. Default no-op: a provider whose ads play in the content engine (IMA) already follows it.

setPlayer

abstract fun setPlayer(player: Any?)

Attaches or detaches (null) the playback engine (androidx.media3.common.Player).

skipAd

open fun skipAd()

Skips the currently playing ad, if any and if it is skippable. Whether a programmatic skip is honored is provider-dependent.