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

Eredita: Node2D < CanvasItem < Node < Object

Riproduce un suono posizionale in uno spazio 2D.

Descrizione

Riproduce audio attenuato in base alla distanza dall'ascoltatore.

Per impostazione predefinita, l'audio viene ascoltato dal centro dello schermo. Questo può essere modificato aggiungendo un nodo AudioListener2D alla scena e abilitandolo chiamando AudioListener2D.make_current() su di esso.

Vedi anche AudioStreamPlayer per riprodurre un suono non posizionale.

Nota: Nascondere un nodo AudioStreamPlayer2D non disabilita la sua produzione audio. Per disabilitare temporaneamente la produzione audio di un'AudioStreamPlayer2D, imposta volume_db su un valore molto basso come -100 (che non è percettibile dall'udito umano).

Tutorial

Proprietà

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

Metodi

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()

Segnali

finished() 🔗

Emesso al termine della riproduzione dell'audio.

Descrizioni delle proprietà

int area_mask = 0 🔗

  • void set_area_mask(value: int)

  • int get_area_mask()

Determina quali strati di un Area2D influenzano il suono per gli effetti di riverbero e per i bus audio. Le aree possono essere utilizzate per reindirizzare gli AudioStream in modo che siano riprodotti in un determinato bus audio. Un esempio di come potrebbe essere utilizzato è creando un'area di "acqua", in modo che i suoni riprodotti nell'acqua siano reindirizzati attraverso un bus audio per farli sembrare come se fossero riprodotti sott'acqua.

float attenuation = 1.0 🔗

  • void set_attenuation(value: float)

  • float get_attenuation()

Il volume si attenua con la distanza, utilizzando questo come esponente.

bool autoplay = false 🔗

  • void set_autoplay(value: bool)

  • bool is_autoplay_enabled()

Se true, l'audio viene riprodotto quando viene aggiunto all'albero di scene.

StringName bus = &"Master" 🔗

Bus su cui viene riprodotto questo audio.

Nota: Quando imposti questa proprietà, tieni presente che non viene eseguita alcuna convalida per vedere se il nome specificato corrisponde a un bus esistente. Questo perché i layout del bus audio potrebbero essere caricati dopo aver impostato questa proprietà. Se questo nome specificato non può essere risolto in fase di esecuzione, tornerà a "Master".

float max_distance = 2000.0 🔗

  • void set_max_distance(value: float)

  • float get_max_distance()

Distanza massima alla quale l'audio è ancora udibile.

int max_polyphony = 1 🔗

  • void set_max_polyphony(value: int)

  • int get_max_polyphony()

Il numero massimo di suoni che questo nodo può riprodurre allo stesso tempo. Riproducendo ulteriori suoni dopo aver raggiunto questo valore interromperà i suoni più vecchi.

float panning_strength = 1.0 🔗

  • void set_panning_strength(value: float)

  • float get_panning_strength()

Scala la forza di panning per questo nodo moltiplicando la base ProjectSettings.audio/general/2d_panning_strength con questo fattore. Valori più alti aumenteranno il panning dell'audio da sinistra a destra in modo più drammatico rispetto a valori più bassi.

float pitch_scale = 1.0 🔗

  • void set_pitch_scale(value: float)

  • float get_pitch_scale()

Il tono e il tempo dell'audio, come moltiplicatore della frequenza di campionamento del campione audio.

PlaybackType playback_type = 0 🔗

Sperimentale: Questa proprietà potrebbe essere cambiata o rimossa in versioni future.

Il tipo di riproduzione dello stream player. Se impostato diversamente dal valore predefinito, forzerà quel tipo di riproduzione.

bool playing = false 🔗

  • void set_playing(value: bool)

  • bool is_playing()

Se true, l'audio è in riproduzione o è in coda per la riproduzione (vedi play()).

AudioStream stream 🔗

L'oggetto AudioStream da riprodurre.

bool stream_paused = false 🔗

  • void set_stream_paused(value: bool)

  • bool get_stream_paused()

Se true, la riproduzione è in pausa. È possibile riprenderla impostando stream_paused su false.

float volume_db = 0.0 🔗

  • void set_volume_db(value: float)

  • float get_volume_db()

Volume di base prima dell'attenuazione, in decibel.

float volume_linear 🔗

  • void set_volume_linear(value: float)

  • float get_volume_linear()

Volume di base prima dell'attenuazione, come valore lineare.

Nota: Questo membro modifica volume_db per comodità. Il valore restituito è equivalente al risultato di @GlobalScope.db_to_linear() su volume_db. Impostare questo membro equivale a impostare volume_db sul risultato di @GlobalScope.linear_to_db() su un valore.

Descrizioni dei metodi

float get_playback_position() 🔗

Restituisce la posizione nell'AudioStream.

AudioStreamPlayback get_stream_playback() 🔗

Restituisce l'oggetto AudioStreamPlayback associato a questo AudioStreamPlayer2D.

bool has_stream_playback() 🔗

Restituisce se AudioStreamPlayer può restituire o meno l'oggetto AudioStreamPlayback.

void play(from_position: float = 0.0) 🔗

Mette in coda l'audio da riprodurre sul frame successivo di fisica, dalla posizione specificata from_position, in secondi.

void seek(to_position: float) 🔗

Imposta la posizione da cui sarà riprodotto l'audio, in secondi.

void stop() 🔗

Arresta l'audio.