AudioServer

public static int BusCount { get; set; }

Количество доступных аудиошин.

public static string InputDevice { get; set; }

Имя текущего устройства для аудиовхода (см. AudioServer.GetInputDeviceList). В системах с несколькими аудиовходами (например, аналоговыми, USB и HDMI аудио) это можно использовать для выбора устройства аудиовхода. Значение "Default" будет записывать звук на общесистемном аудиовходе по умолчанию. Если задано недопустимое имя устройства, значение будет возвращено к "Default". Примечание: ProjectSettings.audio/driver/enable_input должно быть true для работы аудиовхода. См. также описание этого параметра для предостережений, связанных с разрешениями и настройками конфиденциальности операционной системы.

public static string OutputDevice { get; set; }

Имя текущего устройства для аудиовыхода (см. AudioServer.GetOutputDeviceList). В системах с несколькими аудиовыходами (например, аналоговым, USB и HDMI аудио) это можно использовать для выбора устройства аудиовыхода. Значение "Default" будет воспроизводить звук на общесистемном аудиовыходе по умолчанию. Если задано недопустимое имя устройства, значение будет возвращено к "Default".

public static float PlaybackSpeedScale { get; set; }

Масштабирует скорость воспроизведения звука (например, если установить его на 0.5, звук будет воспроизводиться с половинной скоростью). См. также Engine.TimeScale, чтобы повлиять на общую скорость симуляции, которая не зависит от AudioServer.PlaybackSpeedScale.

public static void AddBus(int atPosition = -1);

Добавляет шину в at_position.

public static void AddBusEffect(int busIdx, AudioEffect effect, int atPosition = -1);

Добавляет эффект AudioEffect к шине bus_idx в at_position.

public static AudioBusLayout GenerateBusLayout();

Генерирует AudioBusLayout с использованием доступных шин и эффектов.

public static int GetBusChannels(int busIdx);

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

public static AudioEffect GetBusEffect(int busIdx, int effectIdx);

Возвращает AudioEffect в позиции effect_idx на шине bus_idx.

public static int GetBusEffectCount(int busIdx);

Возвращает количество эффектов на шине в bus_idx.

public static AudioEffectInstance GetBusEffectInstance(int busIdx, int effectIdx, int channel = 0);

Возвращает AudioEffectInstance, назначенный заданным индексам шины и эффекта (и, возможно, канала).

public static int GetBusIndex(StringName busName);

Возвращает текущий индекс шины по имени или -1, если её нет. После изменения layout ищите индекс заново; не храните его как стабильный идентификатор категории.

public static string GetBusName(int busIdx);

Возвращает имя шины с индексом bus_idx.

public static float GetBusPeakVolumeLeftDb(int busIdx, int channel);

Возвращает пиковую громкость левого динамика с индексом шины bus_idx и индексом канала channel.

public static float GetBusPeakVolumeRightDb(int busIdx, int channel);

Возвращает пиковую громкость правого динамика с индексом шины bus_idx и индексом канала channel.

public static StringName GetBusSend(int busIdx);

Возвращает имя шины, на которую отправляет данные шина с индексом bus_idx.

public static float GetBusVolumeDb(int busIdx);

Возвращает громкость шины по индексу bus_idx в дБ.

public static float GetBusVolumeLinear(int busIdx);

Возвращает громкость шины по индексу bus_idx как линейное значение. Примечание: Возвращаемое значение эквивалентно результату @GlobalScope.db_to_linear на результате AudioServer.GetBusVolumeDb.

public static string GetDriverName();

Возвращает имя текущего аудиодрайвера. Значение по умолчанию обычно зависит от операционной системы, но может быть переопределено с помощью --audio-driver аргумента командной строки. --headless также автоматически устанавливает аудиодрайвер в Dummy. См. также ProjectSettings.audio/driver/driver.

public static int GetInputBufferLengthFrames();

Возвращает абсолютный размер буфера входного сигнала микрофона. Он устанавливается равным кратному значению задержки звука и может использоваться для оценки минимальной скорости, с которой необходимо получать кадры.

public static string[] GetInputDeviceList();

Возвращает имена всех аудиовходных устройств, обнаруженных в системе. Примечание: ProjectSettings.audio/driver/enable_input должен быть true для работы аудиовхода. См. также описание этого параметра для предупреждений, связанных с разрешениями и настройками конфиденциальности операционной системы.

public static Vector2[] GetInputFrames(int frames);

Возвращает Vector2[], содержащий ровно frames аудиосэмплов из внутреннего буфера микрофона, если он доступен; в противном случае возвращает пустой Vector2[]. Буфер заполняется со скоростью AudioServer.GetInputMixRate кадров в секунду, если AudioServer.SetInputDeviceActive успешно установлен в true. Сэмплы представляют собой знаковые значения PCM с плавающей запятой в диапазоне от -1 до 1.

public static int GetInputFramesAvailable();

Возвращает количество кадров, доступных для чтения с помощью метода AudioServer.GetInputFrames.

public static float GetInputMixRate();

Возвращает частоту дискретизации на входе AudioServer.

public static float GetMixRate();

Возвращает частоту дискретизации на выходе AudioServer.

public static string[] GetOutputDeviceList();

Возвращает имена всех устройств вывода звука, обнаруженных в системе.

public static double GetOutputLatency();

Возвращает эффективную задержку вывода аудиодрайвера. Она основана на ProjectSettings.audio/driver/output_latency, но точное возвращаемое значение будет отличаться в зависимости от операционной системы и аудиодрайвера. Примечание: Это может быть затратно; не рекомендуется вызывать AudioServer.GetOutputLatency каждый кадр.

public static AudioServer.SpeakerMode GetSpeakerMode();

Возвращает конфигурацию динамиков.

public static double GetTimeSinceLastMix();

Возвращает относительное время в секундах с момента последнего микса.

public static double GetTimeToNextMix();

Возвращает относительное время до следующего микса в секундах.

public static bool IsBusBypassingEffects(int busIdx);

Если true, шина с индексом bus_idx обходит эффекты.

public static bool IsBusEffectEnabled(int busIdx, int effectIdx);

Если true, эффект с индексом effect_idx на шине с индексом bus_idx включен.

public static bool IsBusMute(int busIdx);

Если true, шина с индексом bus_idx отключается.

public static bool IsBusSolo(int busIdx);

Если true, шина с индексом bus_idx находится в одиночном режиме.

public static bool IsStreamRegisteredAsSample(AudioStream stream);

Если true, поток регистрируется как образец. Движку не придется регистрировать его перед воспроизведением образца. Если false, поток придется регистрировать перед его воспроизведением. Чтобы предотвратить скачки задержек, зарегистрируйте поток как образец с помощью AudioServer.RegisterStreamAsSample.

public static void Lock();

Блокирует основной цикл аудиодрайвера. Примечание: Не забудьте разблокировать его после этого.

public static void MoveBus(int index, int toIndex);

Перемещает шину с индекса index на индекс to_index.

public static void RegisterStreamAsSample(AudioStream stream);

Принудительно регистрирует поток как образец. Примечание: При вызове этого метода могут возникать скачки задержки, особенно в однопоточных сборках. Рекомендуется вызывать этот метод во время загрузки ресурсов, где скачок задержки может быть замаскирован, вместо регистрации образца непосредственно перед его воспроизведением.

public static void RemoveBus(int index);

Удаляет шину с индексом index.

public static void RemoveBusEffect(int busIdx, int effectIdx);

Удаляет эффект с индексом effect_idx из шины с индексом bus_idx.

public static void SetBusBypassEffects(int busIdx, bool enable);

Если true, шина с индексом bus_idx обходит эффекты.

public static void SetBusEffectEnabled(int busIdx, int effectIdx, bool enabled);

Если true, эффект с индексом effect_idx на шине с индексом bus_idx включен.

public static void SetBusLayout(AudioBusLayout busLayout);

Перезаписывает текущий используемый AudioBusLayout.

public static void SetBusMute(int busIdx, bool enable);

Глушит или возвращает выход шины; не останавливает и не приостанавливает её источники. Эффекты данной шины находятся до mute, поэтому Capture в ней может продолжать получать данные.

public static void SetBusName(int busIdx, string name);

Устанавливает имя шины с индексом bus_idx на name.

public static void SetBusSend(int busIdx, StringName send);

Задаёт принимающую шину по имени. При обработке она должна быть левее отправляющей; отсутствующее имя или направление вправо/на себя фактически направляет сигнал в Master. Индекс 0 — Master, у него нет следующего send.

public static void SetBusSolo(int busIdx, bool enable);

Если true, шина с индексом bus_idx находится в одиночном режиме.

public static void SetBusVolumeDb(int busIdx, float volumeDb);

Задаёт усиление шины в дБ: 0 — единичный коэффициент, около -6.02 — половина амплитуды. Это не значение цифрового пика dBFS. Усиление применяется после эффектов шины, перед отправкой дальше. Для нуля пользовательского ползунка удобен mute.

public static void SetBusVolumeLinear(int busIdx, float volumeLinear);

Устанавливает громкость как линейное значение шины с индексом bus_idx по volume_linear. Примечание: Использование этого метода эквивалентно вызову AudioServer.SetBusVolumeDb с результатом @GlobalScope.linear_to_db для значения.

public static void SetEnableTaggingUsedAudioStreams(bool enable);

Если установлено значение true, все экземпляры AudioStreamPlayback будут вызывать AudioStreamPlayback._TagUsedStreams на каждом шаге микширования. Примечание: Это включено по умолчанию в редакторе, так как используется плагинами редактора для предпросмотра аудиопотока.

public static Error SetInputDeviceActive(bool active);

Если active равно true, запускает поток входного сигнала с микрофона, указанный в AudioServer.InputDevice, или возвращает ошибку в случае сбоя. Если active равно false, останавливает поток входного сигнала, если он запущен.

public static void SwapBusEffects(int busIdx, int effectIdx, int byEffectIdx);

Меняет местами два эффекта в шине bus_idx.

public static void Unlock();

Разблокирует основной цикл аудиодрайвера. (После блокировки его всегда следует разблокировать.)

public static event Action BusLayoutChanged;

Издается при добавлении, удалении или перемещении аудиошины.

public static event AudioServer.BusRenamedEventHandler BusRenamed;

Вызывается, когда аудиошина в bus_index переименовывается из old_name в new_name.