Видеоконтроллер
class VideoController
Объект, обеспечивающий управление воспроизведением видеорекламы.
Краткое содержание
Вложенные типы |
|---|
abstract class VideoController.VideoLifecycleCallbacksФункция обратного вызова для получения обновлений о событиях жизненного цикла видеорекламы. |
Общественные функции | |
|---|---|
VideoController.VideoLifecycleCallbacks ? | Возвращает ранее предоставленный объект |
Boolean | Возвращает true, если текущая реклама содержит видеоконтент. |
Boolean | Возвращает true, если видеореклама использует механизм «кликнуть для развертывания». |
Boolean | Возвращает true, если в видеорекламе используются пользовательские элементы управления проигрывателем. |
Boolean | isMuted ()Возвращает true, если видео в данный момент отключено, false в противном случае. |
Unit | Устанавливает состояние отключения звука видео. |
Unit | pause ()При необходимости приостанавливает показ рекламного ролика. |
Unit | play ()Если это применимо, воспроизведите видеоролик. |
Unit | setVideoLifecycleCallbacks (Устанавливает обработчик событий, который будет получать обратные вызовы для видеособытий. |
Unit | stop ()Останавливает воспроизведение видео. |
Общественные функции
getVideoLifecycleCallbacks
fun getVideoLifecycleCallbacks(): VideoController.VideoLifecycleCallbacks?
Возвращает ранее предоставленный объект VideoLifecycleCallbacks или null, если экземпляр не был предоставлен.
hasVideoContent
fun hasVideoContent(): Boolean
Возвращает true, если текущая реклама содержит видеоконтент.
isClickToExpandEnabled
fun isClickToExpandEnabled(): Boolean
Возвращает true, если видеореклама использует механизм «кликнуть для развертывания».
isCustomControlsEnabled
fun isCustomControlsEnabled(): Boolean
Возвращает true, если в видеорекламе используются пользовательские элементы управления плеером. Если используются пользовательские элементы управления плеером, то приложение само отвечает за отображение, предоставление элементов управления воспроизведением/паузой и отключением/включением звука, а также за вызов функций play , pause и mute в соответствующие моменты.
Используйте setCustomControlsRequested , чтобы включить пользовательские элементы управления.
В настоящее время настраиваемые параметры доступны только для резервирования в Ad Manager.
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 рекламный блок должен быть в списке разрешенных. Если вас интересует использование этой функции, свяжитесь со своим менеджером по работе с клиентами.