library-core/com.naver.gfpsdk/BaseInStreamAdManager

BaseInStreamAdManager

abstract class BaseInStreamAdManager( context: Context, adParamArg: AdParam, adVideoPlayer: AdVideoPlayer, adContainer: FrameLayout?, linearAdType: LinearAdType = LinearAdType.PRE_ROLL, playTimeOffsetMillis: Long = 0) : GfpVideoAd

Base class for managing in-stream video ads. Handles the lifecycle and events of video ads, including loading, playing, and tracking.

Constructors

BaseInStreamAdManager

constructor( context: Context, adParamArg: AdParam, adVideoPlayer: AdVideoPlayer, adContainer: FrameLayout?, linearAdType: LinearAdType = LinearAdType.PRE_ROLL, playTimeOffsetMillis: Long = 0)

Types

object Companion

OnStartListener

fun interface OnStartListener

Interface for handling ad start events.

Properties

var timeoutMillis: Long

Timeout duration for ad operations in milliseconds

Functions

fun adClicked()

Called when the video ad is clicked.

fun adCompleted()

Called when video ad playback completes.

fun adError(error: GfpError)

Called when an error occurs after video ad is loaded.

Called when video ad playback is paused.

fun adResumed()

Called when video ad playback is resumed.

fun adSkipped()

Called when video ad is skipped.

fun adStarted()

Called when video ad playback starts.

fun changedState(stateLog: StateLogCreator.StateLog?)

Called when state changes occur.

open override fun clickVideoAd()

Clicks on the button

Destroys the ad manager and releases all resources.

fun failedToLoad(error: GfpError)

Called when video ad fails to load.

fun failedToLog(url: String?, errorMessage: String?)

Called when event logging fails.

open override fun getAdParam(): AdParam

Returns a AdParam used to request advertising

getAdProviderName

open override fun getAdProviderName(): String?

Returns the ad provider's name for the loaded ad. Returns null until the ad successfully loads.

open override fun getAdQoeInfo(): GfpVideoAdQoeInfo?

Returns the quality of experience.

getLoudnessInfo

open override fun getLoudnessInfo(): String?

Returns the loudness information

getMutableParam

abstract fun getMutableParam(): VideoAdMutableParam

Gets the mutable parameters for video ad. Must be implemented by subclasses.

getNonLinearAdInfo

open override fun getNonLinearAdInfo(): NonLinearAdInfo?

Returns the information of the non linear ad.

getNoticeDurationMillis

open override fun getNoticeDurationMillis(): Long

Return the reminder phrase time offset of the mid term ad

getResponseInfo

open override fun getResponseInfo(): GfpResponseInfo?

Returns the GfpResponseInfo object for the loaded ad. Returns null until the ad successfully loads.

getTimeOffsetMillis

open override fun getTimeOffsetMillis(): Long

Returns the current time of linear video ad in milliseconds

getVideoAdOptions

fun getVideoAdOptions(): GfpVideoAdOptions

Gets the current video ad options. Creates default options if none are set.

getVideoMediaInfo

open override fun ~~getVideoMediaInfo~~(): VideoMediaInfo?

Returns the media information of the linear ad.

open override fun hideOverlayUi()

Hides the overlay ui of the video ad.

open fun loadAd()

Loads a instream video ad.

open override fun pause()

Pauses the video ad.

open override fun resume()

Resumes the video ad.

fun setAdContainer(adContainer: FrameLayout?)

Changes the ad container (e.g., PIP, END, AUDIO).

fun setAdListener(listener: VideoAdListener?)

Sets the video ad listener.

setEventUrlLogListener

fun setEventUrlLogListener(eventUrlLogListener: EventUrlLogListener?)

Sets the event URL log listener.

setGfpVideoProperties

abstract fun setGfpVideoProperties(gfpVideoProperties: <Error class: unknown class>?)

Sets the video properties. Must be implemented by subclasses.

setNoticeDurationMillis

fun setNoticeDurationMillis(noticeDurationMillis: Long)

Sets the duration for notice display.

setOnStartListener

fun setOnStartListener(startListener: BaseInStreamAdManager.OnStartListener)

Sets the start listener.

fun setQoeListener(listener: GfpVideoAdQoeListener?)

Sets the QoE listener for video ad events.

setStateLogListener

fun setStateLogListener(stateLogListener: StateLogListener?)

Sets the state log listener.

setVideoAdOptions

fun setVideoAdOptions(videoAdOptions: GfpVideoAdOptions?)

Sets the video ad rendering options.

showNonLinearAd

open override fun showNonLinearAd(containerType: GfpNonLinearAdView.ContainerType?)

Shows the non linear ad.

open override fun showOverlayUi()

Shows the overlay ui of the video ad.

open override fun skip()

Skips the video ad.

open override fun start(enabled: Boolean)

Starts playing the video ad.

fun successToLoad(controller: InStreamVideoPlayerController)

Called when video ad is successfully loaded.

fun successToLog(url: String?)

Called when event logging is successful.