Object AUDIO properties¶

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

The parameter allows to select an audio resource for a chosen object.

Note

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

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

Allows to set the volume of the audio resource. The maximum volume corresponds to the value 1, silent playback - value 0. The default value is 1. See the Установить громкость (setVolume) action for details.

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

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

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

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

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

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

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

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

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

Set a new audio resource (parameter Ресурс аудио (audioResource)).

Parameters:	Ресурс аудио / audioResource – The new audio resource to be exposed to the object.

This call is equivalent to assigning the parameter Ресурс аудио (audioResource)

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

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

Parameters:	громкость / volume – New volume level.

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

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

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

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

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

Events and actions of the object AUDIO (playback control)¶

Inserted into AudioReactor

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

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

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

Called when the user stops playing an audio resource. This event is fired only when the Остановить (stop) action is called while the audio is playing.

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

Called when the audio is paused. This event is fired only when the Приостановить (pause) action is called while the audio is playing.

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

Called when the audio is unpaused. This event is fired only when the Возобновить (resume) action is called on paused audio.

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

Called when the audio resource finishes playing. When the Остановить (stop) action is called, this event is not fired.

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

Start playing the audio resource from the beginning, regardless of the current state of the audio. When called, the Запущен (onStart) event comes.

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

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

If the Studio is set to Do not change, the mode specified in the object’s parameters will be set.

Note

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

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

Stop playback and rewind the audio to the beginning. If the audio has not been started and is in its initial state, the action will not work. On a successful call, the Остановлен (onStop) event comes.

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

Pause audio playback. If the audio has not been started and is in its initial state, the action will not work. On a successful call, the Приостановлен (onPause) event comes.

Note

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

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

Continue playing the audio resource from where it was paused. If the audio has not been started and is in its initial state, the action will not work. On successful call, the Возобновлён (onResume) event comes.

Note

Even if audio is currently playing, calling the Возобновлён (onResume) action will cause the Возобновлён (onResume) event to be fired.

Advanced¶

local audio = reactorController:getReactorByName("Audio")

if audio:isPlaying() then
  doSomething()
end