VideoController
class VideoController
Obiekt, który umożliwia sterowanie odtwarzaniem reklam wideo.
Podsumowanie
Zagnieżdżone typy |
|---|
abstract class VideoController.VideoLifecycleCallbacksWywołanie zwrotne do otrzymywania aktualizacji dotyczących zdarzeń związanych z cyklem życia reklamy wideo. |
Funkcje publiczne |
|
|---|---|
VideoController.VideoLifecycleCallbacks? |
Zwraca wcześniej podany element |
Boolean |
Zwraca wartość „prawda”, jeśli bieżąca reklama zawiera treści wideo. |
Boolean |
Zwraca wartość „true” (prawda), jeśli reklama wideo korzysta z funkcji kliknięcia w celu rozwinięcia. |
Boolean |
Zwraca wartość „true” (prawda), jeśli reklama wideo korzysta z niestandardowych elementów sterujących odtwarzaniem. |
Boolean |
isMuted()Zwraca wartość true, jeśli film jest aktualnie wyciszony, w przeciwnym razie zwraca wartość false. |
Unit |
Ustawia stan wyciszenia filmu. |
Unit |
pause()Wstrzymuje reklamę wideo (w odpowiednich przypadkach). |
Unit |
play()W odpowiednich przypadkach odtwórz reklamę wideo. |
Unit |
Ustawia odbiornik, który będzie otrzymywać wywołania zwrotne w przypadku zdarzeń wideo. |
Unit |
stop()Zatrzymuje odtwarzanie filmu. |
Funkcje publiczne
getVideoLifecycleCallbacks
fun getVideoLifecycleCallbacks(): VideoController.VideoLifecycleCallbacks?
Zwraca wcześniej podany element VideoLifecycleCallbacks lub wartość null, jeśli nie podano żadnego wystąpienia.
hasVideoContent
fun hasVideoContent(): Boolean
Zwraca wartość „prawda”, jeśli bieżąca reklama zawiera treści wideo.
isClickToExpandEnabled
fun isClickToExpandEnabled(): Boolean
Zwraca wartość „true” (prawda), jeśli reklama wideo korzysta z funkcji kliknięcia w celu rozwinięcia.
isCustomControlsEnabled
fun isCustomControlsEnabled(): Boolean
Zwraca wartość „true” (prawda), jeśli reklama wideo korzysta z niestandardowych elementów sterujących odtwarzaniem. Jeśli używane są niestandardowe elementy sterujące odtwarzaniem, aplikacja musi renderować elementy sterujące odtwarzaniem i wstrzymywaniem oraz wyciszaniem i wyłączaniem wyciszenia, a także wywoływać funkcje play, pause i mute w odpowiednich momentach.
Użyj setCustomControlsRequested, aby włączyć niestandardowe elementy sterujące.
Niestandardowe elementy sterujące są obecnie dostępne tylko w przypadku rezerwacji w usłudze Ad Manager.
isMuted
fun isMuted(): Boolean
Zwraca wartość true, jeśli film jest aktualnie wyciszony, w przeciwnym razie zwraca wartość false.
wycisz
fun mute(mute: Boolean): Unit
Ustawia stan wyciszenia filmu.
Ta metoda sterowania wideo działa tylko wtedy, gdy funkcja isCustomControlsEnabled zwraca wartość true.
| Parametry | |
|---|---|
mute: Boolean |
wartość „true”, jeśli film ma być wyciszony, lub „false”, jeśli ma być odtwarzany z dźwiękiem. |
wstrzymaj
fun pause(): Unit
Wstrzymuje reklamę wideo (w odpowiednich przypadkach). Ta metoda nie ma wpływu na działanie, jeśli film jest już wstrzymany lub zakończył się.
Ta metoda sterowania wideo działa tylko wtedy, gdy funkcja isCustomControlsEnabled zwraca wartość true.
odtwórz
fun play(): Unit
W odpowiednich przypadkach odtwórz reklamę wideo. Jeśli film jest już odtwarzany, ta metoda nie ma żadnego efektu.
Ta metoda sterowania wideo działa tylko wtedy, gdy funkcja isCustomControlsEnabled zwraca wartość true.
setVideoLifecycleCallbacks
fun setVideoLifecycleCallbacks(
callbacks: VideoController.VideoLifecycleCallbacks?
): Unit
Ustawia odbiornik, który będzie otrzymywać wywołania zwrotne w przypadku zdarzeń wideo.
| Parametry | |
|---|---|
callbacks: VideoController.VideoLifecycleCallbacks? |
obiekt, który ma otrzymywać wywołania zwrotne cyklu życia; |
zatrzymaj
fun stop(): Unit
Zatrzymuje odtwarzanie filmu. Kolejne połączenia z play będą wznawiane na początku filmu. Jeśli film został już zatrzymany, ta metoda nie ma żadnego efektu.
Aby można było używać tego interfejsu API, jednostka reklamowa musi znajdować się na liście dozwolonych. Jeśli chcesz korzystać z tej funkcji, skontaktuj się z menedżerem konta.