Параметры инициализации плеера
При инициализации видеоплеера Cloud Video Player вы можете передать в него исходные параметры:
element
Элемент для вставки. Обязательный параметр. Это может быть либо указатель на HTMLElement
, либо id-селектор.
Примеры создания плеера:
-
с помощью передачи указателя:
var element = document.getElementById('video-player'); var player = Ya.playerSdk.init({ element, ...});
-
с помощью передачи id-селектора:
var player = Ya.playerSdk.init({ element: 'video-player', ...});
source
Ссылка на воспроизводимый контент.
Пример создания плеера:
var player = Ya.playerSdk.init({ ..., source: 'https://runtime.video.cloud.yandex.net/player/...', ...});
Где https://runtime.video.cloud.yandex.net/player/...
— ссылка на воспроизводимый контент, например https://runtime.video.cloud.yandex.net/player/video/vplvmyqsxi7dlwndvb4y
. Подробнее см. в разделах Получить код вставки или ссылку на видео и Получить код вставки или ссылку на трансляцию.
autoplay
Автовоспроизведение при загрузке контента.
В некоторых случаях автовоспроизведение может не сработать
По умолчанию автовоспроизведение включено.
Пример создания плеера с выключенным автовоспроизведением:
var player = Ya.playerSdk.init({ ..., autoplay: false, ...});
muted
Статус muted
(выключенного звука) при создании плеера. Значение true
— звук выключен, значение false
— включен.
Если звук включен, то автовоспроизведение может не сработать
Пример создания плеера с включенным звуком:
var player = Ya.playerSdk.init({ ..., muted: false, ...});
volume
Уровень громкости звука видео в диапазоне от 0
(звук не слышен) до 1
(максимальная громкость).
Значение по умолчанию — 1
.
Пример создания плеера со значением уровня звука 0.5
:
var player = Ya.playerSdk.init({ ..., volume: 0.5, ...});
startPosition
Стартовая позиция воспроизведения контента при загрузке (в секундах).
Значения по умолчанию:
- для типа видео
VOD
— начало видео (нулевая секунда); - для типа видео
LIVE
иEVENT
— прямой эфир.
Пример создания плеера со стартовой позицией 10
секунд:
var player = Ya.playerSdk.init({ ..., startPosition: 10, ...});
hiddenControls
С помощью параметра hiddenControls
можно скрыть элементы интерфейса плеера.
По умолчанию в плеере отображаются все элементы управления.
Значением может быть как массив элементов интерфейса, которые требуется скрыть, так и строка, в которой эти элементы перечислены через запятую.
Примеры:
-
скрыть кнопки воспроизведения/паузы и настроек c помощью передачи значения
hiddenControls
в строке:var player = Ya.playerSdk.init({ ..., hiddenControls: 'play,settings', ...});
-
скрыть кнопки воспроизведения/паузы и настроек c помощью передачи значения
hiddenControls
в массиве:var player = Ya.playerSdk.init({ ..., hiddenControls: ['play','settings'], ...});
-
Скрыть все элементы интерфейса можно с помощью мета-элемента
*
:var player = Ya.playerSdk.init({ ..., hiddenControls: '*', ...});
-
Скрыть все элементы интерфейса, за исключением заданного, можно с помощью оператора
!
. Например, этот код скроет все элементы управления, кроме кнопки воспроизведения/паузы:var player = Ya.playerSdk.init({ ..., hiddenControls: '*,!play', ...});
Элементы интерфейса, которые можно скрыть:
*
— все элементы интерфейса.play
— элемент интерфейса, в котором отображаются кнопки Воспроизвести, Пауза, Повторить. Отключает воспроизведение/паузу при нажатии на плеер.contextMenu
— контекстное меню.fullscreen
— кнопка перевода в полноэкранный режим.live
— кнопка Вернуться в эфир.mobileSeekButtons
— кнопки перемотки в мобильном интерфейсе.nextAdInfo
— время до старта показа рекламы.playbackRate
— скорость воспроизведения.poster
— постер.preloader
— спиннер загрузки.settings
— кнопка настроек.startScreen
— стартовый экран.startScreenPlay
— кнопка воспроизведения на стартовом экране.subtitlesToggle
— кнопка включения/выключения субтитров.timeline
— шкала времени. Отключает перемотку с клавиатуры или при нажатии на сенсорный экран.timelinePreview
— предварительный просмотр на шкале времени.time
— текущее время воспроизведения.title
— название видео.sound
— кнопка отключения звука.volumeSlider
— регулятор уровня громкости звука.
См. также
- Interface: PlayerSdkInitConfig в справочнике API
- Interface: PlayerSdkSourceParams в справочнике API