play

Воспроизводит различные звуки.

Синтаксис

play [channelName] [trackName] {fadeIn} {fadeOut} {skip} {pause} {forceloop} |crossfade|

Параметры

• channelName — название звукового канала, на котором должен воспроизводиться трек (звук). Подробнее о звуковых каналах написано ниже.
  Обязательный параметр.
• trackName — название трека, который нужно проиграть.
  Обязательный параметр.
• fadeIn — время подъема громкости в секундах.
  Значение по умолчанию: 0.
• fadeOut — время затухания текущего активного на канале трека в секундах.
  Значение по умолчанию: 0.
• skip — время в секундах, которое будет пропущено у активного трека (например, чтобы воспроизвести трек не с самого начала, а с середины).
  Значение по умолчанию: 0.
• pause — задержка в секундах перед началом воспроизведения трека.
  Значение по умолчанию: 0.
• forceloop — булевое значение (true или false). Позволяет переопределить настройки зацикливания на звуковом канале. Если указано true — после окончания проигрывания трек будет воспроизводиться заново, если false — то не будет.
• crossfade — флаг. Если указан, то при смене трека на канале (включая повторное воспроизведение) будет использоваться перекрестное затухание, т.е. плавный переход между двумя треками. Данная функция использует значения параметров fadeIn и fadeOut для создания перехода между треками.
  

Звуковые каналы

Всего существует 4 звуковых канала:

• music — музыка
• ambience — фоновые звуки, звуки окружения
• sfx — различные звуковые эффекты
• loop — дополнительный канал для всего остального

У следующих каналов по умолчанию включено зацикливание треков:

• music
• ambience
• loop

У канала ambience все треки по умолчанию зацикливаются с флагом crossfade.

Производные каналы

Если вам нужно больше звуковых каналов (например, чтобы воспроизвести одновременно несколько звуков), вы можете создать производный канал из любого из 4-х основных каналов.

Для этого достаточно просто использовать любое название, которое начинается с имени нужного вам канала:

# воспроизводит трек summertime на канале music_2. 
# music_2 - копия канала music
play music_2 summertime

# воспроизводит звук door_bell_bar на канале sfx_2
# sfx_2 - копия канала sfx
play sfx_2 door_bell_bar