AudioServer¶

Inherits: Object

Interfaz de servidor para acceso de audio de bajo nivel.

Descripción¶

AudioServer es una interfaz de servidor de bajo nivel para el acceso al audio. Se encarga de crear datos de muestra (audio reproducible) así como de su reproducción a través de una interfaz de voz.

Tutoriales¶

Propiedades¶

int	bus_count	`1`
String	device	`"Default"`
float	global_rate_scale	`1.0`

Métodos¶

void	add_bus ( int at_position=-1 )
void	add_bus_effect ( int bus_idx, AudioEffect effect, int at_position=-1 )
String	capture_get_device ( )
Array	capture_get_device_list ( )
void	capture_set_device ( String name )
AudioBusLayout	generate_bus_layout ( ) const
int	get_bus_channels ( int bus_idx ) const
AudioEffect	get_bus_effect ( int bus_idx, int effect_idx )
int	get_bus_effect_count ( int bus_idx )
AudioEffectInstance	get_bus_effect_instance ( int bus_idx, int effect_idx, int channel=0 )
int	get_bus_index ( String bus_name ) const
String	get_bus_name ( int bus_idx ) const
float	get_bus_peak_volume_left_db ( int bus_idx, int channel ) const
float	get_bus_peak_volume_right_db ( int bus_idx, int channel ) const
String	get_bus_send ( int bus_idx ) const
float	get_bus_volume_db ( int bus_idx ) const
Array	get_device_list ( )
float	get_mix_rate ( ) const
float	get_output_latency ( ) const
SpeakerMode	get_speaker_mode ( ) const
float	get_time_since_last_mix ( ) const
float	get_time_to_next_mix ( ) const
bool	is_bus_bypassing_effects ( int bus_idx ) const
bool	is_bus_effect_enabled ( int bus_idx, int effect_idx ) const
bool	is_bus_mute ( int bus_idx ) const
bool	is_bus_solo ( int bus_idx ) const
void	lock ( )
void	move_bus ( int index, int to_index )
void	remove_bus ( int index )
void	remove_bus_effect ( int bus_idx, int effect_idx )
void	set_bus_bypass_effects ( int bus_idx, bool enable )
void	set_bus_effect_enabled ( int bus_idx, int effect_idx, bool enabled )
void	set_bus_layout ( AudioBusLayout bus_layout )
void	set_bus_mute ( int bus_idx, bool enable )
void	set_bus_name ( int bus_idx, String name )
void	set_bus_send ( int bus_idx, String send )
void	set_bus_solo ( int bus_idx, bool enable )
void	set_bus_volume_db ( int bus_idx, float volume_db )
void	swap_bus_effects ( int bus_idx, int effect_idx, int by_effect_idx )
void	unlock ( )

Señales¶

bus_layout_changed ( )

Se emite cuando cambia el AudioBusLayout.

Enumeraciones¶

enum SpeakerMode:

SPEAKER_MODE_STEREO = 0 --- Se detectaron dos o menos altavoces.
SPEAKER_SURROUND_31 = 1 --- Se detectó una configuración de sonido envolvente de 3.1 canales.
SPEAKER_SURROUND_51 = 2 --- Se detectó una configuración de sonido envolvente de 5.1 canales.
SPEAKER_SURROUND_71 = 3 --- Se detectó una configuración de sonido envolvente de 7.1 canales.

Descripciones de Propiedades¶

int bus_count

Default	`1`
Setter	set_bus_count(value)
Getter	get_bus_count()

Número de buses de audio disponibles.

String device

Default	`"Default"`
Setter	set_device(value)
Getter	get_device()

Nombre del dispositivo actual para la salida de audio (ver get_device_list).

float global_rate_scale

Default	`1.0`
Setter	set_global_rate_scale(value)
Getter	get_global_rate_scale()

Escala la velocidad a la que se reproduce el audio (es decir, si se ajusta a 0,5 el audio se reproducirá el doble de rápido).

Descripciones de Métodos¶

void add_bus ( int at_position=-1 )

Añade un bus en at_position.

void add_bus_effect ( int bus_idx, AudioEffect effect, int at_position=-1 )

Añade un efecto AudioEffect al bus bus_idx en at_position.

String capture_get_device ( )

Nombre del dispositivo actual para la entrada de audio (ver capture_get_device_list).

Array capture_get_device_list ( )

Devuelve los nombres de todos los dispositivos de entrada de audio detectados en el sistema.

void capture_set_device ( String name )

Establece qué dispositivo de entrada de audio se utiliza para la captura de audio.

AudioBusLayout generate_bus_layout ( ) const

Genera un AudioBusLayout usando los buses y efectos disponibles.

int get_bus_channels ( int bus_idx ) const

Devuelve la cantidad de canales del bus en el índice bus_idx.

AudioEffect get_bus_effect ( int bus_idx, int effect_idx )

Devuelve el AudioEffect en la posición effect_idx en el bus bus_idx.

int get_bus_effect_count ( int bus_idx )

Devuelve el número de efectos en el bus en bus_idx.

AudioEffectInstance get_bus_effect_instance ( int bus_idx, int effect_idx, int channel=0 )

Devuelve la AudioEffectInstance asignada al bus dado y los indices de efecto (y opcionalmente el canal).

int get_bus_index ( String bus_name ) const

Devuelve el índice del bus con el nombre bus_name.

String get_bus_name ( int bus_idx ) const

Devuelve el nombre del bus con el índice bus_idx.

float get_bus_peak_volume_left_db ( int bus_idx, int channel ) const

Devuelve el volumen máximo del altavoz izquierdo en el índice de bus bus_idx y el índice de canal channel.

float get_bus_peak_volume_right_db ( int bus_idx, int channel ) const

Devuelve el volumen máximo del altavoz derecho en el índice de bus bus_idx y el índice de canal channel.

String get_bus_send ( int bus_idx ) const

Devuelve el nombre del bus al que el bus en el índice bus_idx envía.

float get_bus_volume_db ( int bus_idx ) const

Devuelve el volumen del bus con el índice bus_idx en dB.

Array get_device_list ( )

Devuelve los nombres de todos los dispositivos de audio detectados en el sistema.

float get_mix_rate ( ) const

Devuelve la frecuencia de muestreo a la salida del AudioServer.

float get_output_latency ( ) const

Devuelve la latencia de salida del controlador de audio.

SpeakerMode get_speaker_mode ( ) const

Devuelve la configuración de los altavoces.

float get_time_since_last_mix ( ) const

Devuelve el tiempo relativo desde que se produjo la última mezcla.

float get_time_to_next_mix ( ) const

Devuelve el tiempo relativo hasta que se produce la siguiente mezcla.

bool is_bus_bypassing_effects ( int bus_idx ) const

Si true, el bus en el índice bus_idx está ignorando los efectos.

bool is_bus_effect_enabled ( int bus_idx, int effect_idx ) const

Si true, se activa el efecto en el índice effect_idx del bus en al índice bus_idx de bus habilidato.

bool is_bus_mute ( int bus_idx ) const

Si true, el bus en el índice bus_idx se silencia.

bool is_bus_solo ( int bus_idx ) const

Si true, el bus en el índice bus_idx está en modo solo.

void lock ( )

Bloquea el bucle principal del controlador de audio.

Nota: Recuerde desbloquearlo después.

void move_bus ( int index, int to_index )

Mueve el bus desde el índice index a índice to_index.

void remove_bus ( int index )

Elimina el bus en el índice index.

void remove_bus_effect ( int bus_idx, int effect_idx )

Elimina el efecto en el índice effect_idx del bus en el índice bus_idx.

void set_bus_bypass_effects ( int bus_idx, bool enable )

Si true, el bus en el índice bus_idx está ignorando los efectos.

void set_bus_effect_enabled ( int bus_idx, int effect_idx, bool enabled )

Si true, se activa el efecto en el índice effect_idx del bus en al índice bus_idx de bus habilidato.

void set_bus_layout ( AudioBusLayout bus_layout )

Sobrescribe el AudioBusLayout actualmente utilizado.

void set_bus_mute ( int bus_idx, bool enable )

Si true, el bus en el índice bus_idx se silencia.

void set_bus_name ( int bus_idx, String name )

Establece el nombre del bus en el índice bus_idx a name.

void set_bus_send ( int bus_idx, String send )

Conecta la salida del bus en bus_idx al bus llamado send.

void set_bus_solo ( int bus_idx, bool enable )

Si true, el bus en el índice bus_idx está en modo solo.

void set_bus_volume_db ( int bus_idx, float volume_db )

Establece el volumen del bus en el índice bus_idx a volume_db.

void swap_bus_effects ( int bus_idx, int effect_idx, int by_effect_idx )

Cambia la posición de dos efectos en el bus bus_idx.

void unlock ( )

Desbloquea el bucle principal del controlador de audio. (Después de cerrarlo, siempre debes abrirlo.)