AudioServer

    Server interface for low-level audio access.

    is a low-level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface.

    Tutorials

    Methods

    • bus_layout_changed ( )

    Emitted when the changes.

    Enumerations

    enum SpeakerMode:

    • SPEAKER_MODE_STEREO = 0 —- Two or fewer speakers were detected.
    • SPEAKER_SURROUND_31 = 1 —- A 3.1 channel surround setup was detected.
    • SPEAKER_SURROUND_51 = 2 —- A 5.1 channel surround setup was detected.
    • SPEAKER_SURROUND_71 = 3 —- A 7.1 channel surround setup was detected.

    Number of available audio buses.

    • device

    Name of the current device for audio output (see get_device_list).

    Scales the rate at which audio is played (i.e. setting it to 0.5 will make the audio be played twice as fast).

    Method Descriptions

    • void add_bus ( at_position=-1 )

    Adds a bus at at_position.

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

    Adds an effect to the bus bus_idx at at_position.

    • String capture_get_device ( )

    Name of the current device for audio input (see ).

    • Array capture_get_device_list ( )

    Returns the names of all audio input devices detected on the system.

    • void capture_set_device ( name )

    Sets which audio input device is used for audio capture.

    Generates an using the available buses and effects.

    • int get_bus_channels ( bus_idx ) const

    Returns the amount of channels of the bus at index bus_idx.

    Returns the at position effect_idx in bus bus_idx.

    • int get_bus_effect_count ( bus_idx )

    Returns the AudioEffectInstance assigned to the given bus and effect indices (and optionally channel).

    • get_bus_index ( String bus_name ) const

    Returns the index of the bus with the name bus_name.

    • get_bus_name ( int bus_idx ) const

    Returns the name of the bus with the index bus_idx.

    • get_bus_peak_volume_left_db ( int bus_idx, channel ) const

    Returns the peak volume of the left speaker at bus index bus_idx and channel index .

    • float get_bus_peak_volume_right_db ( bus_idx, int channel ) const

    Returns the peak volume of the right speaker at bus index bus_idx and channel index channel.

    • get_bus_send ( int bus_idx ) const

    Returns the name of the bus that the bus at index bus_idx sends to.

    • get_bus_volume_db ( int bus_idx ) const

    Returns the volume of the bus at index bus_idx in dB.

    • get_device_list ( )

    Returns the names of all audio devices detected on the system.

    • float get_mix_rate ( ) const

    Returns the sample rate at the output of the AudioServer.

    • get_output_latency ( ) const

    Returns the audio driver’s output latency.

    Returns the speaker configuration.

    • float get_time_since_last_mix ( ) const

    Returns the relative time since the last mix occurred.

    • get_time_to_next_mix ( ) const

    Returns the relative time until the next mix occurs.

    • bool is_bus_bypassing_effects ( bus_idx ) const

    If true, the bus at index bus_idx is bypassing effects.

    • bool is_bus_effect_enabled ( bus_idx, int effect_idx ) const

    If true, the effect at index effect_idx on the bus at index bus_idx is enabled.

    • is_bus_mute ( int bus_idx ) const
    • is_bus_solo ( int bus_idx ) const

    If true, the bus at index bus_idx is in solo mode.

    • void lock ( )

    Locks the audio driver’s main loop.

    Note: Remember to unlock it afterwards.

    • void move_bus ( index, int to_index )

    Moves the bus from index index to index to_index.

    • void remove_bus ( index )

    Removes the bus at index index.

    • void remove_bus_effect ( int bus_idx, effect_idx )

    Removes the effect at index from the bus at index bus_idx.

    • void set_bus_bypass_effects ( int bus_idx, enable )

    If true, the bus at index bus_idx is bypassing effects.

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

    If true, the effect at index effect_idx on the bus at index bus_idx is enabled.

    • void set_bus_layout ( bus_layout )

    Overwrites the currently used AudioBusLayout.

    • void set_bus_mute ( bus_idx, bool enable )

    If true, the bus at index bus_idx is muted.

    • void set_bus_name ( bus_idx, String name )

    Sets the name of the bus at index bus_idx to name.

    • void set_bus_send ( bus_idx, String send )

    Connects the output of the bus at bus_idx to the bus named send.

    • void set_bus_solo ( bus_idx, bool enable )

    If true, the bus at index bus_idx is in solo mode.

    • void set_bus_volume_db ( bus_idx, float volume_db )

    Sets the volume of the bus at index bus_idx to volume_db.

    • void swap_bus_effects ( bus_idx, int effect_idx, by_effect_idx )

    Swaps the position of two effects in bus bus_idx.