Version
menu_open
Wwise SDK 2022.1.18
Bus
  • Plugin ID: 21
  • Class ID: 1376272

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

Properties, References, Lists

NameDisplay NameTypeDefaultRestrictionIs VisibleSupported RTPC TypeSupports Link/Unlink
3DPosition3D Positionint160

Possible values :

Value Display Name
0Emitter
1Emitter with Automation
2Listener with Automation

trueNonefalse
3DSpatialization3D Spatializationint160

Possible values :

Value Display Name
0None
1Position
2Position + Orientation

trueNonefalse
AttachableMixerInputMixer Plug-in InputReference Nonefalse  
AttenuationAttenuationReference 

Possible types :

Attenuation

true  
AudioDeviceAudio DeviceReference 

Possible types :

AudioDevice


Must not be Null

true  
BusChannelConfigBus Configurationint320

Possible values :

Value Display Name
0Same as parent
3584Same as main mix
3840Same as passthrough mix
768Audio Objects
166411.0
125462.0
453152.1
289313.0
63040044.0
63531585.1
65497687.1
902392405.1.2
904358507.1.2
7615244927.1.4
516Ambisonics 1st order
521Ambisonics 2nd order
528Ambisonics 3rd order
537Ambisonics 4th order
548Ambisonics 5th order
761327882Auro 9.1
769716491Auro 10.1
803270924Auro 11.1
803467534Auro 13.1
33025LFE

trueNonetrue
BusVolumeBus VolumeReal640[ -200 , 200 ]trueAdditivetrue
BypassEffectBypass All EffectsboolfalseNonetrueBooleantrue
BypassEffect0Bypass Effect 0boolfalseNonetrueBooleantrue
BypassEffect1Bypass Effect 1boolfalseNonetrueBooleantrue
BypassEffect2Bypass Effect 2boolfalseNonetrueBooleantrue
BypassEffect3Bypass Effect 3boolfalseNonetrueBooleantrue
CenterPercentageCenter %int32100[ 0 , 100 ]trueExclusivetrue
ColorColorint160[ 0 , 26 ]trueNonefalse
Effect0Effect 0Reference 

Possible types :

Effect

true  
Effect1Effect 1Reference 

Possible types :

Effect

true  
Effect2Effect 2Reference 

Possible types :

Effect

true  
Effect3Effect 3Reference 

Possible types :

Effect

true  
EnableAttenuationEnable AttenuationbooltrueNonetrueBooleanfalse
EnableDiffractionEnable DiffractionboolfalseNonetrueNonefalse
GameAuxSendHPFGame-Defined Auxiliary Sends HPFint160[ 0 , 100 ]trueAdditivetrue
GameAuxSendLPFGame-Defined Auxiliary Sends LPFint160[ 0 , 100 ]trueAdditivetrue
GameAuxSendVolumeGame-Defined Auxiliary Sends VolumeReal640[ -200 , 200 ]trueAdditivetrue
HdrEnableEnable HDRboolfalseNonetrueNonetrue
HdrOutputGameParameterMaxHDR Output Game Parameter MaxReal64100[ -100 , 100 ]trueNonetrue
HdrOutputGameParameterMinHDR Output Game Parameter MinReal640[ -100 , 100 ]trueNonetrue
HdrPeakOutputGameParameterHDR Window Top Output Game ParameterReference 

Possible types :

GameParameter

true  
HdrRatioHDR RatioReal64100[ 1 , 100 ]trueExclusivetrue
HdrReleaseTimeHDR Release TimeReal640[ 0 , 20 ]trueExclusivetrue
HdrReleaseTimeModeHDR Release Time Modeint161

Possible values :

Value Display Name
0Linear
1Exponential

trueNonetrue
HdrThresholdHDR ThresholdReal640[ -96 , 96 ]trueExclusivetrue
HighpassVoice High-pass Filterint160[ 0 , 100 ]trueAdditivetrue
HoldEmitterPositionOrientationHold Emitter Position and OrientationboolfalseNonetrueNonefalse
HoldListenerOrientationHold Listener OrientationboolfalseNonetrueNonefalse
IgnoreParentMaxSoundInstanceIgnore Parent Playback LimitboolfalseNonetrueNonefalse
ListenerRelativeRoutingListener Relative RoutingboolfalseNonetrueNonefalse
LowpassVoice Low-pass Filterint160[ 0 , 100 ]trueAdditivetrue
MakeUpGainMake-Up GainReal640[ -200 , 200 ]trueAdditivetrue
MaxDuckVolumeMaximum Ducking VolumeReal64-96[ -200 , 0 ]trueNonefalse
MaxReachedBehaviorWhen priority is equalint160

Possible values :

Value Display Name
0Discard oldest instance
1Discard newest instance

trueNonefalse
MaxSoundPerInstanceSound Instance Limitint1650[ 1 , 1000 ]trueExclusivetrue
MetadataMetadataList 

Possible types :

Metadata

   
MixerMixer PluginReference 

Possible types :

Effect

true  
OutputBusHighpassOutput Bus High-pass Filterint160[ 0 , 100 ]trueAdditivetrue
OutputBusLowpassOutput Bus Low-pass Filterint160[ 0 , 100 ]trueAdditivetrue
OutputBusVolumeOutput Bus VolumeReal640[ -200 , 200 ]trueAdditivetrue
OverLimitBehaviorVirtual voice behaviorint160

Possible values :

Value Display Name
0Kill voice
1Use virtual voice settings

trueNonefalse
OverrideColorOverride ColorboolfalseNonetrueNonefalse
PitchVoice Pitchint320[ -2400 , 2400 ]trueAdditivetrue
RTPCRTPCList 

Possible types :

RTPC

   
RecoveryTimeRecovery TimeReal641[ 0 , 10 ]trueNonefalse
ReflectionsAuxSendEarly Reflections Auxiliary SendReference 

Possible types :

AuxBus

true  
ReflectionsVolumeEarly Reflections Send VolumeReal640[ -200 , 200 ]trueAdditivetrue
SpeakerPanningSpeaker Panningint160

Possible values :

Value Display Name
0Direct Assignment
1Balance-Fade
2Steering

trueNonefalse
SpeakerPanning3DSpatializationMixSpeaker Panning / 3D Spatialization Mixint32100[ 0 , 100 ]trueExclusivefalse
UseGameAuxSendsUse Game-Defined Auxiliary SendsboolfalseNonetrueNonefalse
UseMaxSoundPerInstanceLimit Sound InstancesboolfalseNonetrueNonetrue
UsedForBackgroundMusicMute For Background MusicboolfalseNonefalseNonefalse
UserAuxSend0User Auxiliary Send 0Reference 

Possible types :

AuxBus

true  
UserAuxSend1User Auxiliary Send 1Reference 

Possible types :

AuxBus

true  
UserAuxSend2User Auxiliary Send 2Reference 

Possible types :

AuxBus

true  
UserAuxSend3User Auxiliary Send 3Reference 

Possible types :

AuxBus

true  
UserAuxSendHPF0User-Defined Auxiliary HPF 0int160[ 0 , 100 ]trueAdditivetrue
UserAuxSendHPF1User-Defined Auxiliary HPF 1int160[ 0 , 100 ]trueAdditivetrue
UserAuxSendHPF2User-Defined Auxiliary HPF 2int160[ 0 , 100 ]trueAdditivetrue
UserAuxSendHPF3User-Defined Auxiliary HPF 3int160[ 0 , 100 ]trueAdditivetrue
UserAuxSendLPF0User-Defined Auxiliary LPF 0int160[ 0 , 100 ]trueAdditivetrue
UserAuxSendLPF1User-Defined Auxiliary LPF 1int160[ 0 , 100 ]trueAdditivetrue
UserAuxSendLPF2User-Defined Auxiliary LPF 2int160[ 0 , 100 ]trueAdditivetrue
UserAuxSendLPF3User-Defined Auxiliary LPF 3int160[ 0 , 100 ]trueAdditivetrue
UserAuxSendVolume0User-Defined Auxiliary Send Volume 0Real640[ -200 , 200 ]trueAdditivetrue
UserAuxSendVolume1User-Defined Auxiliary Send Volume 1Real640[ -200 , 200 ]trueAdditivetrue
UserAuxSendVolume2User-Defined Auxiliary Send Volume 2Real640[ -200 , 200 ]trueAdditivetrue
UserAuxSendVolume3User-Defined Auxiliary Send Volume 3Real640[ -200 , 200 ]trueAdditivetrue
VolumeVoice VolumeReal640[ -200 , 200 ]trueAdditivetrue

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