AdPlaybackController

Объект предоставляет API для контроля над воспроизведением рекламы. Позволяет проиграть рекламу один раз. Для повторного проигрывания необходимо создать новый экземпляр AdPlaybackController.

Методы

Методы

Имя

Тип (Возвр.)

Описание

getAdContentSize ()

PublicAdContentSize

Возвращает текущие размеры рекламы.

getAdPlayingState ()

PublicAdPlayingState

Возвращает текущее состояние проигрывания рекламы.

getAdSkippableState ()

boolean

Возможность пропуска креатива.

pauseAd ()

void

Приостанавливает проигрывание рекламы.

playAd ()

void

Запускает проигрывание рекламы.

Важно

Метод может вызываться только один раз, все последующие вызовы будут проигнорированы.

resumeAd ()

void

Продолжает проигрывание рекламы.

skipAd ()

void

Пропускает всю рекламу сразу (все AdPod). Перед вызовом метода плееру необходимо убедиться, что метод getAdSkippableState возвращает значение true.

stopAd ()

void

Останавливает проигрывание рекламы.

subscribe
(AdPlaybackControllerSubscribeMethod)

Подписывает на рекламное событие.

getAdVolume

number

Возвращает текущую громкость в диапазоне [0; 1]. Реальная громкость будет возвращаться только после вызова метода playAd () и до уничтожения объекта. В любое другое время возвращается 0.

setAdVolume

void

Устанавливает громкость в диапазоне [0; 1]. Установка громкости доступна только после старта рекламы (метод playAd ()) и до ее окончания (событие AdStopped).

Внимание

Установка ненулевой громкости может привести к постановке видео на паузу, если видеоэлемент не активирован. Это связано с политиками автоматического воспроизведения в браузерах. Рекомендуется включать звук только по пользовательскому действию.

getAdVolumeAvailabilityState

boolean

Статус доступности регулировки громкости рекламы. Допустимые значения:

  • true — регулировка доступна;
  • false — регулировка недоступна.

Реальный статус доступен сразу после вызова метода playAd () и до уничтожения объекта. В любое другое время возвращается false.

Примечание

Статус возвращается независимо от видимости элементов регулировки громкости.

getAdPodTimeToSkip

Возвращает время до возможности пропуска креатива.

getAdRemainingTime

Возвращает оставшееся время воспроизведения всего блока рекламы.

getAdPodRemainingTime

Возвращает оставшееся время воспроизведения текущего рекламного креатива.

getAdDuration

Возвращает длительность всего блока рекламы.

getAdPodDuration

Возвращает длительность текущего рекламного креатива.

Предыдущая