Команды JS API


JavaScript API позволяет получать события плеера, запрашивать данные и управлять им снаружи.

Команды ↓   События

Для управления плеером и получением данных используется оператор api

var player = new Playerjs({...});
console.log(player.api("id"));
player.api("play");
Некоторые команды могут содержать параметр, например
player.api("play","ссылка на файл");

Команда Параметр Действие Возвращает
play - запуск плеера* -
play ссылка на файл, плейлист или id: запуск файла* false или true для id:
pause - пауза -
toggle - пуск / пауза -
file ссылка на файл или плейлист обновление файла без запуска -
stop - стоп -
mute - выключение звука -
unmute - включение звука -
seek секунда перемотка (после запуска) -
fullscreen - полноэкранный режим** -
exitfullscreen - выход из полноэкранного режима -
isfullscreen - - включен или выключен полноэкранный режим (false или true)
playing - - включено или выключено воспроизведение (false или true)
started - - был ли запущен плеер (false или true)
time - - время воспроизведения в секундах
duration - - длительность в секундах
muted - - включен или выключен звук (false или true)
volume ничего или уровень громкости возвращает уровень громкости, либо устанавливает значение (от 0 до 1) уровень громкости (от 0 до 1)
quality ничего или номер варианта качества (0,1,2...)
- текущий вариант качества
qualities - - доступные варианты качества
audiotrack ничего или номер дорожки (0,1,2...) запускает аудиодорожку по номеру с версии 9.7 текущая аудиодорожка, если не задан параметр
audiotracks - - доступные аудиодорожки
speed  ничего или номер варианта скорости (0,1,2...)   текущая скорость
id - - идентификатор плеера
log - - лог плеера
screenshot - скриншот false или base64
subtitles - - доступные субтитры
subtitle ссылка или номер субтитров (-1,0,1,2...) запускает субтитры по ссылке или номеру (-1 выключает субтитры с версии 12) -
poster ссылка выводит заставку, если плеер стоит на паузе false или true
share - показывает экран с соц. сетями и кодом вставки плеера, если этот модуль включен в конструкторе -
title текст или ничего выводит надпись player.api("title","text"), либо возвращает значение player.api("title") значение title или true
playlist объект [ ] или ссылка обновляет плейлист  false или true
playlist_id - возвращает id файла из плейлиста идентификатор
playlist_title - возвращает название активного файла из плейлиста название
playlist_folders   возвращает массив данных о корневых папках плейлиста массив
playlist_length   возвращает количество позиций в плейлисте число
invert - разворачивает плейлист в обратном порядке -
autonext ничего или 0 или 1 запускать следующий файл в плейлисте (1), либо нет (0) 0 или 1, если не задан параметр
playlistloop ничего или 0 или 1 зацикливать плейлист (1), либо нет (0) 0 или 1, если не задан параметр
next - запускает следующий файл в плейлисте  -
prev - запускает предыдущий файл в плейлисте -
find id файла
открывает нужный файл из плейлиста и ждет запуска false или true
cuid значение cuid обновляет параметр cuid для запоминания времени -
showplaylist - показать плейлист -
moveplaylist id - перемещает плейлист наружу
scale шаг трансформации, либо формат, либо ничего изменяет масштаб видео (число с плавающей точкой), либо соотношение сторон для неправильно закодированных видео (ширина:высота, например 4:3 или 16:9)
если параметр не задан, возвращает массив с масштабом по ширине и высоте, а также координаты, если видео сдвинуто
points объект меток обновляет разметку содержания -
thumbnails ссылка на файл разметки миниатюр обновляет миниатюры -
vars - - свои переменные
visibility - - процент видимости плеера
hlserror
dasherror
- - объект, содержащий информацию об ошибке HLS / DASH
hls
dash
- - объект hls.js или dash.js (прямой доступ к модулю)
fix
unfix
- ручное переключение режима фиксации плеера -
adblock - - включен или выключен AdBlock (false или true)
startvast id запуск рекламы партнерской сети по id -
live - - прямой эфир или нет (true или false)
size - - размеры плеера (ширина/высота)
geo  - объект данных модуля геолокации
destroy - подготавливает плеер к удалению перед очисткой контейнера -
* к команде play можно добавить опцию seek player.api("play","url[seek:10]"); для старта с нужной секунды. Старт через JS на мобильных платформах со звуком работает только вследствие действий пользователя (например, нажатие на экран телефона).

** на всех платформах работает только вследствие действий пользователя

API находится в постоянном процессе разработки, если чего-то не хватает - напишите нам через обратную связь.

Как узнать, что плеер готов работе

Можно отследить событие init, которое плеер присылает после инициализации. Также с версии 9.25 можно указать параметром ready название функции, которую плеер вызовет, когда будет готов.

var player = new Playerjs({id:"player", ready:"PlayerReady", file:"..."});
function PlayerReady(id){
   alert("ready");
}

Как отправлять команды плееру внутри iframe

Для этого есть специальный механизм postMessage. Чтобы он заработал, нужно включить его в настройках Модули / API / Поддержка postMessage. Например, так выглядит iframe:

<iframe id="player" src="https://site.com/video.html" type="text/html" width="640" height="360" frameborder="0" allowfullscreen=""></iframe>

Чтобы отправить ему команду нужно передать объект с командой api

document.getElementById("player").contentWindow.postMessage({"api":"play"}, "*");

Если нужно передать параметр, то в объект добавляется set

document.getElementById("player").contentWindow.postMessage({"api":"volume","set":0.5}, "*");

* в конце означает, что вы доверяете этому iframe. Если нет, то вместо звездочки нужно передавать URI.

Плеер также поддерживает формат общения, который использует Яндекс в своем поиске по видео для управления плеерами.




2020 © PlayerJS

Логин

Восстановить пароль
Создать аккаунт
Войти

Регистрация

Создать аккаунт
Регистрируясь, вы принимаете Пользовательское соглашение
Войдите, если уже есть аккаунт

Enterprise

Ваше имя
Сайт
Email
Телефон
Комментарий
Отправить запрос

Восстановить пароль

Восстановить
Если вы забыли свой email, напишите нам