gdnative_audio

Struct AudioServer

Source 
pub struct AudioServer { /* private fields */ }
Expand description

core singleton class AudioServer inherits Object (unsafe).

§Official documentation

See the documentation of this class in the Godot engine’s official documentation.

§Feature flag

This type is behind the gdnative crate’s audio feature flag.

§Class hierarchy

AudioServer inherits methods from:

Implementations§

Source§

impl AudioServer

Source

pub fn godot_singleton() -> Self

Source

pub fn set_bus_count(&mut self, amount: i64)

Source

pub fn get_bus_count(&self) -> i64

Source

pub fn remove_bus(&mut self, index: i64)

Source

pub fn add_bus(&mut self, at_position: i64)

Source

pub fn move_bus(&mut self, index: i64, to_index: i64)

Source

pub fn set_bus_name(&mut self, bus_idx: i64, name: GodotString)

Source

pub fn get_bus_name(&self, bus_idx: i64) -> GodotString

Source

pub fn get_bus_index(&self, bus_name: GodotString) -> i64

Source

pub fn set_bus_volume_db(&mut self, bus_idx: i64, volume_db: f64)

Source

pub fn get_bus_volume_db(&self, bus_idx: i64) -> f64

Source

pub fn set_bus_send(&mut self, bus_idx: i64, send: GodotString)

Source

pub fn get_bus_send(&self, bus_idx: i64) -> GodotString

Source

pub fn set_bus_solo(&mut self, bus_idx: i64, enable: bool)

Source

pub fn is_bus_solo(&self, bus_idx: i64) -> bool

Source

pub fn set_bus_mute(&mut self, bus_idx: i64, enable: bool)

Source

pub fn is_bus_mute(&self, bus_idx: i64) -> bool

Source

pub fn set_bus_bypass_effects(&mut self, bus_idx: i64, enable: bool)

Source

pub fn is_bus_bypassing_effects(&self, bus_idx: i64) -> bool

Source

pub fn add_bus_effect( &mut self, bus_idx: i64, effect: Option<AudioEffect>, at_position: i64, )

Source

pub fn remove_bus_effect(&mut self, bus_idx: i64, effect_idx: i64)

Source

pub fn get_bus_effect_count(&mut self, bus_idx: i64) -> i64

Source

pub fn get_bus_effect( &mut self, bus_idx: i64, effect_idx: i64, ) -> Option<AudioEffect>

Source

pub fn swap_bus_effects( &mut self, bus_idx: i64, effect_idx: i64, by_effect_idx: i64, )

Source

pub fn set_bus_effect_enabled( &mut self, bus_idx: i64, effect_idx: i64, enabled: bool, )

Source

pub fn is_bus_effect_enabled(&self, bus_idx: i64, effect_idx: i64) -> bool

Source

pub fn get_bus_peak_volume_left_db(&self, bus_idx: i64, channel: i64) -> f64

Source

pub fn get_bus_peak_volume_right_db(&self, bus_idx: i64, channel: i64) -> f64

Source

pub fn lock(&mut self)

Source

pub fn unlock(&mut self)

Source

pub fn get_speaker_mode(&self) -> AudioServerSpeakerMode

Source

pub fn get_mix_rate(&self) -> f64

Source

pub fn get_device_list(&mut self) -> VariantArray

Source

pub fn get_device(&mut self) -> GodotString

Source

pub fn set_device(&mut self, arg0: GodotString)

Source

pub fn set_bus_layout(&mut self, bus_layout: Option<AudioBusLayout>)

Source

pub fn generate_bus_layout(&self) -> Option<AudioBusLayout>

Source

pub fn _notification(&mut self, what: i64)

Inherited from Object.

Source

pub fn _set(&mut self, property: GodotString, value: Variant) -> bool

Inherited from Object.

Source

pub fn _get(&mut self, property: GodotString) -> Variant

Inherited from Object.

Source

pub fn _get_property_list(&mut self) -> VariantArray

Inherited from Object.

Source

pub fn _init(&mut self)

Inherited from Object.

Source

pub fn get_class(&self) -> GodotString

Inherited from Object.

Source

pub fn is_class(&self, _type: GodotString) -> bool

Inherited from Object.

Source

pub fn set(&mut self, property: GodotString, value: Variant)

Inherited from Object.

Source

pub fn get(&self, property: GodotString) -> Variant

Inherited from Object.

Source

pub fn set_indexed(&mut self, property: NodePath, value: Variant)

Inherited from Object.

Source

pub fn get_indexed(&self, property: NodePath) -> Variant

Inherited from Object.

Source

pub fn get_property_list(&self) -> VariantArray

Inherited from Object.

Source

pub fn get_method_list(&self) -> VariantArray

Inherited from Object.

Source

pub fn notification(&mut self, what: i64, reversed: bool)

Inherited from Object.

Source

pub fn get_instance_id(&self) -> i64

Inherited from Object.

Source

pub fn set_script(&mut self, script: Option<Reference>)

Inherited from Object.

Source

pub fn get_script(&self) -> Option<Reference>

Inherited from Object.

Source

pub fn set_meta(&mut self, name: GodotString, value: Variant)

Inherited from Object.

Source

pub fn get_meta(&self, name: GodotString) -> Variant

Inherited from Object.

Source

pub fn has_meta(&self, name: GodotString) -> bool

Inherited from Object.

Source

pub fn get_meta_list(&self) -> StringArray

Inherited from Object.

Source

pub fn add_user_signal(&mut self, signal: GodotString, arguments: VariantArray)

Inherited from Object.

Source

pub fn has_user_signal(&self, signal: GodotString) -> bool

Inherited from Object.

Source

pub fn emit_signal( &mut self, signal: GodotString, varargs: &[Variant], ) -> Variant

Inherited from Object.

Source

pub fn call(&mut self, method: GodotString, varargs: &[Variant]) -> Variant

Inherited from Object.

Source

pub fn call_deferred( &mut self, method: GodotString, varargs: &[Variant], ) -> Variant

Inherited from Object.

Source

pub fn callv(&mut self, method: GodotString, arg_array: VariantArray) -> Variant

Inherited from Object.

Source

pub fn has_method(&self, method: GodotString) -> bool

Inherited from Object.

Source

pub fn get_signal_list(&self) -> VariantArray

Inherited from Object.

Source

pub fn get_signal_connection_list(&self, signal: GodotString) -> VariantArray

Inherited from Object.

Source

pub fn get_incoming_connections(&self) -> VariantArray

Inherited from Object.

Source

pub fn connect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, binds: VariantArray, flags: i64, ) -> GodotResult

Inherited from Object.

Source

pub fn disconnect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, )

Inherited from Object.

Source

pub fn is_connected( &self, signal: GodotString, target: Option<Object>, method: GodotString, ) -> bool

Inherited from Object.

Source

pub fn set_block_signals(&mut self, enable: bool)

Inherited from Object.

Source

pub fn is_blocking_signals(&self) -> bool

Inherited from Object.

Source

pub fn property_list_changed_notify(&mut self)

Inherited from Object.

Source

pub fn set_message_translation(&mut self, enable: bool)

Inherited from Object.

Source

pub fn can_translate_messages(&self) -> bool

Inherited from Object.

Source

pub fn tr(&self, message: GodotString) -> GodotString

Inherited from Object.

Source

pub fn is_queued_for_deletion(&self) -> bool

Inherited from Object.

Source

pub fn to_object(&self) -> Object

Up-cast.

Source

pub fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations§

Source§

impl Clone for AudioServer

Source§

fn clone(&self) -> AudioServer

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for AudioServer

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl GodotObject for AudioServer

Source§

fn class_name() -> &'static str

Source§

impl ToVariant for AudioServer

Source§

fn to_variant(&self) -> Variant

Source§

fn from_variant(variant: &Variant) -> Option<Self>

Source§

impl Copy for AudioServer

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.