VideoController

class VideoController


動画広告の再生コントロールを提供するオブジェクト。

概要

ネストされた型

動画広告のライフサイクル イベントの更新を受け取るためのコールバック。

パブリック関数

VideoController.VideoLifecycleCallbacks?

以前に提供された VideoLifecycleCallbacks を返します。インスタンスが提供されていない場合は null を返します。

Boolean

現在の広告に動画コンテンツが含まれている場合は true を返します。

Boolean

動画広告でクリックして展開する動作が使用されている場合は true を返します。

Boolean

動画広告でカスタム プレーヤー コントロールが使用されている場合は true を返します。

Boolean

動画が現在ミュートされている場合は true、そうでない場合は false を返します。

Unit
mute(mute: Boolean)

動画のミュート状態を設定します。

Unit

該当する場合は動画広告を一時停止します。

Unit

該当する場合は動画広告を再生します。

Unit

動画イベントのコールバックを受信するリスナーを設定します。

Unit

動画の再生を停止します。

パブリック関数

getVideoLifecycleCallbacks

fun getVideoLifecycleCallbacks(): VideoController.VideoLifecycleCallbacks?

以前に提供された VideoLifecycleCallbacks を返します。インスタンスが提供されていない場合は null を返します。

hasVideoContent

fun hasVideoContent(): Boolean

現在の広告に動画コンテンツが含まれている場合は true を返します。

isClickToExpandEnabled

fun isClickToExpandEnabled(): Boolean

動画広告でクリックして展開する動作が使用されている場合は true を返します。

isCustomControlsEnabled

fun isCustomControlsEnabled(): Boolean

動画広告でカスタム プレーヤー コントロールが使用されている場合は true を返します。カスタム プレーヤー コントロールを使用する場合、再生/一時停止およびミュート/ミュート解除のコントロールをレンダリングして提供し、適切なタイミングで playpausemute を呼び出すのはアプリの責任です。

setCustomControlsRequested を使用してカスタム コントロールを有効にします。

カスタム コントロールは現在、アド マネージャーの純広告でのみ使用できます。

isMuted

fun isMuted(): Boolean

動画が現在ミュートされている場合は true、そうでない場合は false を返します。

ミュート

fun mute(mute: Boolean): Unit

動画のミュート状態を設定します。

この動画制御メソッドは、isCustomControlsEnabled が true を返す場合にのみ機能します。

パラメータ
mute: Boolean

動画をミュートする場合は true、ミュートしない場合は false

一時停止

fun pause(): Unit

該当する場合は動画広告を一時停止します。動画がすでに一時停止している場合や、動画が終了している場合、このメソッドは何もしません。

この動画制御メソッドは、isCustomControlsEnabled が true を返す場合にのみ機能します。

再生

fun play(): Unit

該当する場合は動画広告を再生します。動画がすでに再生中の場合、このメソッドは何もしません。

この動画制御メソッドは、isCustomControlsEnabled が true を返す場合にのみ機能します。

setVideoLifecycleCallbacks

fun setVideoLifecycleCallbacks(
    callbacks: VideoController.VideoLifecycleCallbacks?
): Unit

動画イベントのコールバックを受信するリスナーを設定します。

パラメータ
callbacks: VideoController.VideoLifecycleCallbacks?

ライフサイクル コールバックを受け取るオブジェクト

停止

fun stop(): Unit

動画の再生を停止します。その後の play の呼び出しは、動画の先頭から再開されます。動画がすでに停止している場合、このメソッドは何もしません。

この API を使用するには、広告ユニットが許可リストに登録されている必要があります。この機能の使用をご希望の場合は、アカウント マネージャーにお問い合わせください。