Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

AudioStreamPlayer2D

Наследует: Node2D < CanvasItem < Node < Object

Воспроизводит позиционный звук в 2D-пространстве.

Описание

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

По умолчанию звук слышен из центра экрана. Это можно изменить, добавив узел AudioListener2D к сцене и включив его, вызвав AudioListener2D.make_current() для него.

См. также AudioStreamPlayer, чтобы воспроизвести звук непозиционно.

Примечание: Скрытие узла AudioStreamPlayer2D не отключает его аудиовыход. Чтобы временно отключить аудиовыход AudioStreamPlayer2D, установите volume_db на очень низкое значение, например -100 (которое не слышно человеческому слуху).

Обучающие материалы

Свойства

int

area_mask

0

float

attenuation

1.0

bool

autoplay

false

StringName

bus

&"Master"

float

max_distance

2000.0

int

max_polyphony

1

float

panning_strength

1.0

float

pitch_scale

1.0

PlaybackType

playback_type

0

bool

playing

false

AudioStream

stream

bool

stream_paused

false

float

volume_db

0.0

float

volume_linear

Методы

float

get_playback_position()

AudioStreamPlayback

get_stream_playback()

bool

has_stream_playback()

void

play(from_position: float = 0.0)

void

seek(to_position: float)

void

stop()

Сигналы

finished() 🔗

Издается, когда прекращается воспроизведение звука.

Описания свойств

int area_mask = 0 🔗

  • void set_area_mask(value: int)

  • int get_area_mask()

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

float attenuation = 1.0 🔗

  • void set_attenuation(value: float)

  • float get_attenuation()

Громкость звука уменьшается с расстоянием, причем показатель степени равен этому показателю.

bool autoplay = false 🔗

  • void set_autoplay(value: bool)

  • bool is_autoplay_enabled()

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

StringName bus = &"Master" 🔗

Шина, на которой воспроизводится этот звук.

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

float max_distance = 2000.0 🔗

  • void set_max_distance(value: float)

  • float get_max_distance()

Максимальное расстояние при котором можно услышать аудио.

int max_polyphony = 1 🔗

  • void set_max_polyphony(value: int)

  • int get_max_polyphony()

Максимальное количество звуков, которые этот узел может воспроизводить одновременно. Воспроизведение дополнительных звуков после достижения этого значения приведет к отключению самых старых звуков.

float panning_strength = 1.0 🔗

  • void set_panning_strength(value: float)

  • float get_panning_strength()

Масштабирует силу панорамирования для этого узла, умножая базу ProjectSettings.audio/general/2d_panning_strength на этот коэффициент. Более высокие значения будут панорамировать аудио слева направо более драматично, чем более низкие значения.

float pitch_scale = 1.0 🔗

  • void set_pitch_scale(value: float)

  • float get_pitch_scale()

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

PlaybackType playback_type = 0 🔗

Экспериментальное: Это свойство может быть изменено или удалено в будущих версиях.

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

bool playing = false 🔗

  • void set_playing(value: bool)

  • bool is_playing()

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

AudioStream stream 🔗

Объект AudioStream для воспроизведения.

bool stream_paused = false 🔗

  • void set_stream_paused(value: bool)

  • bool get_stream_paused()

Если true, воспроизведение приостанавливается. Вы можете возобновить его, установив stream_paused на false.

float volume_db = 0.0 🔗

  • void set_volume_db(value: float)

  • float get_volume_db()

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

float volume_linear 🔗

  • void set_volume_linear(value: float)

  • float get_volume_linear()

Базовый объем до затухания, как линейное значение.

Примечание: Этот член изменяет volume_db для удобства. Возвращаемое значение эквивалентно результату @GlobalScope.db_to_linear() для volume_db. Установка этого члена эквивалентна установке volume_db на результат @GlobalScope.linear_to_db() для значения.

Описания метода

float get_playback_position() 🔗

Возвращает позицию в AudioStream.

AudioStreamPlayback get_stream_playback() 🔗

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

bool has_stream_playback() 🔗

Возвращает, может ли AudioStreamPlayer вернуть объект AudioStreamPlayback или нет.

void play(from_position: float = 0.0) 🔗

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

void seek(to_position: float) 🔗

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

void stop() 🔗

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