Bus

View source
soloud.Bus (extern class)

Base class for busses

Static Members

create(): Bus
Returns
Bus

Instance Members

destroy(): Void
setFilter(aFilterId: cpp.UInt32, aFilter: Filter): Void

Set filter. Set to NULL to clear the filter.

Name Type
aFilterId cpp.UInt32
aFilter Filter
play(aSound: AudioSource, ?aVolume: cpp.Float32 = -1.0, ?aPan: cpp.Float32 = 0.0, ?aPaused: Bool = false): Handle

Play sound through the bus

Name Type Default
aSound AudioSource
aVolume cpp.Float32 -1.0
aPan cpp.Float32 0.0
aPaused Bool false
Returns
Handle
playClocked(aSoundTime: Time, aSound: AudioSource, ?aVolume: cpp.Float32 = -1.0, ?aPan: cpp.Float32 = 0.0): Handle

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

Name Type Default
aSoundTime Time
aSound AudioSource
aVolume cpp.Float32 -1.0
aPan cpp.Float32 0.0
Returns
Handle
play3d(aSound: AudioSource, aPosX: cpp.Float32, aPosY: cpp.Float32, aPosZ: cpp.Float32, ?aVelX: cpp.Float32 = 0.0, ?aVelY: cpp.Float32 = 0.0, ?aVelZ: cpp.Float32 = 0.0, ?aVolume: cpp.Float32 = 1.0, ?aPaused: Bool = false): Handle

Start playing a 3d audio source through the bus

Name Type Default
aSound AudioSource
aPosX cpp.Float32
aPosY cpp.Float32
aPosZ cpp.Float32
aVelX cpp.Float32 0.0
aVelY cpp.Float32 0.0
aVelZ cpp.Float32 0.0
aVolume cpp.Float32 1.0
aPaused Bool false
Returns
Handle
play3dClocked(aSoundTime: Time, aSound: AudioSource, aPosX: cpp.Float32, aPosY: cpp.Float32, aPosZ: cpp.Float32, ?aVelX: cpp.Float32 = 0.0, ?aVelY: cpp.Float32 = 0.0, ?aVelZ: cpp.Float32 = 0.0, ?aVolume: cpp.Float32 = 1.0): Handle

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

Name Type Default
aSoundTime Time
aSound AudioSource
aPosX cpp.Float32
aPosY cpp.Float32
aPosZ cpp.Float32
aVelX cpp.Float32 0.0
aVelY cpp.Float32 0.0
aVelZ cpp.Float32 0.0
aVolume cpp.Float32 1.0
Returns
Handle
setChannels(aChannels: cpp.UInt32): Result

Set number of channels for the bus (default 2)

Name Type
aChannels cpp.UInt32
Returns
Result
setVisualizationEnable(aEnable: Bool): Void

Enable or disable visualization data gathering

Name Type
aEnable Bool
annexSound(aVoiceHandle: Handle): Void

Move a live sound to this bus

Name Type
aVoiceHandle Handle

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

Returns
cpp.Pointer<cpp.Float32>

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

Returns
cpp.Pointer<cpp.Float32>
getApproximateVolume(aChannel: cpp.UInt32): cpp.Float32

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

Name Type
aChannel cpp.UInt32
Returns
cpp.Float32
getActiveVoiceCount(): cpp.UInt32

Get number of immediate child voices to this bus

Returns
cpp.UInt32
getResampler(): cpp.UInt32

Get current the resampler for this bus

Returns
cpp.UInt32
setResampler(aResampler: cpp.UInt32): Void

Set the resampler for this bus

Name Type
aResampler cpp.UInt32
stop(): Void

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

Metadata

Name Parameters
:include "linc_soloud.h"