|
Uppod.AJAX 1.1 βAPI для общения с плеером через JavaScript.
Как это работает: в тело страницы включается .js файл, который анализирует все подключенные плееры и позволяет получать и отправлять данные всем или каждому плееру в отдельности.
Требования:
- плеер и файл .js должны загружаться с одного домена (префикс www тоже имеет значение);
- каждый плеер в HTML должен иметь уникальный идентификатор id, содержащий слово player (он уже есть в коде при копировании из нашего сервиса);
- каждый плеер должен знать свой идентификатор id, он передается через параметр uid в списке параметров flashvars. Наличие этого параметра необходимо для работы Uppod.AJAX.
- примерный код подключения через SWFObject
<div id="videoplayer1"></div><script type="text/javascript">var flashvars = {"m":"video","file":"http://site.ru/file.flv","uid":"videoplayer1"};var params = {id:"videoplayer1", bgcolor:"#ffffff", allowFullScreen:"true", allowScriptAccess:"always"}; new swfobject.embedSWF("http://site.ru/uppod.swf", "videoplayer1", "500", "375", "9.0.115", false, flashvars, params);</script>
Описание параметров
| Ключ |
Описание |
Параметры |
Примечание |
| установки |
переменные |
- |
- |
| uppod_play_next |
запуск следующего плеера |
0 или 1 (по умолчанию 0) |
нужно установить переменную в значение 1, если требуется запускать следующий плеер при окончании воспроизведения текущего |
| события (функции) |
- |
- |
плеер посылает события, передавая в параметрах свой id (playerID) |
| uppodInit(playerID) |
инициализация |
- |
плеер сообщает о своей загрузке |
| uppodStartsReport(playerID) |
запуск плеера |
- |
плеер обращается к функции, когда пользователь запускает воспроизведение |
| uppodErrorReport(playerID) |
ошибка |
- |
плеер обращается к функции, если происходит ошибка ("файл не найден") |
| uppodTheEnd(playerID) |
окончание проигрывания |
- |
плеер обращается к функции, когда воспроизведение окончивается (конец файла). Если установлен запуск следующего плеера (uppod_play_next=1), то запускается следующий. |
| uppodPL(playerID) |
загрузка плейлиста |
- |
плеер сообщает о загрузке плейлиста |
| uppodOnLoad(playerID) |
файл загрузился |
- |
опция включается в стилях (Модули > Uppod.AJAX) и сообщает о полной загрузке файла |
| uppodOnDownload(playerID) |
пользователь скачал файл |
- |
опция включается в стилях (Модули > Uppod.AJAX) и сообщает о том, что пользователь нажал на кнопку "Скачать" на панели или в меню "Доступ" |
| uppodOnEnd(playerID) |
проигрывание файла окончено |
- |
опция включается в стилях (Модули > Uppod.AJAX) и сообщает о том, что пользователь файл закончился |
| uppodOnQuality(playerID) |
переключено качество |
- |
опция включается в стилях (Модули > Uppod.AJAX) и сообщает о том, что пользователь переключил качество ( |
| команды (функции) |
функции |
- |
команды плееру |
| uppodStopAll(playerID) |
остановить все плееры, кроме одного (playerID) |
- |
- |
| uppodSend(playerID, com, callback) |
команды |
playerID - id плеера
com - команда
callback - обратная функция для возвращаемых значений, по умолчанию значения возвращаются в функции uppodGet... (в параметрах передается значение и uid плеера (c версии плеера 0.5)) |
команды (com)
play - пуск
pause - пазуа
toggle - переключение (play/pause)
stop - стоп
startN - запуск определенного файла из плейлиста, например - start3, start21 (нумерация начинается с 1)
vN - установка громкости звука 0-100 (v0 - v100)
file:URL - запуск нового файла (file:http://site.ru/file.mp3)
pl:{} - добавление позиции в плейлист
text:TEXT - вывести на экран текст c возможность закрыть (с крестиком в углу)
text2:TEXT - вывести на экран текст без возможности закрыть
xtext - закрыть текстовое сообщение
xpl - закрыть открытый плейлист (при расположении внутри)
random - установить режим случайного воспроизведения, повторный его вызов отключает
seek:sec - перемотка на заданный момент времени (секунды)
comment:TEXT - вывод названия
sss - скриншот экрана
ppp - скриншот плеера
quality - переключает качество, если оно включено
next - следующий трек
prev - предыдущий трек |
| uppodGet(playerID, com, callback) |
запросы |
- // -
по умолчанию значение возвращается сразу |
getpl - возвращает номер проигрываемого файла из плейлиста
getv - возвращет громкость звука
getime - возвращает текущее время воспроизведения
getimed - возвращает длительность
getstatus - возвращает статус (play 1, pause 0, stop -1), после первого обращения статус будет возвращаться каждый раз при изменении его пользователем
getfull - возвращает статус полноэкранного режима (вкл. 1, выкл. 0), после первого обращения статус будет возвращаться каждый раз при изменении его пользователем
getbytestotal - возвращает вес файла в байтах
getbytesloaded - возвращает загруженный вес файла в байтах
getprocent - возвращает процент загрузки 0-1
gettext - возвращает текстовое сообщение, если оно есть |
Использование прелоадеров
Можно установить любой индикатор загрузки (прелоадер) CSS или GIF для каждого плеера. Для этого нужно поместить div с плеером в контейнер с id=playerIDBox, а также создать div с id=playerIDPreloader, который будет прелоадером (есть пример в демонстрации).
|
