Программные решения для построения систем онлайн-вещания
Документация по SDK для HTML5 плеера
Плеер на JavaScript для Softvelum Low Delay Protocol
SDK для HTML5 SLDP Player
Софтвелум предоставляет JavaScript SDK, который можно использовать на своих веб-сайтах для воспроизведения потоков по SLDP с низкой задержкой. SDK представляет собой библиотеку на JavaScript, у которой есть API для управления. Получить SDK можно следующим образом:
- Вы подписываетесь на SDK, используя эту страницу.
- В течение одного рабочего дня вам высылается лицензионное соглашение для электронной подписи.
- После подписания соглашения вы высылаете заявку через хелпдеск , где указываете, для каких доменов будет использоваться плеер. Допускаются домены 2 уровня и ниже.
- В течении двух рабочих дней мы генерируем индивидуальную сборку SDK для каждого домена и отправляем вам.
- По мере выпуска обновлений мы будем высылать новые сборки для каждого домена, заявленного в подписке.
Подписаться
Ниже описаны интерфейсы и колбэки. которые будут доступны вам в рамках SDK.
SLDP.isMediaSourceSupported() – проверяет поддержку текущим браузером технологии Media Source Extensions API и, следовательно, возможность работы SLDP плеера.
Возвращаемое значение: true - поддерживает, false - не поддерживает.
Интерфейсы плеера SLDP
destroy() – уничтожает выбранный экземпляр плеера, включая объекты MSE (Media Source Extensions), UI плеера и соединения.
play() – начинает воспроизведение для данного экземпляра плеера.
pause() – приостанавливает воспроизведение для данного экземпляра плеера. Текущее соединение с медиа-сервером сохраняется в течение времени, заданного параметром pause_timeout, если он задан.
stop() – прекращает воспроизведения для данного экземпляра плеера. Текущее подключение к медиа-серверу немедленно закрывается.
getVolume() – возвращает громкость плеера.
Возвращаемое значение: целое число от 0 (без звука) до 100 (полная громкость).
setVolume( volume ) – устанавливает уровень громкости плеера. Элементы пользовательского интерфейса обновляются соответственно выбранному уровню.
Параметры:
- volume – целое число от 0 (без звука) до 100 (полная громкость)
startAbr() – запускает алгоритм адаптивного битрейта (ABR), который выполняет автоматическое переключение на лучшее возможное качество видео при данной скорости сети и производительности процессора.
stopAbr() – прекращает работу алгоритма адаптивного битрейта (ABR).
isAbr() – показывает, включен или выключен алгоритм адаптивного битрейта.
getRenditions() – возвращает список доступных вариантов качества видео.
Возвращаемое значение: массив строк, содержащих доступные варианты, например, ['360p', '720p'].
getCurrentRendition() – возвращает выбранное в настоящий момент качество видео.
Возвращаемое значение: строка с текущим качеством, например, '720p'.
changeRendition( rendition ) – переключает воспроизведение на указанное качество.
Возвращаемое значение: логический результат (true – переключение начато, false – в настоящее время уже выполняется другое переключение).
Параметры:
- rendition – строка, содержащая желаемое качество, например, '1080p'
getStreams() – возвращает список потоков, которые доступны для переключения.
Возвращаемое значение: массив объектов со следующими полями:
- name – полное имя потока, например, 'live/stream'
- width – ширина разрешения видео в пикселях, если присутствует
- height – высота разрешения видео в пикселях, если присутствует
- bandwidth – битрейт потока в битах в секунду
getCurrentStream() – возвращает текущий выбранный поток.
Возвращаемое значение: объект со следующими полями:
- name – полное имя потока, например, 'live/stream'
- width – ширина разрешения видео в пикселях, если присутствует
- height – высота разрешения видео в пикселях, если присутствует
- bandwidth – битрейт потока в битах в секунду
changeStream( name ) – переключает воспроизведение на поток с указанным именем.
Возвращаемое значение: логический результат (true – переключение начато, false – в настоящее время уже выполняется другое переключение).
Параметры:
- name – полное имя целевого потока, например, 'live/stream'
setStreamURL( url ) – задает адрес (URL) нового SLDP-потока. Воспроизведение текущего потока прерывается. Если в данном экземпляре плеера параметр 'autoplay' установлен в значение true, воспроизведение нового потока начинается незамедлительно при условии, что такое возможно.
Параметры:
- url – строка, содержащая адрес (URL) SLDP-потока, например, 'ws://example.com/app/stream'
setCallbacks( callbacks ) – устанавливает колбэки (функции обратного вызова) для данного экземпляра плеера.
Параметры:
- callbacks – объект, где ключи — это названия колбэков, а значения — ссылки на определенные разработчиком функции. Допустимыми названиями колбэков являются: onConnectionStarted, onConnectionEstablished, onPlay, onPause, onVolumeSet, onConnectionClosed, onChangeRendition, onChangeRenditionComplete, onError, onLatencyAdjustSeek
Колбэки SLDP-плеера:
onConnectionStarted( url ) – вызывается в начале подключения плеера к медиа-серверу.
Параметры:
- url – полный адрес (URL) SLDP потока, который воспроизводит плеер, например, 'ws://example.com/live/stream'
onConnectionEstablished( streams ) – вызывается после подключения к медиа-серверу и получения списка доступных потоков. Список доступных для пользователя вариантов качества видео составляется на основе данных этих потоков и возможностей браузера.
Параметры:
- streams – массив доступных потоков.
Каждый поток представляет собой объект со следующими полями:- name – полное имя потока, например, 'live/stream'
- width – ширина разрешения потока в пикселях, если видео присутствует
- height – высота разрешения потока в пикселях, если видео присутствует
- vcodec – название видеокодека потока, если присутствует
- video – либо 'supported', либо 'not supported', в зависимости от возможностей браузера
- acodec – название аудиокодека потока, если присутствует
- audio – либо 'supported', либо 'not supported', в зависимости от возможностей браузера
- bandwidth – битрейт потока в битах в секунду
onPlay() – вызывается, когда пользователь нажимает кнопку воспроизведения или выполняется метод play().
onPause() – вызывается, когда пользователь нажимает кнопку паузы, или выполняется метод pause().
onVolumeSet( volume ) – вызывается, когда пользователь изменяет громкость с помощью элементов управления или выполняется метод setVolume().
Параметры:
- volume – целое число от 0 до 100, обозначающее выбранный уровень громкости
onConnectionClosed() – вызывается, когда соединение с медиа-сервером закрыто по какой-либо причине.
onError( error ) – вызывается при возникновении ошибки плеера.
Параметры:
- error – строка с описанием ошибки, например, 'MEDIA_SOURCE_NOT_SUPPORTED' или 'NO_PLAYABLE_SOURCE_FOUND'
onChangeRendition( rendition, name ) – вызывается, когда пользователь переключает качество видео, либо выполняется метод changeRendition() или changeStream().
Параметры:
- rendition – строка, содержащая выбранный пользователем вариант, например, '1080p' или 'Auto'
- name – полное имя выбранного потока, например, 'live/stream'
onChangeRenditionComplete( rendition, name ) – вызывается, когда переключение качества видео завершено.
Параметры:
- rendition – строка с фактическим качеством, например, '1080p'
- name – полное имя фактического потока, например, 'live/stream'
onError( error ) – вызывается, если SLDP плеер не может воспроизвести данный URL.
Параметры:
- error – строка 'MEDIA_SOURCE_NOT_SUPPORTED', если текущий браузер не поддерживает Media source API (напр. Internet Explorer < 11), либо 'NO_PLAYABLE_SOURCE_FOUND' в остальных случаях
onLatencyAdjustSeek( from, to ) – вызывается после автоматической операции поиска для восстановления задержки потока (параметр latency_tolerance должен быть установлен).
Параметры:
- from – позиция в секундах, с которой произведена операция поиска
- to – позиция в секундах, на которую произведена операция поиска
Пример реализации
Можно пройти на страницу примера и начать просмотр, чтобы увидеть как можно применить SDK для проигрывания потоков на своей странице