class Bus

package soloud

@:native("SoLoud::Bus*")@:include("linc_soloud.h")

Available on clay native

Base class for busses

Static methods

@:has_untypedstaticinlinecreate():Bus

Methods

@:has_untypedinlinedestroy():Void

setFilter(aFilterId:UInt32, aFilter:Filter):Void

Set filter. Set to NULL to clear the filter.

@:value({ aPaused : false, aPan : 0.0, aVolume : -1.0 })inlineplay(aSound:AudioSource, aVolume:Float32 = -1.0, aPan:Float32 = 0.0, aPaused:Bool = false):Handle

Play sound through the bus

@:value({ aPan : 0.0, aVolume : -1.0 })inlineplayClocked(aSoundTime:Time, aSound:AudioSource, aVolume:Float32 = -1.0, aPan:Float32 = 0.0):Handle

Play sound through the bus, delayed in relation to other sounds called via this function.

@:value({ aPaused : false, aVolume : 1.0, aVelZ : 0.0, aVelY : 0.0, aVelX : 0.0 })inlineplay3d(aSound:AudioSource, aPosX:Float32, aPosY:Float32, aPosZ:Float32, aVelX:Float32 = 0.0, aVelY:Float32 = 0.0, aVelZ:Float32 = 0.0, aVolume:Float32 = 1.0, aPaused:Bool = false):Handle

Start playing a 3d audio source through the bus

@:value({ aVolume : 1.0, aVelZ : 0.0, aVelY : 0.0, aVelX : 0.0 })inlineplay3dClocked(aSoundTime:Time, aSound:AudioSource, aPosX:Float32, aPosY:Float32, aPosZ:Float32, aVelX:Float32 = 0.0, aVelY:Float32 = 0.0, aVelZ:Float32 = 0.0, aVolume:Float32 = 1.0):Handle

Start playing a 3d audio source through the bus, delayed in relation to other sounds called via this function.

setChannels(aChannels:UInt32):Result

Set number of channels for the bus (default 2)

setVisualizationEnable(aEnable:Bool):Void

Enable or disable visualization data gathering

annexSound(aVoiceHandle:Handle):Void

Move a live sound to this bus

calcFFT():Pointer<Float32>

Calculate and get 256 floats of FFT data for visualization. Visualization has to be enabled before use.

getWave():Pointer<Float32>

Get 256 floats of wave data for visualization. Visualization has to be enabled before use.

getApproximateVolume(aChannel:UInt32):Float32

Get approximate volume for output channel for visualization. Visualization has to be enabled before use.

getActiveVoiceCount():UInt32

Get number of immediate child voices to this bus

getResampler():UInt32

Get current the resampler for this bus

setResampler(aResampler:UInt32):Void

Set the resampler for this bus

stop():Void

This is equivalent of calling soloud.stopAudioSource() with the sound source