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

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

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

Примечание

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

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

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

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

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

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

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

параметр Динамический; isDynamic¶

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

параметр Модель затухания; attenuationMode¶

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

• Без затухания. Звук сохраняет начальную громкость и не затухает при изменении расстояния от слушателя(камеры) до объекта.
• Линейное расстояние. Звук линейно затухает при увеличении расстояния от слушателя(камеры) до объекта.
• Обратное расстояние. Звук плавно затухает при увеличении расстояния от слушателя(камеры) до объекта.
• Экспоненциальное расстояние. Звук резко затухает при увеличении расстояния от слушателя(камеры) до объекта.

параметр Коэффициент спада; rolloffFactor¶

Этот параметр контролирует, насколько быстро уменьшается воспринимаемая громкость звука по мере того, как слушатель удаляется от источника звука. Если выбрана модель затухания «Линейное расстояние», то данный параметр устанавливает максимальное снижение громкости и задается в интервале от 0 до 1, где 1 - 100% уменьшение громкости на максимальном расстоянии, 0.5 - 50% снижение громкости на максимальном расстоянии и т.д. При других моделях затухания рекомендуются значения больше 1.

параметр Минимальная дистанция; minDistance¶

Расстояние до слушателя(камеры), после которого звук начнет затухать, т.е. его громкость начнет снижаться в соответствии с выбранной моделью затухания и коэффициентом спада. Указывается в метрах.

параметр Максимальная дистанция; maxDistance¶

Расстояние до слушателя(камеры), после которого звук перестает затухать, т.е. его громкость, при превышении данного расстояния, останется на значении при максимальной дистанции. Указывается в метрах.

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

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

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

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

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

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

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

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

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

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

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

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

Параметры:	Режим проигрывания / playMode – Новый режим проигрывания: „once“ или „loop“.

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

действие Установить динамический режим; setIsDynamic(flag)¶

Установить режим(статический или динамический) для родительского объекта.

Параметры:	Значение / flag – Динамический(если true) или статический(если false).

действие Установить модель затухания; setAttenuationMode(mode)¶

Установить модель затухания для Аудиоузла из 4 доступных моделей.

Параметры:	модель / mode – Модель затухания.

Возможные значения:

• Без затухания(AudioNodeReactor.AttenuationMode.NO_ATTENUATION)
• Линейное расстояние(AudioNodeReactor.AttenuationMode.LINEAR_DISTANCE)
• Обратное расстояние(AudioNodeReactor.AttenuationMode.INVERSE_DISTANCE)
• Экспоненциальное расстояние(AudioNodeReactor.AttenuationMode.EXPONENTIAL_DISTANCE)

действие Установить коэффициент спада; setRolloffFactor(factor)¶

Установить коэффициент спада затухания.

Параметры:	factor / коэффициент – Коэффициент спада затухания.

действие Установить минимальное расстояние; setMinDistance(distance)¶

Установить минимальное расстояние затухания.

Параметры:	distance / расстояние – Минимальное расстояние, после которого звук начнет затухать.

действие Установить максимальное расстояние; setMaxDistance(distance)¶

Установить максимальное расстояние затухания.

Параметры:	distance / расстояние – Максимальное расстояние, после которого звук перестает затухать.

событие Слышен; onAudible¶

Если у объекта «Аудиоузел» установлена модель затухания, то в связи с позиционированием звука в трехмерном пространстве, в зависимости от расстояния от слушателя(камеры) до родительского объекта, аудио может быть как слышно, так и не слышно вовсе. Данное событие наступает, когда звук становится слышен, что может произойти, если аудио начало проигрываться и эффект затухания незначителен(или полностью отсутствует), или, например, при приближении к источнику звука, которое было не слышно до этого в связи с затуханием.

событие Не слышен; onInaudible¶

Если у объекта «Аудиоузел» установлена модель затухания, то в связи с позиционированием звука в трехмерном пространстве, в зависимости от расстояния от слушателя(камеры) до родительского объекта, аудио может быть как слышно, так и не слышно вовсе. Данное событие наступает, когда звук становится не слышен, что происходит, если аудио начало проигрываться и эффект затухания значителен, или когда звук был изначально слышен, но в связи с расстоянием до объекта эффект затухания снизил его громкость до нижнего предела.

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

Вводится в 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 указан явно) начнет воспроизведение с режимом проигрывания once или установленным до вызова вручную.

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

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

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

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

Примечание

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

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

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

Примечание

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

Advanced¶

local audio = reactorController:getReactorByName("Audio")

if audio:isPlaying() then
  doSomething()
end