AudioServer

gdext.classes.AudioServer
See theAudioServer companion object
abstract class AudioServer extends Object

Generated wrapper for Godot's AudioServer, extends Object.

Attributes

Companion
object
Graph
Supertypes
class Object
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

final def addBus(at_position: Long): Unit

AudioServer.add_bus

AudioServer.add_bus

Attributes

final def addBusEffect(bus_idx: Long, effect: AudioEffect, at_position: Long): Unit

AudioServer.add_bus_effect

AudioServer.add_bus_effect

Attributes

AudioServer.generate_bus_layout. Returns an owned reference: release it with unref() or inside Gd.scoped.

AudioServer.generate_bus_layout. Returns an owned reference: release it with unref() or inside Gd.scoped.

Attributes

final def getBusChannels(bus_idx: Long): Long

AudioServer.get_bus_channels

AudioServer.get_bus_channels

Attributes

final def getBusCount(): Long

AudioServer.get_bus_count

AudioServer.get_bus_count

Attributes

final def getBusEffect(bus_idx: Long, effect_idx: Long): AudioEffect

AudioServer.get_bus_effect. Returns an owned reference: release it with unref() or inside Gd.scoped.

AudioServer.get_bus_effect. Returns an owned reference: release it with unref() or inside Gd.scoped.

Attributes

final def getBusEffectCount(bus_idx: Long): Long

AudioServer.get_bus_effect_count

AudioServer.get_bus_effect_count

Attributes

final def getBusEffectInstance(bus_idx: Long, effect_idx: Long, channel: Long): AudioEffectInstance

AudioServer.get_bus_effect_instance. Returns an owned reference: release it with unref() or inside Gd.scoped.

AudioServer.get_bus_effect_instance. Returns an owned reference: release it with unref() or inside Gd.scoped.

Attributes

final def getBusIndex(bus_name: StringName): Long

AudioServer.get_bus_index

AudioServer.get_bus_index

Attributes

final def getBusName(bus_idx: Long): String

AudioServer.get_bus_name

AudioServer.get_bus_name

Attributes

final def getBusPeakVolumeLeftDb(bus_idx: Long, channel: Long): Double

AudioServer.get_bus_peak_volume_left_db

AudioServer.get_bus_peak_volume_left_db

Attributes

final def getBusPeakVolumeRightDb(bus_idx: Long, channel: Long): Double

AudioServer.get_bus_peak_volume_right_db

AudioServer.get_bus_peak_volume_right_db

Attributes

final def getBusSend(bus_idx: Long): StringName

AudioServer.get_bus_send

AudioServer.get_bus_send

Attributes

final def getBusVolumeDb(bus_idx: Long): Double

AudioServer.get_bus_volume_db

AudioServer.get_bus_volume_db

Attributes

final def getBusVolumeLinear(bus_idx: Long): Double

AudioServer.get_bus_volume_linear

AudioServer.get_bus_volume_linear

Attributes

final def getDriverName(): String

AudioServer.get_driver_name

AudioServer.get_driver_name

Attributes

final def getInputBufferLengthFrames(): Long

AudioServer.get_input_buffer_length_frames

AudioServer.get_input_buffer_length_frames

Attributes

final def getInputDevice(): String

AudioServer.get_input_device

AudioServer.get_input_device

Attributes

final def getInputFramesAvailable(): Long

AudioServer.get_input_frames_available

AudioServer.get_input_frames_available

Attributes

final def getInputMixRate(): Double

AudioServer.get_input_mix_rate

AudioServer.get_input_mix_rate

Attributes

final def getMixRate(): Double

AudioServer.get_mix_rate

AudioServer.get_mix_rate

Attributes

final def getOutputDevice(): String

AudioServer.get_output_device

AudioServer.get_output_device

Attributes

final def getOutputLatency(): Double

AudioServer.get_output_latency

AudioServer.get_output_latency

Attributes

final def getPlaybackSpeedScale(): Double

AudioServer.get_playback_speed_scale

AudioServer.get_playback_speed_scale

Attributes

final def getSpeakerMode(): Long

AudioServer.get_speaker_mode

AudioServer.get_speaker_mode

Attributes

final def getTimeSinceLastMix(): Double

AudioServer.get_time_since_last_mix

AudioServer.get_time_since_last_mix

Attributes

final def getTimeToNextMix(): Double

AudioServer.get_time_to_next_mix

AudioServer.get_time_to_next_mix

Attributes

override def godotClassName: String

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

Attributes

Definition Classes
final def isBusBypassingEffects(bus_idx: Long): Boolean

AudioServer.is_bus_bypassing_effects

AudioServer.is_bus_bypassing_effects

Attributes

final def isBusEffectEnabled(bus_idx: Long, effect_idx: Long): Boolean

AudioServer.is_bus_effect_enabled

AudioServer.is_bus_effect_enabled

Attributes

final def isBusMute(bus_idx: Long): Boolean

AudioServer.is_bus_mute

AudioServer.is_bus_mute

Attributes

final def isBusSolo(bus_idx: Long): Boolean

AudioServer.is_bus_solo

AudioServer.is_bus_solo

Attributes

final def isStreamRegisteredAsSample(stream: AudioStream): Boolean

AudioServer.is_stream_registered_as_sample

AudioServer.is_stream_registered_as_sample

Attributes

final def lock(): Unit

AudioServer.lock

AudioServer.lock

Attributes

final def moveBus(index: Long, to_index: Long): Unit

AudioServer.move_bus

AudioServer.move_bus

Attributes

final def registerStreamAsSample(stream: AudioStream): Unit

AudioServer.register_stream_as_sample

AudioServer.register_stream_as_sample

Attributes

final def removeBus(index: Long): Unit

AudioServer.remove_bus

AudioServer.remove_bus

Attributes

final def removeBusEffect(bus_idx: Long, effect_idx: Long): Unit

AudioServer.remove_bus_effect

AudioServer.remove_bus_effect

Attributes

final def setBusBypassEffects(bus_idx: Long, enable: Boolean): Unit

AudioServer.set_bus_bypass_effects

AudioServer.set_bus_bypass_effects

Attributes

final def setBusCount(amount: Long): Unit

AudioServer.set_bus_count

AudioServer.set_bus_count

Attributes

final def setBusEffectEnabled(bus_idx: Long, effect_idx: Long, enabled: Boolean): Unit

AudioServer.set_bus_effect_enabled

AudioServer.set_bus_effect_enabled

Attributes

final def setBusLayout(bus_layout: AudioBusLayout): Unit

AudioServer.set_bus_layout

AudioServer.set_bus_layout

Attributes

final def setBusMute(bus_idx: Long, enable: Boolean): Unit

AudioServer.set_bus_mute

AudioServer.set_bus_mute

Attributes

final def setBusName(bus_idx: Long, name: String): Unit

AudioServer.set_bus_name

AudioServer.set_bus_name

Attributes

final def setBusSend(bus_idx: Long, send: StringName): Unit

AudioServer.set_bus_send

AudioServer.set_bus_send

Attributes

final def setBusSolo(bus_idx: Long, enable: Boolean): Unit

AudioServer.set_bus_solo

AudioServer.set_bus_solo

Attributes

final def setBusVolumeDb(bus_idx: Long, volume_db: Double): Unit

AudioServer.set_bus_volume_db

AudioServer.set_bus_volume_db

Attributes

final def setBusVolumeLinear(bus_idx: Long, volume_linear: Double): Unit

AudioServer.set_bus_volume_linear

AudioServer.set_bus_volume_linear

Attributes

final def setEnableTaggingUsedAudioStreams(enable: Boolean): Unit

AudioServer.set_enable_tagging_used_audio_streams

AudioServer.set_enable_tagging_used_audio_streams

Attributes

final def setInputDevice(name: String): Unit

AudioServer.set_input_device

AudioServer.set_input_device

Attributes

final def setInputDeviceActive(active: Boolean): Long

AudioServer.set_input_device_active

AudioServer.set_input_device_active

Attributes

final def setOutputDevice(name: String): Unit

AudioServer.set_output_device

AudioServer.set_output_device

Attributes

final def setPlaybackSpeedScale(scale: Double): Unit

AudioServer.set_playback_speed_scale

AudioServer.set_playback_speed_scale

Attributes

final def swapBusEffects(bus_idx: Long, effect_idx: Long, by_effect_idx: Long): Unit

AudioServer.swap_bus_effects

AudioServer.swap_bus_effects

Attributes

final def unlock(): Unit

AudioServer.unlock

AudioServer.unlock

Attributes

Inherited methods

def _can_handle(obj: GodotObject): Boolean

EditorInspectorPlugin: can this plugin handle obj's inspector?

EditorInspectorPlugin: can this plugin handle obj's inspector?

Attributes

Inherited from:
GodotScriptClass
def _enter_tree(): Unit

EditorPlugin/Node: entered the (editor) tree.

EditorPlugin/Node: entered the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _exit_tree(): Unit

EditorPlugin/Node: leaving the (editor) tree.

EditorPlugin/Node: leaving the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _input(event: InputEvent): Unit

Called for every unhandled-or-not input event (Node._input).

Called for every unhandled-or-not input event (Node._input).

Attributes

Inherited from:
GodotScriptClass
def _parse_property(obj: GodotObject, varType: Long, name: String, hintType: Long, hintString: String, usage: Long, wide: Boolean): Boolean

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

Attributes

Inherited from:
GodotScriptClass
def _physics_process(delta: Double): Unit

Called every physics frame; delta is the fixed physics step.

Called every physics frame; delta is the fixed physics step.

Attributes

Inherited from:
GodotScriptClass
def _process(delta: Double): Unit

Called every rendered frame; delta is seconds since the last frame.

Called every rendered frame; delta is seconds since the last frame.

Attributes

Inherited from:
GodotScriptClass
def _ready(): Unit

Called when the node enters the scene tree and is ready.

Called when the node enters the scene tree and is ready.

Attributes

Inherited from:
GodotScriptClass
def _shortcut_input(event: InputEvent): Unit

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_input(event: InputEvent): Unit

Called for input not consumed by the UI (Node._unhandled_input).

Called for input not consumed by the UI (Node._unhandled_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_key_input(event: InputEvent): Unit

Called for unhandled key input (Node._unhandled_key_input).

Called for unhandled key input (Node._unhandled_key_input).

Attributes

Inherited from:
GodotScriptClass
def _update_property(): Unit

EditorProperty: refresh the widget from the edited property's value.

EditorProperty: refresh the widget from the edited property's value.

Attributes

Inherited from:
GodotScriptClass
final def canTranslateMessages(): Boolean

Object.can_translate_messages

Object.can_translate_messages

Attributes

Inherited from:
Object
final def cancelFree(): Unit

Object.cancel_free

Object.cancel_free

Attributes

Inherited from:
Object
def cast[U <: GodotScriptClass](using meta: ClassMeta[U]): U

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Attributes

Inherited from:
GodotScriptClass
def free(): Unit

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Attributes

Inherited from:
GodotScriptClass
final def getInstanceId(): Long

Object.get_instance_id

Object.get_instance_id

Attributes

Inherited from:
Object
final def getMethodArgumentCount(method: StringName): Long

Object.get_method_argument_count

Object.get_method_argument_count

Attributes

Inherited from:
Object

Object.get_translation_domain

Object.get_translation_domain

Attributes

Inherited from:
Object
final def hasConnections(signal: StringName): Boolean

Object.has_connections

Object.has_connections

Attributes

Inherited from:
Object
final def hasMeta(name: StringName): Boolean

Object.has_meta

Object.has_meta

Attributes

Inherited from:
Object
final def hasMethod(method: StringName): Boolean

Object.has_method

Object.has_method

Attributes

Inherited from:
Object
final def hasSignal(signal: StringName): Boolean

Object.has_signal

Object.has_signal

Attributes

Inherited from:
Object
final def hasUserSignal(signal: StringName): Boolean

Object.has_user_signal

Object.has_user_signal

Attributes

Inherited from:
Object
final def hostObject: GodotObject

The engine-side object handle for this instance.

The engine-side object handle for this instance.

Attributes

Inherited from:
GodotScriptClass
final def instanceId: InstanceId

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

Attributes

Inherited from:
GodotScriptClass
final def isBlockingSignals(): Boolean

Object.is_blocking_signals

Object.is_blocking_signals

Attributes

Inherited from:
Object
final def isClass(`class`: String): Boolean

Object.is_class

Object.is_class

Attributes

Inherited from:
Object
final def isQueuedForDeletion(): Boolean

Object.is_queued_for_deletion

Object.is_queued_for_deletion

Attributes

Inherited from:
Object
final def isRefCounted: Boolean

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

Attributes

Inherited from:
GodotScriptClass
def keep(): this.type

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Attributes

Inherited from:
GodotScriptClass
final def notification(what: Long, reversed: Boolean): Unit

Object.notification

Object.notification

Attributes

Inherited from:
Object
final def notifyPropertyListChanged(): Unit

Object.notify_property_list_changed

Object.notify_property_list_changed

Attributes

Inherited from:
Object
final def propertyCanRevert(property: StringName): Boolean

Object.property_can_revert

Object.property_can_revert

Attributes

Inherited from:
Object
def refInc(): this.type

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Attributes

Inherited from:
GodotScriptClass
final def removeMeta(name: StringName): Unit

Object.remove_meta

Object.remove_meta

Attributes

Inherited from:
Object
final def removeUserSignal(signal: StringName): Unit

Object.remove_user_signal

Object.remove_user_signal

Attributes

Inherited from:
Object
final def setBlockSignals(enable: Boolean): Unit

Object.set_block_signals

Object.set_block_signals

Attributes

Inherited from:
Object
final def setMessageTranslation(enable: Boolean): Unit

Object.set_message_translation

Object.set_message_translation

Attributes

Inherited from:
Object
final def setTranslationDomain(domain: StringName): Unit

Object.set_translation_domain

Object.set_translation_domain

Attributes

Inherited from:
Object
final def tr(message: StringName, context: StringName): String

Object.tr

Object.tr

Attributes

Inherited from:
Object
final def trN(message: StringName, plural_message: StringName, n: Long, context: StringName): String

Object.tr_n

Object.tr_n

Attributes

Inherited from:
Object
def unref(): Unit

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Attributes

Inherited from:
GodotScriptClass
final def withHost(o: GDExtensionObjectPtr): this.type

Set the handle and return this (fluent, for wrapping fetched objects).

Set the handle and return this (fluent, for wrapping fetched objects).

Attributes

Inherited from:
GodotScriptClass