Свойства объекта Аудио¶

параметр Ресурс аудио; audioResource¶

Параметр позволяет выбрать ресурс аудио для данного объекта.

Примечание

Можно присвоить как ресурс, так и id ресурса. Подробнее см. Ресурсы.

параметр Громкость; volume¶

Позволяет установить громкость аудио ресурса. Максимальной громкости соответствует значение 1, беззвучному воспроизведению - значение 0. По умолчанию значение равно 1. Подробнее, см. действие Установить громкость (setVolume)

параметр Панорамирование; pan¶

Параметр устанавливает распределение звука между стерео-каналами.

-1.000 - звук полностью смещен влево, 1.000 - звук полностью смещен вправо. По умолчанию равен 0.000.

параметр Режим воспроизведения; playMode¶

Параметр имеет два значения: «один раз» и «повтор». По умолчанию выставлено значение «один раз». Подробнее, см. действие Установить режим проигрывания (setPlayMode)

параметр Декодирование на ходу; liveDecoding¶

Параметр позволяет установить декодирование «на ходу». При выборе данного параметра декодирование и отправка в оперативную память аудио файла для воспроизведения производится пакетами, что позволяет значительно уменьшить ее расход.

Действия объекта Аудио¶

действие Установить аудио ресурс; setAudioResource(resource)¶

Установить новый ресурс аудио (параметр Ресурс аудио (audioResource)).

Параметры:	Ресурс аудио / audioResource – Новый ресурс аудио, который будет выставлен объекту.

Данный вызов равносилен присваиванию параметра Ресурс аудио (audioResource)

действие Установить громкость; setVolume(volume)¶

Установить новую громкость проигрывания аудио ресурса, отличную от той, которая установлена в свойствах объектах Аудио (параметр Громкость (volume)).

Параметры:	громкость / volume – Новый уровень громкости.

действие Установить панорамирование; setPan(pan)¶

Установить значение панорамирования. Подробнее см. Панорамирование (pan)

действие Установить режим проигрывания; setPlayMode(mode)¶

Установить новый режим проигрывания аудио ресурса: один раз или повтор (параметр Режим воспроизведения (playMode)).

Параметры:	Режим проигрывания / playMode – Новый режим проигрывания: *Один раз*(AudioReactor.PlayMode.ONCE) или *Повтор*(AudioReactor.PlayMode.LOOP).

События и действия объекта Аудио (управление воспроизведением)¶

Вводится в AudioReactor

событие Запущен; onStart¶

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

событие Остановлен; onStop¶

Вызывается при остановке проигрывания аудио ресурса пользователем. Данное событие возбуждается только при вызове действия Остановить (stop) во время проигрывания аудио.

событие Приостановлен; onPause¶

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

событие Возобновлён; onResume¶

Вызывается при снятии аудио с паузы. Данное событие возбуждается только при вызове действия Возобновить (resume) для приостановленного аудио.

событие Завершён; onFinished¶

Вызывается по окончании воспроизведения аудио ресурса. При вызове действия Остановить (stop) данное событие не возникает.

действие Проиграть; play(playMode = AudioReactor.PlayMode.ONCE)¶

Начать воспроизведение аудио ресурса с начала, независимо от текущего состояния аудио. При вызове приходит событие Запущен (onStart).

Если Режим проигрывания / playMode выставлен как Один раз / AudioReactor.PlayMode.ONCE, то после окончания проигрывания будет вызвано событие Завершён (onFinished). Если режим проигрывания выставлен как Повтор / AudioReactor.PlayMode.LOOP, то проигрывание никогда не закончится само, и, соответственно, событие вызвано не будет. Однако режим проигрывания может быть изменён явно при помощи действия Установить режим проигрывания (setPlayMode).

Параметры:	Режим / playMode – Режим проигрывания: AudioReactor.PlayMode.ONCE - проиграть один раз, AudioReactor.PlayMode.LOOP - проигрывать в цикле.

Если в Студии выставлено значение Не менять, будет установлен режим, указанный в параметрах объекта.

Примечание

Вызов с playMode равным nil(если параметр не указан или nil указан явно) начнет воспроизведение с режимом проигрывания AudioReactor.PlayMode.ONCE или установленным до вызова вручную.

действие Остановить; stop()¶

Остановить воспроизведение и перемотать аудио в начало. Если аудио не было запущено и находится в начальном состоянии, действие не сработает. При успешном вызове приходит событие Остановлен (onStop).

действие Приостановить ; pause()¶

Поставить воспроизведение аудио на паузу. Если аудио не было запущено и находится в начальном состоянии, действие не сработает. При успешном вызове приходит событие Приостановлен (onPause).

Примечание

Даже если аудио уже стоит на паузе, повторный вызов действия Приостановить (pause) приведет к вызову события Приостановлен (onPause).

действие Возобновить ; resume()¶

Продолжить воспроизведение аудио ресурса с момента паузы. Если аудио не было запущено и находится в начальном состоянии, действие не сработает. При успешном вызове приходит событие Возобновлён (onResume).

Примечание

Даже если аудио проигрывается в данный момент, вызов действия Возобновлён (onResume) приведет к вызову события Возобновлён (onResume).

Advanced¶

local audio = reactorController:getReactorByName("Audio")

if audio:isPlaying() then
  doSomething()
end