Table of Contents

Bus

(Plugin ID : 21)
(Class ID : 1376272)

Refer to ak.wwise.core.object.setProperty and ak.wwise.core.object.setReference to set properties and references with WAAPI. Also refer to Querying the Wwise Project to learn how to query properties and references.

Properties

Name Display Name Type Default Restriction Read-only Supported RTPC Type Supports Link/Unlink
3DPosition 3D Position int16 0 Possible values :
Value Display Name
0 Emitter
1 Emitter with Automation
2 Listener with Automation





false None false
3DSpatialization 3D Spatialization int16 0 Possible values :
Value Display Name
0 None
1 Position
2 Position + Orientation





false None false
AttachableMixerInput Mixer Plug-in Input Reference   None true    
Attenuation Attenuation Reference   Possible types :
Attenuation



false    
AudioDevice Audio Device Reference   Possible types :
AudioDevice



Must not be Null
false    
BusChannelConfig Channel Configuration int32 0 Possible values :
Value Display Name
0 Parent
16641 1.0
12546 2.0
45315 2.1
28931 3.0
6304004 4.0
6353158 5.1
6549768 7.1
90239240 5.1.2
90435850 7.1.2
761524492 7.1.4
516 Ambisonics 1st order
521 Ambisonics 2nd order
528 Ambisonics 3rd order
761327882 Auro 9.1
769716491 Auro 10.1
803270924 Auro 11.1
803467534 Auro 13.1
33025 LFE





















false None true
BusVolume Bus Volume Real64 0 [ -200 , 200 ] false Additive true
BypassEffect Bypass All Effects bool false None false Boolean true
BypassEffect0 Bypass Effect 0 bool false None false Boolean true
BypassEffect1 Bypass Effect 1 bool false None false Boolean true
BypassEffect2 Bypass Effect 2 bool false None false Boolean true
BypassEffect3 Bypass Effect 3 bool false None false Boolean true
CenterPercentage Center % int32 100 [ 0 , 100 ] false Exclusive true
Color Color int16 0 [ 0 , 26 ] false None false
Effect0 Effect 0 Reference   Possible types :
Effect



false    
Effect1 Effect 1 Reference   Possible types :
Effect



false    
Effect2 Effect 2 Reference   Possible types :
Effect



false    
Effect3 Effect 3 Reference   Possible types :
Effect



false    
EnableAttenuation Enable Attenuation bool true None false Boolean false
GameAuxSendHPF Game-Defined Auxiliary Sends HPF int16 0 [ 0 , 100 ] false Additive true
GameAuxSendLPF Game-Defined Auxiliary Sends LPF int16 0 [ 0 , 100 ] false Additive true
GameAuxSendVolume Game-Defined Auxiliary Sends Volume Real64 0 [ -200 , 200 ] false Additive true
HdrEnable Enable HDR bool false None false None true
HdrOutputGameParameterMax HDR Output Game Parameter Max Real64 100 [ -100 , 100 ] false None true
HdrOutputGameParameterMin HDR Output Game Parameter Min Real64 0 [ -100 , 100 ] false None true
HdrPeakOutputGameParameter HDR Window Top Output Game Parameter Reference   Possible types :
GameParameter



false    
HdrRatio HDR Ratio Real64 100 [ 1 , 100 ] false Exclusive true
HdrReleaseTime HDR Release Time Real64 0 [ 0 , 20 ] false Exclusive true
HdrReleaseTimeMode HDR Release Time Mode int16 1 Possible values :
Value Display Name
0 Linear
1 Exponential




false None true
HdrThreshold HDR Threshold Real64 0 [ -96 , 96 ] false Exclusive true
Highpass Voice High-pass Filter int16 0 [ 0 , 100 ] false Additive true
HoldEmitterPositionOrientation Hold Emitter Position and Orientation bool false None false None false
HoldListenerOrientation Hold Listener Orientation bool false None false None false
IgnoreParentMaxSoundInstance Ignore Parent Playback Limit bool false None false None false
ListenerRelativeRouting Listener Relative Routing bool false None false None false
Lowpass Voice Low-pass Filter int16 0 [ 0 , 100 ] false Additive true
MakeUpGain Make-up Gain Real64 0 [ -200 , 200 ] false Additive true
MaxDuckVolume Maximum Ducking Volume Real64 -96 [ -200 , 0 ] false None false
MaxReachedBehavior When priority is equal int16 0 Possible values :
Value Display Name
0 Discard oldest instance
1 Discard newest instance




false None false
MaxSoundPerInstance Sound Instance Limit int16 50 [ 1 , 1000 ] false Exclusive true
Mixer Mixer Plugin Reference   Possible types :
Effect



false    
OutputBusHighpass Output Bus High-pass Filter int16 0 [ 0 , 100 ] false Additive true
OutputBusLowpass Output Bus Low-pass Filter int16 0 [ 0 , 100 ] false Additive true
OutputBusVolume Output Bus Volume Real64 0 [ -200 , 200 ] false Additive true
OverLimitBehavior Virtual voice behavior int16 0 Possible values :
Value Display Name
0 Kill voice
1 Use virtual voice settings




false None false
OverrideColor Override Color bool false None true None false
Pitch Voice Pitch int32 0 [ -2400 , 2400 ] false Additive true
RecoveryTime Recovery Time Real64 1 [ 0 , 10 ] false None false
SpeakerPanning Speaker Panning int16 0 Possible values :
Value Display Name
0 Direct Assignment
1 Balance-Fade




false None false
SpeakerPanning3DSpatializationMix Speaker Panning / 3D Spatialization Mix int32 100 [ 0 , 100 ] false Exclusive false
UseGameAuxSends Use Game-Defined Auxiliary Sends bool false None false None false
UseMaxSoundPerInstance Limit Sound Instances bool false None false None true
UsedForBackgroundMusic Mute For Background Music bool false None true None false
UserAuxSend0 User Auxiliary Send 0 Reference   Possible types :
AuxBus



false    
UserAuxSend1 User Auxiliary Send 1 Reference   Possible types :
AuxBus



false    
UserAuxSend2 User Auxiliary Send 2 Reference   Possible types :
AuxBus



false    
UserAuxSend3 User Auxiliary Send 3 Reference   Possible types :
AuxBus



false    
UserAuxSendHPF0 User-Defined Auxiliary HPF 0 int16 0 [ 0 , 100 ] false Additive true
UserAuxSendHPF1 User-Defined Auxiliary HPF 1 int16 0 [ 0 , 100 ] false Additive true
UserAuxSendHPF2 User-Defined Auxiliary HPF 2 int16 0 [ 0 , 100 ] false Additive true
UserAuxSendHPF3 User-Defined Auxiliary HPF 3 int16 0 [ 0 , 100 ] false Additive true
UserAuxSendLPF0 User-Defined Auxiliary LPF 0 int16 0 [ 0 , 100 ] false Additive true
UserAuxSendLPF1 User-Defined Auxiliary LPF 1 int16 0 [ 0 , 100 ] false Additive true
UserAuxSendLPF2 User-Defined Auxiliary LPF 2 int16 0 [ 0 , 100 ] false Additive true
UserAuxSendLPF3 User-Defined Auxiliary LPF 3 int16 0 [ 0 , 100 ] false Additive true
UserAuxSendVolume0 User-Defined Auxiliary Send Volume 0 Real64 0 [ -200 , 200 ] false Additive true
UserAuxSendVolume1 User-Defined Auxiliary Send Volume 1 Real64 0 [ -200 , 200 ] false Additive true
UserAuxSendVolume2 User-Defined Auxiliary Send Volume 2 Real64 0 [ -200 , 200 ] false Additive true
UserAuxSendVolume3 User-Defined Auxiliary Send Volume 3 Real64 0 [ -200 , 200 ] false Additive true
Volume Voice Volume Real64 0 [ -200 , 200 ] false Additive true