VideoController

public final class VideoController

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

概要

ネストされた型

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

パブリック メソッド
@Nullable VideoController.VideoLifecycleCallbacks

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

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

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

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

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

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

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

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

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

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

パブリック メソッド

getVideoLifecycleCallbacks

public @Nullable VideoController.VideoLifecycleCallbacks getVideoLifecycleCallbacks()

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

hasVideoContent

public boolean hasVideoContent()

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

isClickToExpandEnabled

public boolean isClickToExpandEnabled()

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

isCustomControlsEnabled

public boolean isCustomControlsEnabled()

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

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

現時点では、カスタム コントロールはアド マネージャーの純広告でのみご利用いただけます。

isMuted

public boolean isMuted()

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

ミュート

public void mute(boolean mute)

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

この動画操作方法は、isCustomControlsEnabled が true を返す場合にのみ機能します。

パラメータ
boolean mute

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

一時停止

public void pause()

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

この動画操作方法は、isCustomControlsEnabled が true を返す場合にのみ機能します。

再生

public void play()

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

この動画操作方法は、isCustomControlsEnabled が true を返す場合にのみ機能します。

setVideoLifecycleCallbacks

public void setVideoLifecycleCallbacks(
    @Nullable VideoController.VideoLifecycleCallbacks callbacks
)

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

パラメータ
@Nullable VideoController.VideoLifecycleCallbacks callbacks

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

停止

public void stop()

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

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