AudioStreamPlayer3D

public uint AreaMask { get; set; }

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

public float AttenuationFilterCutoffHz { get; set; }

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

public float AttenuationFilterDb { get; set; }

Величина, в которой фильтр влияет на громкость, в децибелах.

public AudioStreamPlayer3D.AttenuationModelEnum AttenuationModel { get; set; }

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

public bool Autoplay { get; set; }

Если true, звук воспроизводится при добавлении узла AudioStreamPlayer3D в дерево сцены.

public StringName Bus { get; set; }

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

public AudioStreamPlayer3D.DopplerTrackingEnum DopplerTracking { get; set; }

Решает, на каком этапе следует рассчитывать эффект Доплера. Примечание: Если AudioStreamPlayer3D.DopplerTracking не является AudioStreamPlayer3D.DopplerTrackingEnum.Disabled, но в текущем Camera3D/AudioListener3D отключён доплеровский трекинг, эффект Доплера будет слышен, но не будет учитывать движение текущего слушателя. Для получения точного доплеровского трекинга доплеровский трекинг следует включить как в AudioStreamPlayer3D, так и в текущем Camera3D/AudioListener3D.

public float EmissionAngleDegrees { get; set; }

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

public bool EmissionAngleEnabled { get; set; }

Если true, звук должен быть ослаблен в соответствии с направлением звука.

public float EmissionAngleFilterAttenuationDb { get; set; }

Коэффициент затухания, используемый, если слушатель находится за пределами AudioStreamPlayer3D.EmissionAngleDegrees и задан AudioStreamPlayer3D.EmissionAngleEnabled, в децибелах.

public float MaxDb { get; set; }

Устанавливает абсолютный максимум уровня звука в децибелах.

public float MaxDistance { get; set; }

Расстояние, за пределами которого звук больше не слышен. Действует только если установлено значение больше 0.0. AudioStreamPlayer3D.MaxDistance работает в паре с AudioStreamPlayer3D.UnitSize. Однако, в отличие от AudioStreamPlayer3D.UnitSize, поведение которого зависит от AudioStreamPlayer3D.AttenuationModel, AudioStreamPlayer3D.MaxDistance всегда работает линейно. Это можно использовать для предотвращения необходимости микширования звука AudioStreamPlayer3D, когда слушатель находится далеко, что экономит ресурсы ЦП.

public int MaxPolyphony { get; set; }

Максимальное число одновременных голосов этого плеера. Новый Play при превышении лимита вытесняет самый старый голос. Используйте положительное значение; для одного управляемого музыкального потока задайте 1.

public float PanningStrength { get; set; }

Масштабирует силу панорамирования для этого узла, умножая базовый ProjectSettings.audio/general/3d_panning_strength на этот коэффициент. Если произведение равно 0.0, то стереопанорамирование отключено, а громкость одинакова для всех каналов. Если произведение равно 1.0, то один из каналов будет отключен, когда звук расположен точно слева (или справа) от слушателя. Двухканальные стереосистемы реализуют стандарт WebAudio для панорамирования StereoPannerNode, где громкость равна косинусу половины угла азимута к уху. Для других схем расположения динамиков, таких как 5.1 и 7.1, реализован алгоритм SPCAP (Амплитуда коррекции спикера-установка).

public float PitchScale { get; set; }

Высота тона и темп звука как множитель частоты дискретизации аудиосэмпла.

public AudioServer.PlaybackType PlaybackType { get; set; }

Тип воспроизведения потокового проигрывателя. Если установлено значение, отличное от значения по умолчанию, будет принудительно выбран этот тип воспроизведения.

public bool Playing { get; set; }

Если true, звук воспроизводится или поставлен в очередь на воспроизведение (см. AudioStreamPlayer3D.Play).

public AudioStream Stream { get; set; }

Ресурс AudioStream для воспроизведения.

public bool StreamPaused { get; set; }

Приостанавливает существующие голоса или возобновляет их. Без голосов предварительная команда не сохраняется. В режиме Stream пауза делает IsPlaying() ложным, сохраняя HasStreamPlayback().

public float UnitSize { get; set; }

Фактор эффекта затухания. Более высокие значения делают звук слышимым на большем расстоянии.

public float VolumeDb { get; set; }

Базовый уровень звука до затухания, в децибелах.

public float VolumeLinear { get; set; }

Базовый уровень звука до затухания, как линейное значение. Примечание: Этот член изменяет AudioStreamPlayer3D.VolumeDb для удобства. Возвращаемое значение эквивалентно результату @GlobalScope.db_to_linear для AudioStreamPlayer3D.VolumeDb. Установка этого члена эквивалентна установке AudioStreamPlayer3D.VolumeDb на результат @GlobalScope.linear_to_db для значения.

public float GetPlaybackPosition();

Возвращает позицию последнего созданного голоса в секундах, а не общее время всех голосов. Между смешиваниями значение может меняться ступенчато. Для одного потока со скоростью 1 оценку можно уточнить временем после последнего mix; паузу, перемотку и задержку вывода учитывайте отдельно.

public AudioStreamPlayback GetStreamPlayback();

Возвращает объект AudioStreamPlayback, связанный с этим AudioStreamPlayer3D.

public bool HasStreamPlayback();

Проверяет, хранит ли плеер объекты воспроизведения, включая приостановленные. Это не признак слышимого сигнала: mute, расстояние или пауза могут давать тишину.

public bool IsPlaying();

В режиме Stream возвращает true для активно играющего голоса. На паузе false; для наличия сохранённого воспроизведения проверяйте HasStreamPlayback() или StreamPaused. Не отсекайте этим методом команду возобновления.

public void Play(float fromPosition = 0f);

Ставит звук в очередь для воспроизведения в следующем физическом кадре, начиная с указанной позиции from_position в секундах.

public void Seek(float toPosition);

Перезапускает плеер с заданной позиции в секундах только при активном воспроизведении. Останавливает прежние голоса и запускает новый с позиции. В режиме Stream на паузе или остановке ничего не делает. Для перемотки с сохранением паузы явно сохраните флаг, вызовите Stop(), Play(position) и восстановите StreamPaused.

public void Stop();

Остановка звука.

public event Action Finished;

Выдаётся, когда при обновлении удалён один или несколько естественно завершившихся голосов. Другие голоса могут ещё играть. Stop() и вытеснение по лимиту не означают естественное завершение; цикл не выдаёт этот сигнал на каждом круге.