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

Hérite de : Node2D < CanvasItem < Node < Object

Joue un son localisé dans un espace 2D.

Description

Joue de l'audio qui est atténué avec la distance à l'auditeur.

Par défaut, l'audio est entendu du centre de l'écran. Cela peut être changé en ajoutant un nœud AudioListener2D à la scène et en l'activant en appelant AudioListener2D.make_current() dessus.

Voir aussi AudioStreamPlayer pour jouer un son non-positionnel.

Note : Cacher un nœud AudioStreamPlayer2D ne désactive pas sa sortie audio. Pour désactiver temporairement la sortie audio d'AudioStreamPlayer2D, définissez volume_db à une valeur très basse comme -100 (qui n'est pas audible par l'homme).

Tutoriels

Propriétés

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

Méthodes

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

Signaux

finished() 🔗

Émis quand l'audio a fini de jouer.

Descriptions des propriétés

int area_mask = 0 🔗

  • void set_area_mask(value: int)

  • int get_area_mask()

Détermine quelles calques du Area2D affectent le son pour les effets de réverbération et du bus audio. Les zones peuvent être utilisées pour rediriger le AudioStream afin qu'ils soient joués dans un certain bus audio. Un exemple de la façon dont vous pouvez utiliser ceci est de faire une zone "eau" de sorte que les sons joués dans l'eau sont redirigés par un bus audio pour les faire sonner comme ils étaient joués sous l'eau.

float attenuation = 1.0 🔗

  • void set_attenuation(value: float)

  • float get_attenuation()

Le volume est atténué avec la distance avec ceci comme exposant.

bool autoplay = false 🔗

  • void set_autoplay(value: bool)

  • bool is_autoplay_enabled()

Si true, il commence à jouer dès qu'il est ajouté à l'arbre des scènes.

StringName bus = &"Master" 🔗

Bus sur lequel cette audio joue.

Note : Lorsque vous définissez cette propriété, n'oubliez pas qu'aucune validation n'est effectuée pour voir si le nom donné correspond à un bus existant. C'est parce que les configurations de bus audio peuvent être chargées après que cette propriété soit définie. Si ce nom ne peut pas être résolu en cours d'exécution, il va se replier sur "Master".

float max_distance = 2000.0 🔗

  • void set_max_distance(value: float)

  • float get_max_distance()

Distance maximale à laquelle cette piste audio peut être entendue.

int max_polyphony = 1 🔗

  • void set_max_polyphony(value: int)

  • int get_max_polyphony()

Le nombre maximum de sons que ce nœud peut jouer en même temps. Jouer des sons supplémentaires après que cette valeur est atteinte coupera les sons les plus anciens.

float panning_strength = 1.0 🔗

  • void set_panning_strength(value: float)

  • float get_panning_strength()

Redimensionne la force de balance de ce nœud en multipliant la base ProjectSettings.audio/general/2d_panning_strength par ce facteur. Des valeurs plus élevées vont balancer l'audio de gauche à droite plus dramatiquement que les valeurs plus faibles.

float pitch_scale = 1.0 🔗

  • void set_pitch_scale(value: float)

  • float get_pitch_scale()

La hauteur et le tempo de l'audio, en tant que multiplicateur du taux d'échantillonnage de l’échantillon audio.

PlaybackType playback_type = 0 🔗

Expérimental : Cette propriété peut être changée ou retirée dans de futures versions.

Le type de lecture du lecteur de flux. Si défini à autre chose que la valeur par défaut, elle forcera ce type de lecture.

bool playing = false 🔗

  • void set_playing(value: bool)

  • bool is_playing()

Si true, l'audio joue ou est en file pour être joué (voir play()).

AudioStream stream 🔗

L'objet AudioStream à jouer.

bool stream_paused = false 🔗

  • void set_stream_paused(value: bool)

  • bool get_stream_paused()

Si true, la lecture est en pause. Vous pouvez la reprendre en définissant stream_paused à false.

float volume_db = 0.0 🔗

  • void set_volume_db(value: float)

  • float get_volume_db()

Volume de base avant atténuation, en décibels.

float volume_linear 🔗

  • void set_volume_linear(value: float)

  • float get_volume_linear()

Volume de base avant atténuation, en tant que valeur linéaire.

Note : Ce membre modifie volume_db par commodité. La valeur renvoyée est équivalente au résultat de @GlobalScope.db_to_linear() sur volume_db. Définir ce membre est équivalent à définir volume_db au résultat de @GlobalScope.linear_to_db() sur une valeur.

Descriptions des méthodes

float get_playback_position() 🔗

Renvoie la position dans l'AudioStream.

AudioStreamPlayback get_stream_playback() 🔗

Renvoie l'objet AudioStreamPlayback associé avec cet AudioStreamPlayer2D.

bool has_stream_playback() 🔗

Renvoie si l'AudioStreamPlayer peut renvoyer l'objet AudioStreamPlayback ou non.

void play(from_position: float = 0.0) 🔗

Met dans la file d'attente la piste audio à jouer lors de la prochaine trame physique, depuis la position from_position donnée, en secondes.

void seek(to_position: float) 🔗

Définit la position depuis laquelle l’audio sera joué, en secondes.

void stop() 🔗

Arrête l'audio.