Audio

Расширяет lib.Events.

Аудиоплеер для браузера.

Конструктор | Типы данных | Поля | Константы | События | Методы

Конструктор

Параметры:

Параметр Значение по умолчанию Описание
preferredType

Тип: String

Предпочитаемый тип плеера. Может принимать значения: "html5", "flash" или любое ложное значение (false, null, undefined, 0, ""). Если выбранный тип плеера окажется недоступен, будет запущен оставшийся тип. Если указано ложное значение либо параметр не передан, то API автоматически выберет поддерживаемый тип плеера. Если браузер поддерживает обе технологии, то по умолчанию YandexAudio создает аудиоплеер на основе HTML5.

overlay

Тип: HTMLElement

HTML-контейнер для отображения Flash-апплета.

Параметр Значение по умолчанию Описание
preferredType

Тип: String

Предпочитаемый тип плеера. Может принимать значения: "html5", "flash" или любое ложное значение (false, null, undefined, 0, ""). Если выбранный тип плеера окажется недоступен, будет запущен оставшийся тип. Если указано ложное значение либо параметр не передан, то API автоматически выберет поддерживаемый тип плеера. Если браузер поддерживает обе технологии, то по умолчанию YandexAudio создает аудиоплеер на основе HTML5.

overlay

Тип: HTMLElement

HTML-контейнер для отображения Flash-апплета.

Типы данных

Имя Описание
AudioPreprocessor

Аудио-препроцессор.

AudioTimes

Описание временных данных плеера.

Имя Описание
AudioPreprocessor

Аудио-препроцессор.

AudioTimes

Описание временных данных плеера.

Поля

Имя Тип Описание
Audio.audioContext AudioContext

Контекст для Web Audio API.

Audio.info Object

Список доступных плееров

Имя Тип Описание
Audio.audioContext AudioContext

Контекст для Web Audio API.

Audio.info Object

Список доступных плееров

Константы

Имя Тип Описание
Audio.PRELOADER_EVENT String

Событие предзагрузчика. Используется в качестве префикса.

Audio.STATE_CRASHED String

Не удалось инициализировать плеер.

Audio.STATE_IDLE String

Плеер готов и ожидает.

Audio.STATE_INIT String

Плеер находится в состоянии инициализации.

Audio.STATE_PAUSED String

Плеер поставлен на паузу.

Audio.STATE_PLAYING String

Плеер проигрывает трек.

Имя Тип Описание
Audio.PRELOADER_EVENT String

Событие предзагрузчика. Используется в качестве префикса.

Audio.STATE_CRASHED String

Не удалось инициализировать плеер.

Audio.STATE_IDLE String

Плеер готов и ожидает.

Audio.STATE_INIT String

Плеер находится в состоянии инициализации.

Audio.STATE_PAUSED String

Плеер поставлен на паузу.

Audio.STATE_PLAYING String

Плеер проигрывает трек.

События

Имя Описание
EVENT_CRASHED

Событие возникновения ошибки при инициализации плеера.

EVENT_ENDED

Событие завершения воспроизведения.

EVENT_ERROR

Событие ошибки воспроизведения.

EVENT_LOADED

Событие завершения загрузки аудиофайла.

EVENT_LOADING

Событие начала загрузки аудиофайла.

EVENT_PAUSE

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

EVENT_PLAY

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

EVENT_PROGRESS

Событие обновления позиции воспроизведения или загруженной части.

EVENT_STATE

Событие смены статуса плеера.

EVENT_STOP

Событие остановки воспроизведения.

EVENT_SWAP

Событие переключения активного плеера и прелоадера.

EVENT_VOLUME

Событие изменения громкости.

PRELOADER_EVENT+EVENT_ERROR

Событие ошибки воспроизведения.

PRELOADER_EVENT+EVENT_LOADED

Событие завершения загрузки аудиофайла.

PRELOADER_EVENT+EVENT_LOADING

Событие начала загрузки аудиофайла.

PRELOADER_EVENT+EVENT_PROGRESS

Событие обновления позиции загруженной части.

PRELOADER_EVENT+EVENT_STOP

Событие остановки воспроизведения.

Имя Описание
EVENT_CRASHED

Событие возникновения ошибки при инициализации плеера.

EVENT_ENDED

Событие завершения воспроизведения.

EVENT_ERROR

Событие ошибки воспроизведения.

EVENT_LOADED

Событие завершения загрузки аудиофайла.

EVENT_LOADING

Событие начала загрузки аудиофайла.

EVENT_PAUSE

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

EVENT_PLAY

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

EVENT_PROGRESS

Событие обновления позиции воспроизведения или загруженной части.

EVENT_STATE

Событие смены статуса плеера.

EVENT_STOP

Событие остановки воспроизведения.

EVENT_SWAP

Событие переключения активного плеера и прелоадера.

EVENT_VOLUME

Событие изменения громкости.

PRELOADER_EVENT+EVENT_ERROR

Событие ошибки воспроизведения.

PRELOADER_EVENT+EVENT_LOADED

Событие завершения загрузки аудиофайла.

PRELOADER_EVENT+EVENT_LOADING

Событие начала загрузки аудиофайла.

PRELOADER_EVENT+EVENT_PROGRESS

Событие обновления позиции загруженной части.

PRELOADER_EVENT+EVENT_STOP

Событие остановки воспроизведения.

Методы

Имя Возвращает Описание
clearListeners() lib.Events

Отписаться от всех слушателей событий (цепочный метод).

Унаследован от lib.Events.

getDuration(preloader) Number

Получить длительность текущего аудиофайла (в секундах).

getLoaded(preloader) Number

Получить длительность загруженной части (в секундах).

getPlayed() Number

Получить длительность воспроизведения (в секундах).

getPlayId() String

Получить уникальный идентификатор воспроизведения. Создаётся каждый раз при запуске нового трека или перезапуске текущего.

getPosition() Number

Получение позиции воспроизведения (в секундах).

getSrc([offset]) String | null

Получить ссылку на текущий трек.

getState() String

Получить статус плеера.

getType() String | null

Получить текущий тип реализации плеера.

getVolume() Number

Получить текущее значение громкости плеера.

initPromise() lib.Promise

Получить обещание, разрешающееся после завершения инициализации.

isAutoplayable() Boolean

Проверка возможности воспроизведения без пользовательского взаимодействия

isDeviceVolume() Boolean

Проверка, что громкость управляется устройством, а не программно.

isPreloaded(src) Boolean

Проверка, что аудиофайл предзагружен.

isPreloading(src) Boolean

Проверка, что аудиофайл предзагружается.

muteEvents() lib.Events

Остановить запуск событий (цепочный метод).

Унаследован от lib.Events.

off(event, callback) lib.Events

Отписаться от события (цепочный метод).

Унаследован от lib.Events.

on(event, callback) lib.Events

Подписаться на событие (цепочный метод).

Унаследован от lib.Events.

once(event, callback) lib.Events

Подписаться на событие и отписаться сразу после его первого возникновения (цепочный метод).

Унаследован от lib.Events.

pause() AbortablePromise

Поставить плеер на паузу.

play(src[, duration]) AbortablePromise

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

playPreloaded([src]) AbortablePromise

Запуск воспроизведения предзагруженного аудиофайла.

preload(src[, duration]) AbortablePromise

Предзагрузка аудиофайла.

restart() AbortablePromise

Перезапуск воспроизведения.

resume() AbortablePromise

Снятие плеера с паузы.

setAudioPreprocessor(preprocessor) Boolean

Подключение аудио препроцессора. Вход препроцессора подключается к аудиоэлементу, у которого выставлена 100% громкость. Выход препроцессора подключается к GainNode, которая регулирует итоговую громкость.

setPosition(position) Number

Установка позиции воспроизведения (в секундах).

setVolume(volume) Number

Установка громкости плеера.

stop([offset]) AbortablePromise

Остановка воспроизведения.

toggleCrossDomain(state) Boolean
Включить режим CORS для получения аудиотреков.
Внимание. Если включить режим CORS, аудио элемент не сможет загружать данные со сторонних доменов, если в ответе не будет правильного заголовка Access-Control-Allow-Origin. Если не планируется использование Web Audio API, не стоит включать этот режим.
toggleWebAudioAPI(state) Boolean
Переключение режима использования Web Audio API. Доступен только при html5-реализации плеера.
Внимание. После включения режима Web Audio API он не отключается полностью, т.к. для этого требуется реинициализация плеера, для которой в свою очередь требуется клик пользователя. При отключении режима из графа обработки исключаются все узлы, кроме узлов-источников и узла вывода; управление громкостью переключается на элементы audio, без использования GainNode.
unmuteEvents() lib.Events

Возобновить запуск событий (цепочный метод).

Унаследован от lib.Events.

Имя Возвращает Описание
clearListeners() lib.Events

Отписаться от всех слушателей событий (цепочный метод).

Унаследован от lib.Events.

getDuration(preloader) Number

Получить длительность текущего аудиофайла (в секундах).

getLoaded(preloader) Number

Получить длительность загруженной части (в секундах).

getPlayed() Number

Получить длительность воспроизведения (в секундах).

getPlayId() String

Получить уникальный идентификатор воспроизведения. Создаётся каждый раз при запуске нового трека или перезапуске текущего.

getPosition() Number

Получение позиции воспроизведения (в секундах).

getSrc([offset]) String | null

Получить ссылку на текущий трек.

getState() String

Получить статус плеера.

getType() String | null

Получить текущий тип реализации плеера.

getVolume() Number

Получить текущее значение громкости плеера.

initPromise() lib.Promise

Получить обещание, разрешающееся после завершения инициализации.

isAutoplayable() Boolean

Проверка возможности воспроизведения без пользовательского взаимодействия

isDeviceVolume() Boolean

Проверка, что громкость управляется устройством, а не программно.

isPreloaded(src) Boolean

Проверка, что аудиофайл предзагружен.

isPreloading(src) Boolean

Проверка, что аудиофайл предзагружается.

muteEvents() lib.Events

Остановить запуск событий (цепочный метод).

Унаследован от lib.Events.

off(event, callback) lib.Events

Отписаться от события (цепочный метод).

Унаследован от lib.Events.

on(event, callback) lib.Events

Подписаться на событие (цепочный метод).

Унаследован от lib.Events.

once(event, callback) lib.Events

Подписаться на событие и отписаться сразу после его первого возникновения (цепочный метод).

Унаследован от lib.Events.

pause() AbortablePromise

Поставить плеер на паузу.

play(src[, duration]) AbortablePromise

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

playPreloaded([src]) AbortablePromise

Запуск воспроизведения предзагруженного аудиофайла.

preload(src[, duration]) AbortablePromise

Предзагрузка аудиофайла.

restart() AbortablePromise

Перезапуск воспроизведения.

resume() AbortablePromise

Снятие плеера с паузы.

setAudioPreprocessor(preprocessor) Boolean

Подключение аудио препроцессора. Вход препроцессора подключается к аудиоэлементу, у которого выставлена 100% громкость. Выход препроцессора подключается к GainNode, которая регулирует итоговую громкость.

setPosition(position) Number

Установка позиции воспроизведения (в секундах).

setVolume(volume) Number

Установка громкости плеера.

stop([offset]) AbortablePromise

Остановка воспроизведения.

toggleCrossDomain(state) Boolean
Включить режим CORS для получения аудиотреков.
Внимание. Если включить режим CORS, аудио элемент не сможет загружать данные со сторонних доменов, если в ответе не будет правильного заголовка Access-Control-Allow-Origin. Если не планируется использование Web Audio API, не стоит включать этот режим.
toggleWebAudioAPI(state) Boolean
Переключение режима использования Web Audio API. Доступен только при html5-реализации плеера.
Внимание. После включения режима Web Audio API он не отключается полностью, т.к. для этого требуется реинициализация плеера, для которой в свою очередь требуется клик пользователя. При отключении режима из графа обработки исключаются все узлы, кроме узлов-источников и узла вывода; управление громкостью переключается на элементы audio, без использования GainNode.
unmuteEvents() lib.Events

Возобновить запуск событий (цепочный метод).

Унаследован от lib.Events.

Описание полей

audioContext

{AudioContext} Audio.audioContext

Контекст для Web Audio API.

info

{Object} Audio.info

Список доступных плееров

Типы данных

AudioPreprocessor

Аудио-препроцессор.

Поля:

Поле Тип Описание
input AudioNode

Нода, в которую перенаправляется вывод аудио.

output AudioNode

Нода, из которой вывод подается на усилитель.

Поле Тип Описание
input AudioNode

Нода, в которую перенаправляется вывод аудио.

output AudioNode

Нода, из которой вывод подается на усилитель.

AudioTimes

Описание временных данных плеера.

Поля:

Поле Тип Описание
duration Number

Длительность аудиофайла.

loaded Number

Длительность загруженной части.

position Number

Позиция воспроизведения.

played Number

Длительность воспроизведения.

Поле Тип Описание
duration Number

Длительность аудиофайла.

loaded Number

Длительность загруженной части.

position Number

Позиция воспроизведения.

played Number

Длительность воспроизведения.

Описание событий

EVENT_CRASHED

Событие возникновения ошибки при инициализации плеера.

EVENT_ENDED

Событие завершения воспроизведения.

EVENT_ERROR

Событие ошибки воспроизведения.

EVENT_LOADED

Событие завершения загрузки аудиофайла.

EVENT_LOADING

Событие начала загрузки аудиофайла.

EVENT_PAUSE

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

EVENT_PLAY

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

EVENT_PROGRESS

Событие обновления позиции воспроизведения или загруженной части.

На вход функции-обработчику передаются аргументы:

Параметр Тип Описание
times

AudioTimes

Информация о временных данных аудиофайла.

Параметр Тип Описание
times

AudioTimes

Информация о временных данных аудиофайла.

EVENT_STATE

Событие смены статуса плеера.

На вход функции-обработчику передаются аргументы:

Параметр Тип Описание
state

String

Новый статус плеера.

Параметр Тип Описание
state

String

Новый статус плеера.

EVENT_STOP

Событие остановки воспроизведения.

EVENT_SWAP

Событие переключения активного плеера и прелоадера.

EVENT_VOLUME

Событие изменения громкости.

На вход функции-обработчику передаются аргументы:

Параметр Тип Описание
volume

Number

Новое значение громкости.

Параметр Тип Описание
volume

Number

Новое значение громкости.

PRELOADER_EVENT+EVENT_ERROR

Событие ошибки воспроизведения.

PRELOADER_EVENT+EVENT_LOADED

Событие завершения загрузки аудиофайла.

PRELOADER_EVENT+EVENT_LOADING

Событие начала загрузки аудиофайла.

PRELOADER_EVENT+EVENT_PROGRESS

Событие обновления позиции загруженной части.

На вход функции-обработчику передаются аргументы:

Параметр Тип Описание
times

AudioTimes

Информация о временных данных аудиофайла.

Параметр Тип Описание
times

AudioTimes

Информация о временных данных аудиофайла.

PRELOADER_EVENT+EVENT_STOP

Событие остановки воспроизведения.

Описание методов

getDuration

{Number} getDuration(preloader)

Получить длительность текущего аудиофайла (в секундах).

Параметры:

Параметр Значение по умолчанию Описание
preloader*

Тип: Boolean | int

Активный плеер или предзагрузчик. 0 - активный плеер, 1 - предзагрузчик.

Параметр Значение по умолчанию Описание
preloader*

Тип: Boolean | int

Активный плеер или предзагрузчик. 0 - активный плеер, 1 - предзагрузчик.

* Обязательный параметр/опция.

getLoaded

{Number} getLoaded(preloader)

Получить длительность загруженной части (в секундах).

Параметры:

Параметр Значение по умолчанию Описание
preloader*

Тип: Boolean | int

Активный плеер или предзагрузчик. 0 - активный плеер, 1 - предзагрузчик.

Параметр Значение по умолчанию Описание
preloader*

Тип: Boolean | int

Активный плеер или предзагрузчик. 0 - активный плеер, 1 - предзагрузчик.

* Обязательный параметр/опция.

getPlayed

{Number} getPlayed()

Получить длительность воспроизведения (в секундах).

getPlayId

{String} getPlayId()

Получить уникальный идентификатор воспроизведения. Создаётся каждый раз при запуске нового трека или перезапуске текущего.

getPosition

{Number} getPosition()

Получение позиции воспроизведения (в секундах).

getSrc

{String  |  null} getSrc([offset])

Получить ссылку на текущий трек.

Параметры:

Параметр Значение по умолчанию Описание
offset

Тип: int

Брать аудиофайл из активного плеера или из прелоадера. 0 - активный плеер, 1 - прелоадер.

Параметр Значение по умолчанию Описание
offset

Тип: int

Брать аудиофайл из активного плеера или из прелоадера. 0 - активный плеер, 1 - прелоадер.

getState

{String} getState()

Получить статус плеера.

getType

{String  |  null} getType()

Получить текущий тип реализации плеера.

getVolume

{Number} getVolume()

Получить текущее значение громкости плеера.

initPromise

{lib.Promise} initPromise()

Получить обещание, разрешающееся после завершения инициализации.

isAutoplayable

{Boolean} isAutoplayable()

Проверка возможности воспроизведения без пользовательского взаимодействия

isDeviceVolume

{Boolean} isDeviceVolume()

Проверка, что громкость управляется устройством, а не программно.

Возвращает true, если громкость управляется устройством, false - иначе.

isPreloaded

{Boolean} isPreloaded(src)

Проверка, что аудиофайл предзагружен.

Возвращает true, если аудиофайл предзагружен, false - иначе.

Параметры:

Параметр Значение по умолчанию Описание
src*

Тип: String

Ссылка на трек.

Параметр Значение по умолчанию Описание
src*

Тип: String

Ссылка на трек.

* Обязательный параметр/опция.

isPreloading

{Boolean} isPreloading(src)

Проверка, что аудиофайл предзагружается.

Возвращает true, если аудиофайл начал предзагружаться, false - иначе.

Параметры:

Параметр Значение по умолчанию Описание
src*

Тип: String

Ссылка на трек.

Параметр Значение по умолчанию Описание
src*

Тип: String

Ссылка на трек.

* Обязательный параметр/опция.

pause

Поставить плеер на паузу.

Возвращает обещание, которое разрешится, когда плеер будет поставлен на паузу.

play

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

Параметры:

Параметр Значение по умолчанию Описание
src*

Тип: String

Ссылка на трек.

duration

Тип: Number

Длительность аудиофайла. Актуально для Flash-реализации, в ней пока аудиофайл грузится длительность определяется с погрешностью.

Параметр Значение по умолчанию Описание
src*

Тип: String

Ссылка на трек.

duration

Тип: Number

Длительность аудиофайла. Актуально для Flash-реализации, в ней пока аудиофайл грузится длительность определяется с погрешностью.

* Обязательный параметр/опция.

playPreloaded

{AbortablePromise} playPreloaded([src])

Запуск воспроизведения предзагруженного аудиофайла.

Возвращает обещание, которое разрешится, когда начнется воспроизведение предзагруженного аудиофайла.

Параметры:

Параметр Значение по умолчанию Описание
src

Тип: String

Ссылка на аудиофайл (для проверки, что в прелоадере нужный трек).

Параметр Значение по умолчанию Описание
src

Тип: String

Ссылка на аудиофайл (для проверки, что в прелоадере нужный трек).

preload

Предзагрузка аудиофайла.

Возвращает обещание, которое разрешится, когда начнется предзагрузка аудиофайла.

Параметры:

Параметр Значение по умолчанию Описание
src*

Тип: String

Ссылка на трек.

duration

Тип: Number

Длительность аудиофайла. Актуально для Flash-реализации, в ней пока аудиофайл грузится длительность определяется с погрешностью.

Параметр Значение по умолчанию Описание
src*

Тип: String

Ссылка на трек.

duration

Тип: Number

Длительность аудиофайла. Актуально для Flash-реализации, в ней пока аудиофайл грузится длительность определяется с погрешностью.

* Обязательный параметр/опция.

restart

{AbortablePromise} restart()

Перезапуск воспроизведения.

Возвращает обещание, которое разрешится, когда трек будет перезапущен.

resume

{AbortablePromise} resume()

Снятие плеера с паузы.

Возвращает обещание, которое разрешится, когда начнется воспроизведение.

setAudioPreprocessor

{Boolean} setAudioPreprocessor(preprocessor)

Подключение аудио препроцессора. Вход препроцессора подключается к аудиоэлементу, у которого выставлена 100% громкость. Выход препроцессора подключается к GainNode, которая регулирует итоговую громкость.

Возвращает статус успеха.

Параметры:

Параметр Значение по умолчанию Описание
preprocessor*

Тип: AudioPreprocessor

Препроцессор.

Параметр Значение по умолчанию Описание
preprocessor*

Тип: AudioPreprocessor

Препроцессор.

* Обязательный параметр/опция.

setPosition

{Number} setPosition(position)

Установка позиции воспроизведения (в секундах).

Возвращает итоговая позиция воспроизведения.

Параметры:

Параметр Значение по умолчанию Описание
position*

Тип: Number

Новая позиция воспроизведения

Параметр Значение по умолчанию Описание
position*

Тип: Number

Новая позиция воспроизведения

* Обязательный параметр/опция.

setVolume

{Number} setVolume(volume)

Установка громкости плеера.

Возвращает итоговое значение громкости.

Параметры:

Параметр Значение по умолчанию Описание
volume*

Тип: Number

Новое значение громкости.

Параметр Значение по умолчанию Описание
volume*

Тип: Number

Новое значение громкости.

* Обязательный параметр/опция.

stop

Остановка воспроизведения.

Возвращает обещание, которое разрешится, когда воспроизведение будет остановлено.

Параметры:

Параметр Значение по умолчанию Описание
offset

Тип: int

Активный плеер или прелоадер. 0 - активный плеер. 1 - прелоадер.

Параметр Значение по умолчанию Описание
offset

Тип: int

Активный плеер или прелоадер. 0 - активный плеер. 1 - прелоадер.

toggleCrossDomain

{Boolean} toggleCrossDomain(state)
Включить режим CORS для получения аудиотреков.
Внимание. Если включить режим CORS, аудио элемент не сможет загружать данные со сторонних доменов, если в ответе не будет правильного заголовка Access-Control-Allow-Origin. Если не планируется использование Web Audio API, не стоит включать этот режим.

Возвращает статус успеха.

Параметры:

Параметр Значение по умолчанию Описание
state*

Тип: Boolean

Запрашиваемый статус.

Параметр Значение по умолчанию Описание
state*

Тип: Boolean

Запрашиваемый статус.

* Обязательный параметр/опция.

toggleWebAudioAPI

{Boolean} toggleWebAudioAPI(state)
Переключение режима использования Web Audio API. Доступен только при html5-реализации плеера.
Внимание. После включения режима Web Audio API он не отключается полностью, т.к. для этого требуется реинициализация плеера, для которой в свою очередь требуется клик пользователя. При отключении режима из графа обработки исключаются все узлы, кроме узлов-источников и узла вывода; управление громкостью переключается на элементы audio, без использования GainNode.

Возвращает итоговый статус.

Параметры:

Параметр Значение по умолчанию Описание
state*

Тип: Boolean

Запрашиваемый статус.

Параметр Значение по умолчанию Описание
state*

Тип: Boolean

Запрашиваемый статус.

* Обязательный параметр/опция.