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...

AudioStreamPlayer3D

Eredita: Node3D < Node < Object

Riproduce un suono posizionale in uno spazio 3D.

Descrizione

Riproduce l'audio con effetti sonori posizionali, in base alla posizione relativa dell'ascoltatore audio. Gli effetti posizionali includono attenuazione della distanza, direzionalità ed effetto Doppler. Per un maggiore realismo, viene applicato un filtro passa-basso ai suoni distanti. Questo può essere disabilitato impostando attenuation_filter_cutoff_hz su 20500.

Per impostazione predefinita, l'audio viene ascoltato dalla posizione della telecamera. Questo può essere modificato aggiungendo un nodo AudioListener3D alla scena e abilitandolo chiamando AudioListener3D.make_current() su di esso.

Vedi anche AudioStreamPlayer per riprodurre un suono non posizionale.

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

Tutorial

Proprietà

int

area_mask

0

float

attenuation_filter_cutoff_hz

5000.0

float

attenuation_filter_db

-24.0

AttenuationModel

attenuation_model

0

bool

autoplay

false

StringName

bus

&"Master"

DopplerTracking

doppler_tracking

0

float

emission_angle_degrees

45.0

bool

emission_angle_enabled

false

float

emission_angle_filter_attenuation_db

-12.0

float

max_db

3.0

float

max_distance

0.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

unit_size

10.0

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.

Enumerazioni

enum AttenuationModel: 🔗

AttenuationModel ATTENUATION_INVERSE_DISTANCE = 0

Attenuazione del volume in base alla distanza lineare.

AttenuationModel ATTENUATION_INVERSE_SQUARE_DISTANCE = 1

Attenuazione del volume in base al quadrato della distanza.

AttenuationModel ATTENUATION_LOGARITHMIC = 2

Attenuazione del volume in base alla distanza logaritmica.

AttenuationModel ATTENUATION_DISABLED = 3

Nessuna attenuazione del volume in base alla distanza. Il suono sarà comunque udito in base alla posizione, a differenza di un AudioStreamPlayer. ATTENUATION_DISABLED può essere combinato con una max_distance maggiore di 0.0 per ottenere un'attenuazione lineare fissata a una sfera di una dimensione definita.

enum DopplerTracking: 🔗

DopplerTracking DOPPLER_TRACKING_DISABLED = 0

Disabilita il tracciamento Doppler.

DopplerTracking DOPPLER_TRACKING_IDLE_STEP = 1

Esegue il tracciamento doppler durante i frame di processo (vedi Node.NOTIFICATION_INTERNAL_PROCESS).

DopplerTracking DOPPLER_TRACKING_PHYSICS_STEP = 2

Esegue il tracciamento doppler durante i frame di processo di fisica (vedi Node.NOTIFICATION_INTERNAL_PHYSICS_PROCESS).

Descrizioni delle proprietà

int area_mask = 0 🔗

  • void set_area_mask(value: int)

  • int get_area_mask()

Determina quali strati di un Area3D 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_filter_cutoff_hz = 5000.0 🔗

  • void set_attenuation_filter_cutoff_hz(value: float)

  • float get_attenuation_filter_cutoff_hz()

La frequenza di taglio del filtro passa-basso di attenuazione, in Hz. Un suono al di sopra di questa frequenza viene attenuato di più di un suono al di sotto di questa frequenza. Per disabilitare questo effetto, impostalo su 20500 poiché questa frequenza è superiore al limite dell'udito umano.

float attenuation_filter_db = -24.0 🔗

  • void set_attenuation_filter_db(value: float)

  • float get_attenuation_filter_db()

Quantità di quanto il filtro influisce sul volume, in decibel.

AttenuationModel attenuation_model = 0 🔗

Decide se l'audio deve diventare più silenzioso con la distanza in modo lineare, quadratico, logaritmico o non essere influenzato dalla distanza, effettivamente disabilitando l'attenuazione.

bool autoplay = false 🔗

  • void set_autoplay(value: bool)

  • bool is_autoplay_enabled()

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

StringName bus = &"Master" 🔗

Il 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".

DopplerTracking doppler_tracking = 0 🔗

Decide in quale fase calcolare l'effetto Doppler.

Nota: Se doppler_tracking non è DOPPLER_TRACKING_DISABLED ma il Camera3D/AudioListener3D attuale ha il tracciamento Doppler disabilitato, l'effetto Doppler sarà udito ma non terrà conto del movimento dell'ascoltatore attuale. Se si desidera un effetto Doppler accurato, è necessario abilitare il tracciamento Doppler sia su AudioStreamPlayer3D sia sul Camera3D/AudioListener3D attuale.

float emission_angle_degrees = 45.0 🔗

  • void set_emission_angle(value: float)

  • float get_emission_angle()

L'angolazione in cui l'audio raggiunge l'ascoltatore senza attenuazione.

bool emission_angle_enabled = false 🔗

  • void set_emission_angle_enabled(value: bool)

  • bool is_emission_angle_enabled()

Se true, l'audio deve essere attenuato in base alla direzione del suono.

float emission_angle_filter_attenuation_db = -12.0 🔗

  • void set_emission_angle_filter_attenuation_db(value: float)

  • float get_emission_angle_filter_attenuation_db()

Fattore di attenuazione usato se l'ascoltatore è al di fuori di emission_angle_degrees e emission_angle_enabled è impostato, in decibel.

float max_db = 3.0 🔗

  • void set_max_db(value: float)

  • float get_max_db()

Imposta il massimo assoluto del livello sonoro, in decibel.

float max_distance = 0.0 🔗

  • void set_max_distance(value: float)

  • float get_max_distance()

La distanza oltre la quale il suono non può più essere udito. Ha effetto solo se impostato su un valore maggiore di 0.0. max_distance funziona in tandem con unit_size. Tuttavia, a differenza di unit_size il cui comportamento dipende da attenuation_model, max_distance funziona sempre in modo lineare. Questo può essere utilizzato per impedire a AudioStreamPlayer3D di richiedere il mixaggio audio quando l'ascoltatore è lontano, il che risparmia risorse sulla CPU.

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 l'intensità del panning per questo nodo moltiplicando la ProjectSettings.audio/general/3d_panning_strength base per questo fattore. Se il prodotto è 0.0, il panning stereo è disabilitato e il volume è lo stesso per tutti i canali. Se il prodotto è 1.0, uno dei canali sarà silenziato quando il suono si trova esattamente a sinistra (o a destra) dell'ascoltatore.

Le disposizioni stereo a due altoparlanti implementano lo standard WebAudio per il panning StereoPannerNode, dove il volume è il coseno di metà dell'angolo azimutale rispetto all'orecchio.

Per altre disposizioni di altoparlanti, come 5.1 e 7.1, è implementato l'algoritmo SPCAP (Speaker-Placement Correction Amplitude).

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 🔗

La risorsa 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 unit_size = 10.0 🔗

  • void set_unit_size(value: float)

  • float get_unit_size()

Il fattore per l'effetto di attenuazione. Valori più alti rendono il suono udibile a una distanza maggiore.

float volume_db = 0.0 🔗

  • void set_volume_db(value: float)

  • float get_volume_db()

Il livello sonoro di base prima dell'attenuazione, in decibel.

float volume_linear 🔗

  • void set_volume_linear(value: float)

  • float get_volume_linear()

Il livello sonoro 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 AudioStreamPlayer3D.

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.