Методы плеера

Вы можете управлять видеоплеером Cloud Video Player с использованием методов SDK для JavaScript:

setSourcesetSource

Переключает контент.

Пример простого переключения контента:

player.setSource('https://runtime.video.cloud.yandex.net/player/...');

Где https://runtime.video.cloud.yandex.net/player/... — ссылка на воспроизводимый контент, например https://runtime.video.cloud.yandex.net/player/video/vplvmyqsxi7dlwndvb4y. Подробнее см. в разделах Получить код вставки или ссылку на видео и Получить код вставки или ссылку на трансляцию.

Пример переключения контента с установкой стартовой позиции и выключенным автовоспроизведением:

player.setSource({
    source: 'https://runtime.video.cloud.yandex.net/player/...',
    startPosition: 10,
    autoplay: false
});

В примере в качестве параметра передается объект формата:

{
    /** @type {string} ссылка на воспроизводимый контент */
    source,
    /**
     * @type {boolean} (необязательный параметр) автовоспроизведение при переключении на контент.
     * по умолчанию сохраняется состояние воспроизведения на момент вызова метода.
     * Автоплей может не сработать. См. https://developer.chrome.com/blog/autoplay/
     * autoplay
     */
    autoplay,
    /** @type {number} (необязательный параметр, по умолчанию 0) стартовая позиция в секундах */
    startPosition,
}

Метод возвращает промис (promise), который:

• переводится в состояние fulfilled, если переключение прошло успешно;
• переводится в состояние rejected, если переключение завершилось ошибкой. Например, в случае если контент с заданным id не найден.

getStategetState

Возвращает состояние плеера в виде объекта, формат которого описан в разделе Состояние плеера.

Пример использования:

var state = player.getState();

playplay

Запускает воспроизведение.

Метод возвращает промис (promise), который:

• переводится в состояние fulfilled, если воспроизведение началось;
• переводится в состояние rejected, если запустить воспроизведение не удалось.

pausepause

Ставит воспроизведение на паузу.

seekseek

Перематывает видео в заданную позицию, которая передается в качестве параметра.

Пример перемотки видео на 10-ю секунду:

player.seek(10);

setMutedsetMuted

Выключает/включает звук.

В качестве параметра передается значение типа boolean.

Пример включения звука:

player.setMuted(false);

setVolumesetVolume

Устанавливает уровень громкости звука видео в диапазоне от 0 (звук не слышен) до 1 (максимальная громкость).

Пример:

player.setVolume(0.7);

on/onceon/once

Позволяет подписаться на события плеера.

При вызове once подписка действует только на первое срабатывание события, при вызове on — на все срабатывания.

Методы имеют сигнатуру on(eventName, handler) и once(eventName, handler). Первым параметром передается название события, вторым — обработчик.

В обработчик передается объект с соответствующим событию полем из состояния плеера.

Пример подписки на все срабатывания события изменения статуса воспроизведения StatusChange:

player.on('StatusChange', ({ status }) => {
    console.log(status);
});

offoff

Позволяет отписаться от событий плеера, на которые с помощью методов on или once была выполнена подписка.

Метод имеет сигнатуру off(eventName, handler). Первым параметром передается название события, вторым — обработчик, который использовался ранее для подписки.

Пример отписки от функции-обработчика с названием handler для события изменения статуса воспроизведения StatusChange:

player.off('StatusChange', handler);

destroydestroy

Уничтожает (destroy) плеер и освобождает ресурсы.

Возвращает промис (promise), который переводится в состояние fulfilled после завершения выполнения операции.

Пример использования:

player.destroy();

См. такжеСм. также

• Interface: PlayerSdkApi в справочнике API