Version
menu_open

Bus

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

Properties

Name Display Name Type Default Restriction Supported RTPC Type Supports Link/Unlink
3DPositionSource 3D Position Source int16 1 Possible values :
Value Display Name
0 User-defined
1 Game-defined




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



   
AudioDevice Audio Device Reference   Possible types :
AudioDevice



Must not be Null
    
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 1-1
521 Ambisonics 2-2
528 Ambisonics 3-3
761327882 Auro 9.1
769716491 Auro 10.1
803270924 Auro 11.1
803467534 Auro 13.1
33025 LFE





















None true
BusVolume Bus Volume Real64 0 [ -200 , 200 ] Additive true
BypassEffect Bypass All Effects bool false Possible values :
Value Display Name
0 No
1 Yes




Boolean true
BypassEffect0 Bypass Effect 0 bool false None Boolean true
BypassEffect1 Bypass Effect 1 bool false None Boolean true
BypassEffect2 Bypass Effect 2 bool false None Boolean true
BypassEffect3 Bypass Effect 3 bool false None Boolean true
DivergenceCenter Center % int32 100 [ 0 , 100 ] Exclusive true
DynamicPositioning Update at each frame bool true None None false
Effect0 Effect 0 Reference   Possible types :
Effect



   
Effect1 Effect 1 Reference   Possible types :
Effect



   
Effect2 Effect 2 Reference   Possible types :
Effect



   
Effect3 Effect 3 Reference   Possible types :
Effect



   
EnablePanner Enable Panner bool false None None false
EnablePositioning Enable Positioning bool 0 None None false
FollowListenerOrientation Follow Listener Orientation bool true None None false
GameAuxSendHPF Game-Defined Auxiliary Sends HPF int16 0 [ 0 , 100 ] Additive true
GameAuxSendLPF Game-Defined Auxiliary Sends LPF int16 0 [ 0 , 100 ] Additive true
GameAuxSendVolume Game-Defined Auxiliary Sends Volume Real64 0 [ -200 , 200 ] Additive true
HdrEnable Enable HDR bool false None None true
HdrOutputGameParameterMax HDR Output Game Parameter Max Real64 100 [ -100 , 100 ] None true
HdrOutputGameParameterMin HDR Output Game Parameter Min Real64 0 [ -100 , 100 ] None true
HdrPeakOutputGameParameter HDR Window Top Output Game Parameter Reference   Possible types :
GameParameter



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




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




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



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




None false
Pitch Voice Pitch int32 0 [ -2400 , 2400 ] Additive true
PositioningType Positioning Type int16 0 Possible values :
Value Display Name
0 2D
1 3D




Exclusive false
RecoveryTime Recovery Time Real64 1 [ 0 , 10 ] None false
Spatialization Spatialization Mode int16 2 Possible values :
Value Display Name
0 None
1 Position
2 Position + Orientation





None false
UseGameAuxSends Use Game-Defined Auxiliary Sends bool false None None false
UseMaxSoundPerInstance Limit Sound Instances bool false None None true
UsedForBackgroundMusic Mute For Background Music bool false None None false
UserAuxSend0 User Auxiliary Send 0 Reference   Possible types :
AuxBus



   
UserAuxSend1 User Auxiliary Send 1 Reference   Possible types :
AuxBus



   
UserAuxSend2 User Auxiliary Send 2 Reference   Possible types :
AuxBus



   
UserAuxSend3 User Auxiliary Send 3 Reference   Possible types :
AuxBus



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




Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise