VideoController

Kotlin |Java

public final class VideoController

---

提供影片廣告播放控制選項的物件。

摘要

巢狀類型
public abstract class VideoController.VideoLifecycleCallbacks 用於接收影片廣告生命週期事件更新的回呼。

公用方法
@Nullable VideoController.VideoLifecycleCallbacks	getVideoLifecycleCallbacks() 傳回先前提供的 VideoLifecycleCallbacks，如果未提供例項，則傳回空值。
boolean	hasVideoContent() 如果目前的廣告含有影片內容，則傳回 true。
boolean	isClickToExpandEnabled() 如果影片廣告使用點選展開行為，系統會傳回 true。
boolean	isCustomControlsEnabled() 如果影片廣告使用自訂播放器控制項，則會傳回 true。
boolean	isMuted() 如果影片目前已靜音，則傳回 true，否則傳回 false。
void	mute(boolean mute) 設定影片靜音狀態。
void	pause() 暫停影片廣告 (如適用)。
void	play() 播放影片廣告 (如適用)。
void	setVideoLifecycleCallbacks(     @Nullable VideoController.VideoLifecycleCallbacks callbacks ) 設定會接收影片事件回呼的監聽器。
void	stop() 停止播放影片。

公用方法

getVideoLifecycleCallbacks

public @Nullable VideoController.VideoLifecycleCallbacks getVideoLifecycleCallbacks()

傳回先前提供的 VideoLifecycleCallbacks，如果未提供例項，則傳回空值。

hasVideoContent

public boolean hasVideoContent()

如果目前的廣告含有影片內容，則傳回 true。

isClickToExpandEnabled

public boolean isClickToExpandEnabled()

如果影片廣告使用點選展開行為，系統會傳回 true。

isCustomControlsEnabled

public boolean isCustomControlsEnabled()

如果影片廣告使用自訂播放器控制項，則會傳回 true。如果使用自訂播放器控制項，應用程式必須負責顯示播放/暫停和靜音/取消靜音控制項，並在適當時間呼叫 play、pause 和 mute。

使用 setCustomControlsRequested 啟用自訂控制項。

自訂控制項目前僅適用於 Ad Manager 預訂。

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。如要使用這項功能，請與客戶經理聯絡。