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

AudioStreamRandomizer

Hérite de : AudioStream < Resource < RefCounted < Object

Enveloppe un pool de flux audios avec un décalage de pitch et de volume.

Description

Choisi un AudioStream aléatoire dans le pool, suivant le mode de playback et applique un décalage aléatoire au pitch et un décalage du volume pendant le playback.

Tutoriels

Flux audio

Propriétés

PlaybackMode	playback_mode	`0`
float	random_pitch	`1.0`
float	random_pitch_semitones	`0.0`
float	random_volume_offset_db	`0.0`
AudioStream	stream_{index}/stream
float	stream_{index}/weight	`1.0`
int	streams_count	`0`

Méthodes

void	add_stream(index: int, stream: AudioStream, weight: float = 1.0)
AudioStream	get_stream(index: int) const
float	get_stream_probability_weight(index: int) const
void	move_stream(index_from: int, index_to: int)
void	remove_stream(index: int)
void	set_stream(index: int, stream: AudioStream)
void	set_stream_probability_weight(index: int, weight: float)

Énumérations

enum PlaybackMode: 🔗

PlaybackMode PLAYBACK_RANDOM_NO_REPEATS = 0

Choisit un flux au hasard selon les coefficients de probabilité choisis pour chaque flux, mais évite de jouer le même flux deux fois de suite tant que possible. Si seulement 1 son est présent dans la pool, le même son jouera toujours, autorisant effectivement les répétitions.

PlaybackMode PLAYBACK_RANDOM = 1

Choisit un flux au hasard selon les coefficients de probabilité choisis pour chaque flux. Si seulement 1 son est présent dans la pool, le même son jouera toujours.

PlaybackMode PLAYBACK_SEQUENTIAL = 2

Joue des flux dans l'ordre qu'ils apparaissent dans la pool de flux. Si seulement 1 son est présent dans la piscine, le même son jouera toujours.

Descriptions des propriétés

PlaybackMode playback_mode = 0 🔗

void set_playback_mode(value: PlaybackMode)
PlaybackMode get_playback_mode()

Contrôle comment cet AudioStreamRandomizer choisit quel AudioStream joue ensuite.

float random_pitch = 1.0 🔗

void set_random_pitch(value: float)
float get_random_pitch()

Le plus grand multiplicateur de fréquence possible de la variation aléatoire de la hauteur. La hauteur sera choisie aléatoirement dans une plage de 1.0 / random_pitch et random_pitch. Une valeur de 1.0 ne signifie aucune variation. Une valeur de 2.0 signifie que la hauteur sera aléatoire entre le double et la moitié.

Note : Définir cette propriété définit également random_pitch_semitones.

float random_pitch_semitones = 0.0 🔗

void set_random_pitch_semitones(value: float)
float get_random_pitch_semitones()

La plus grande distance possible, en demi-tons, de la variation aléatoire de la hauteur. Une valeur de 0.0 signifie aucune variation.

Note : Définir cette propriété définit également random_pitch.

float random_volume_offset_db = 0.0 🔗

void set_random_volume_offset_db(value: float)
float get_random_volume_offset_db()

L'intensité de la variation aléatoire du volume. Le volume sera augmenté ou diminué par une valeur aléatoire jusqu'à random_volume_offset_db. Une valeur de 0.0 signifie aucune variation. Une valeur de 3.0 signifie que le volume sera aléatoire entre -3.0 dB et +3.0 dB.

AudioStream stream_{index}/stream 🔗

The AudioStream at index.

Note: index is a value in the 0 .. streams_count - 1 range.

float stream_{index}/weight = 1.0 🔗

The probability weight of the AudioStream at index.

Note: index is a value in the 0 .. streams_count - 1 range.

int streams_count = 0 🔗

void set_streams_count(value: int)
int get_streams_count()

Le nombre de flux dans le pool de flux.

Descriptions des méthodes

void add_stream(index: int, stream: AudioStream, weight: float = 1.0) 🔗

Insère un flux à l'index spécifié. Si l'index est inférieur à zéro, l'insertion se produit à la fin de la pool sous-jacente.

AudioStream get_stream(index: int) const 🔗

Renvoie le flux à l'index spécifié.

float get_stream_probability_weight(index: int) const 🔗

Renvoie le coefficient de probabilité associé avec le flux à l'indice donné.

void move_stream(index_from: int, index_to: int) 🔗

Déplace un flux d'un index à un autre.

void remove_stream(index: int) 🔗

Retire le flux à l'index spécifié.

void set_stream(index: int, stream: AudioStream) 🔗

Définit l'AudioStream à l'index spécifié.

void set_stream_probability_weight(index: int, weight: float) 🔗

Définit le coefficient de probabilité du flux à l'index spécifié. Plus cette valeur est élevée, plus le randomiseur choisira ce flux durant les modes de lecture aléatoire.