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

SlotAdsProvider

interface SlotAdsProvider : AdsProvider

Providers that play ads in their own renderer over the content surface (FreeWheel). Content pauses underneath; the SDK core orchestrates the session through SlotAdsHost and receives events through SlotAdsProviderCallbacks.

Contract: after startSession the provider MUST eventually call host.resumeContent() exactly once per content gate — after prerolls complete, after an empty schedule, or after a failed or timed-out ad request. Core never self-starts content and adds no hidden timeouts; the provider owns its failure modes.

Functions

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

abstract fun onContentEnded()

Content reached its end — the provider plays postrolls (if any) and then calls callbacks.onAllAdsCompleted().

onContentPlaybackChanged

abstract fun onContentPlaybackChanged(isPlaying: Boolean)

Content play/pause state changes (drives provider video-state sync).

onContentProgress

abstract fun onContentProgress(positionMs: Long, durationMs: Long)

Content progress feed (core ticker) — drives midroll triggering.

abstract fun onContentSeek(fromPositionMs: Long, toPositionMs: Long)

A content seek happened — drives crossed-midroll catch-up.

abstract fun pauseAd()

Pauses the currently playing ad slot (OGPlayer.pause() during a break).

abstract fun release()

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

abstract fun resumeAd()

Resumes the currently paused ad slot (OGPlayer.play() during a break).

abstract fun setAdOverlay(viewGroup: ViewGroup?)

The ViewGroup ads render into (set/cleared by the UI layer via core).

open fun skipAd()

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

abstract fun startSession(host: SlotAdsHost, callbacks: SlotAdsProviderCallbacks, config: AdBreakConfig)

Begins an ad session for config (the OGMediaItem.adBreaks value).

abstract fun stopSession()

Ends the session: stops any playing slot, unregisters listeners, disposes provider-side contexts. Idempotent.