Struct AudioServer
#[repr(C)]pub struct AudioServer { /* private fields */ }
Expand description
Godot class AudioServer.
Inherits Object
.
Related symbols:
audio_server
: sidecar module with related enum/flag typesSignalsOfAudioServer
: signal collection
See also Godot docs for AudioServer
.
§Singleton
This class is a singleton. You can get the one instance using AudioServer::singleton()
.
§Final class
This class is final, meaning you cannot inherit from it, and it comes without I*
interface trait. It is still possible that other Godot classes inherit from it, but that is limited to the engine itself.
Implementations§
§impl AudioServer
impl AudioServer
pub fn singleton() -> Gd<AudioServer>
pub fn set_bus_count(&mut self, amount: i32)
pub fn get_bus_count(&self) -> i32
pub fn remove_bus(&mut self, index: i32)
pub fn add_bus(&mut self)
pub fn add_bus(&mut self)
To set the default parameters, use Self::add_bus_ex
and its builder methods. See the book for detailed usage instructions.
pub fn add_bus_ex<'a>(&'a mut self) -> ExAddBus<'a>
pub fn move_bus(&mut self, index: i32, to_index: i32)
pub fn set_bus_name(&mut self, bus_idx: i32, name: impl AsArg<GString>)
pub fn get_bus_name(&self, bus_idx: i32) -> GString
pub fn get_bus_index(&self, bus_name: impl AsArg<StringName>) -> i32
pub fn get_bus_channels(&self, bus_idx: i32) -> i32
pub fn set_bus_volume_db(&mut self, bus_idx: i32, volume_db: f32)
pub fn get_bus_volume_db(&self, bus_idx: i32) -> f32
pub fn set_bus_volume_linear(&mut self, bus_idx: i32, volume_linear: f32)
pub fn get_bus_volume_linear(&self, bus_idx: i32) -> f32
pub fn set_bus_send(&mut self, bus_idx: i32, send: impl AsArg<StringName>)
pub fn get_bus_send(&self, bus_idx: i32) -> StringName
pub fn set_bus_solo(&mut self, bus_idx: i32, enable: bool)
pub fn is_bus_solo(&self, bus_idx: i32) -> bool
pub fn set_bus_mute(&mut self, bus_idx: i32, enable: bool)
pub fn is_bus_mute(&self, bus_idx: i32) -> bool
pub fn set_bus_bypass_effects(&mut self, bus_idx: i32, enable: bool)
pub fn is_bus_bypassing_effects(&self, bus_idx: i32) -> bool
pub fn add_bus_effect(
&mut self,
bus_idx: i32,
effect: impl AsArg<Option<Gd<AudioEffect>>>,
)
pub fn add_bus_effect( &mut self, bus_idx: i32, effect: impl AsArg<Option<Gd<AudioEffect>>>, )
To set the default parameters, use Self::add_bus_effect_ex
and its builder methods. See the book for detailed usage instructions.
pub fn add_bus_effect_ex<'a>( &'a mut self, bus_idx: i32, effect: impl AsArg<Option<Gd<AudioEffect>>> + 'a, ) -> ExAddBusEffect<'a>
pub fn remove_bus_effect(&mut self, bus_idx: i32, effect_idx: i32)
pub fn get_bus_effect_count(&mut self, bus_idx: i32) -> i32
pub fn get_bus_effect( &mut self, bus_idx: i32, effect_idx: i32, ) -> Option<Gd<AudioEffect>>
pub fn get_bus_effect_instance(
&mut self,
bus_idx: i32,
effect_idx: i32,
) -> Option<Gd<AudioEffectInstance>>
pub fn get_bus_effect_instance( &mut self, bus_idx: i32, effect_idx: i32, ) -> Option<Gd<AudioEffectInstance>>
To set the default parameters, use Self::get_bus_effect_instance_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_bus_effect_instance_ex<'a>( &'a mut self, bus_idx: i32, effect_idx: i32, ) -> ExGetBusEffectInstance<'a>
pub fn swap_bus_effects( &mut self, bus_idx: i32, effect_idx: i32, by_effect_idx: i32, )
pub fn set_bus_effect_enabled( &mut self, bus_idx: i32, effect_idx: i32, enabled: bool, )
pub fn is_bus_effect_enabled(&self, bus_idx: i32, effect_idx: i32) -> bool
pub fn get_bus_peak_volume_left_db(&self, bus_idx: i32, channel: i32) -> f32
pub fn get_bus_peak_volume_right_db(&self, bus_idx: i32, channel: i32) -> f32
pub fn set_playback_speed_scale(&mut self, scale: f32)
pub fn get_playback_speed_scale(&self) -> f32
pub fn lock(&mut self)
pub fn unlock(&mut self)
pub fn get_speaker_mode(&self) -> SpeakerMode
pub fn get_mix_rate(&self) -> f32
pub fn get_input_mix_rate(&self) -> f32
pub fn get_driver_name(&self) -> GString
pub fn get_output_device_list(&mut self) -> PackedArray<GString>
pub fn get_output_device(&mut self) -> GString
pub fn set_output_device(&mut self, name: impl AsArg<GString>)
pub fn get_time_to_next_mix(&self) -> f64
pub fn get_time_since_last_mix(&self) -> f64
pub fn get_output_latency(&self) -> f64
pub fn get_input_device_list(&mut self) -> PackedArray<GString>
pub fn get_input_device(&mut self) -> GString
pub fn set_input_device(&mut self, name: impl AsArg<GString>)
pub fn set_bus_layout( &mut self, bus_layout: impl AsArg<Option<Gd<AudioBusLayout>>>, )
pub fn generate_bus_layout(&self) -> Option<Gd<AudioBusLayout>>
pub fn set_enable_tagging_used_audio_streams(&mut self, enable: bool)
pub fn is_stream_registered_as_sample( &mut self, stream: impl AsArg<Option<Gd<AudioStream>>>, ) -> bool
pub fn register_stream_as_sample( &mut self, stream: impl AsArg<Option<Gd<AudioStream>>>, )
Methods from Deref<Target = Object>§
pub fn get_script(&self) -> Option<Gd<Script>>
pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)
pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error
pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error
pub fn get_class(&self) -> GString
pub fn is_class(&self, class: impl AsArg<GString>) -> bool
pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)
pub fn get(&self, property: impl AsArg<StringName>) -> Variant
pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )
pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant
pub fn get_property_list(&self) -> Array<Dictionary>
pub fn get_method_list(&self) -> Array<Dictionary>
pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool
pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant
pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)
pub fn remove_meta(&mut self, name: impl AsArg<StringName>)
pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant
pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant
To set the default parameters, use Self::get_meta_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>
pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool
pub fn get_meta_list(&self) -> Array<StringName>
pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)
pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)
To set the default parameters, use Self::add_user_signal_ex
and its builder methods. See the book for detailed usage instructions.
pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>
pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool
pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)
pub fn emit_signal(
&mut self,
signal: impl AsArg<StringName>,
varargs: &[Variant],
) -> Error
pub fn emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Error
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_emit_signal(
&mut self,
signal: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Error, CallError>
pub fn try_emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Error, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Variant
pub fn call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call_deferred(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Variant
pub fn call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call_deferred(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn set_deferred( &mut self, property: impl AsArg<StringName>, value: &Variant, )
pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant
pub fn has_method(&self, method: impl AsArg<StringName>) -> bool
pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32
pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool
pub fn get_signal_list(&self) -> Array<Dictionary>
pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>
pub fn get_incoming_connections(&self) -> Array<Dictionary>
pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )
pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool
pub fn has_connections(&self, signal: impl AsArg<StringName>) -> bool
pub fn set_block_signals(&mut self, enable: bool)
pub fn is_blocking_signals(&self) -> bool
pub fn notify_property_list_changed(&mut self)
pub fn set_message_translation(&mut self, enable: bool)
pub fn can_translate_messages(&self) -> bool
pub fn tr(&self, message: impl AsArg<StringName>) -> GString
pub fn tr(&self, message: impl AsArg<StringName>) -> GString
To set the default parameters, use Self::tr_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>
pub fn tr_n(
&self,
message: impl AsArg<StringName>,
plural_message: impl AsArg<StringName>,
n: i32,
) -> GString
pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString
To set the default parameters, use Self::tr_n_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>
pub fn get_translation_domain(&self) -> StringName
pub fn set_translation_domain(&mut self, domain: impl AsArg<StringName>)
pub fn is_queued_for_deletion(&self) -> bool
pub fn cancel_free(&mut self)
pub fn notify(&mut self, what: ObjectNotification)
pub fn notify(&mut self, what: ObjectNotification)
⚠️ Sends a Godot notification to all classes inherited by the object.
Triggers calls to on_notification()
, and depending on the notification, also to Godot’s lifecycle callbacks such as ready()
.
Starts from the highest ancestor (the Object
class) and goes down the hierarchy.
See also Godot docs for Object::notification()
.
§Panics
If you call this method on a user-defined object while holding a GdRef
or GdMut
guard on the instance, you will encounter
a panic. The reason is that the receiving virtual method on_notification()
acquires a GdMut
lock dynamically, which must
be exclusive.
pub fn notify_reversed(&mut self, what: ObjectNotification)
pub fn notify_reversed(&mut self, what: ObjectNotification)
⚠️ Like Self::notify()
, but starts at the most-derived class and goes up the hierarchy.
See docs of that method, including the panics.
Trait Implementations§
§impl Bounds for AudioServer
impl Bounds for AudioServer
§impl Debug for AudioServer
impl Debug for AudioServer
§impl Deref for AudioServer
impl Deref for AudioServer
§impl DerefMut for AudioServer
impl DerefMut for AudioServer
§fn deref_mut(&mut self) -> &mut <AudioServer as Deref>::Target
fn deref_mut(&mut self) -> &mut <AudioServer as Deref>::Target
§impl GodotClass for AudioServer
impl GodotClass for AudioServer
§const INIT_LEVEL: InitLevel = crate::init::InitLevel::Servers
const INIT_LEVEL: InitLevel = crate::init::InitLevel::Servers
§fn class_id() -> ClassId
fn class_id() -> ClassId
§fn class_name() -> ClassId
fn class_name() -> ClassId
class_id()
§fn inherits<Base>() -> boolwhere
Base: GodotClass,
fn inherits<Base>() -> boolwhere
Base: GodotClass,
§impl Inherits<Object> for AudioServer
impl Inherits<Object> for AudioServer
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl WithSignals for AudioServer
impl WithSignals for AudioServer
§type SignalCollection<'c, C: WithSignals> = SignalsOfAudioServer<'c, C>
type SignalCollection<'c, C: WithSignals> = SignalsOfAudioServer<'c, C>
Auto Trait Implementations§
impl Freeze for AudioServer
impl RefUnwindSafe for AudioServer
impl !Send for AudioServer
impl !Sync for AudioServer
impl Unpin for AudioServer
impl UnwindSafe for AudioServer
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Inherits<T> for Twhere
T: GodotClass,
impl<T> Inherits<T> for Twhere
T: GodotClass,
§const IS_SAME_CLASS: bool = true
const IS_SAME_CLASS: bool = true
Self == Base
. Read more