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

Відтворює позиційний звук у двовимірному просторі.

Опис

Відтворює аудіо, яке послаблюється з відстанню до слухача.

За замовчуванням звук лунає з центру екрана. Це можна змінити, додавши до сцени вузол 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 впливають на звук реверберації та ефектів звукової шини. Області можна використовувати для перенаправлення AudioStream, щоб вони відтворювалися на певній аудіошині. Прикладом того, як це можна використовувати, є створення «водної» області, щоб звуки, що відтворюються у воді, перенаправлялися через аудіошину, щоб вони звучали так, ніби вони відтворюються під водою.

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" 🔗

  • void set_bus(value: StringName)

  • StringName get_bus()

Автобус, на якому відтворюється цей звук.

Примітка: Встановлюючи цю властивість, майте на увазі, що перевірка не виконується, щоб побачити, чи дане ім’я відповідає існуючій шині. Це пояснюється тим, що макети аудіошини можуть завантажуватися після встановлення цієї властивості. Якщо це задане ім’я не може бути визначено під час виконання, воно повернеться до "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() 🔗

Зупиняє аудіо.