Version
Wwise SDK 2023.1.6
|
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.
Name | Display Name | Type | Default | Restriction | Is Visible | Supported RTPC Type | Supports Link/Unlink | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
3DPosition | 3D Position | int16 | 0 | Possible values :
| true | None | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
3DSpatialization | 3D Spatialization | int16 | 0 | Possible values :
| true | None | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
Attenuation | Attenuation | Reference | Possible types :
| true | |||||||||||||||||||||||||||||||||||||||||||||||||||||
AudioDevice | Audio Device | Reference | Possible types :
Must not be Null | true | |||||||||||||||||||||||||||||||||||||||||||||||||||||
BusChannelConfig | Bus Configuration | int32 | 0 | Possible values :
| true | None | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
BusVolume | Bus Volume | Real64 | 0 | [ -200 , 200 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
BypassEffect | Bypass All Effects | bool | false | None | true | Boolean | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
CenterPercentage | Center % | int32 | 100 | [ 0 , 100 ] | true | Exclusive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
Color | Color | int16 | 0 | [ 0 , 26 ] | true | None | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
Effects | Effects | List | Possible types :
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
EnableAttenuation | Enable Attenuation | bool | true | None | true | Boolean | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
EnableDiffraction | Enable Diffraction | bool | false | None | true | None | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
GameAuxSendHPF | Game-Defined Auxiliary Sends HPF | int16 | 0 | [ 0 , 100 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
GameAuxSendLPF | Game-Defined Auxiliary Sends LPF | int16 | 0 | [ 0 , 100 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
GameAuxSendVolume | Game-Defined Auxiliary Sends Volume | Real64 | 0 | [ -200 , 200 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
HdrEnable | Enable HDR | bool | false | None | true | None | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
HdrOutputGameParameterMax | HDR Output Game Parameter Max | Real64 | 100 | [ -100 , 100 ] | true | None | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
HdrOutputGameParameterMin | HDR Output Game Parameter Min | Real64 | 0 | [ -100 , 100 ] | true | None | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
HdrPeakOutputGameParameter | HDR Window Top Output Game Parameter | Reference | Possible types :
| true | |||||||||||||||||||||||||||||||||||||||||||||||||||||
HdrRatio | HDR Ratio | Real64 | 100 | [ 1 , 100 ] | true | Exclusive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
HdrReleaseTime | HDR Release Time | Real64 | 0 | [ 0 , 20 ] | true | Exclusive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
HdrReleaseTimeMode | HDR Release Time Mode | int16 | 1 | Possible values :
| true | None | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
HdrThreshold | HDR Threshold | Real64 | 0 | [ -96 , 96 ] | true | Exclusive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
Highpass | Voice High-pass Filter | int16 | 0 | [ 0 , 100 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
HoldEmitterPositionOrientation | Hold Emitter Position and Orientation | bool | false | None | true | None | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
HoldListenerOrientation | Hold Listener Orientation | bool | false | None | true | None | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
IgnoreParentMaxSoundInstance | Ignore Parent Playback Limit | bool | false | None | true | None | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
ListenerRelativeRouting | Listener Relative Routing | bool | false | None | true | None | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
Lowpass | Voice Low-pass Filter | int16 | 0 | [ 0 , 100 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
MakeUpGain | Make-Up Gain | Real64 | 0 | [ -200 , 200 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
MaxDuckVolume | Maximum Ducking Volume | Real64 | -96 | [ -200 , 0 ] | true | None | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
MaxReachedBehavior | When priority is equal | int16 | 0 | Possible values :
| true | None | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
MaxSoundPerInstance | Sound Instance Limit | int16 | 50 | [ 1 , 1000 ] | true | Exclusive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
Metadata | Metadata | List | Possible types :
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
OutputBusHighpass | Output Bus High-pass Filter | int16 | 0 | [ 0 , 100 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
OutputBusLowpass | Output Bus Low-pass Filter | int16 | 0 | [ 0 , 100 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
OutputBusVolume | Output Bus Volume | Real64 | 0 | [ -200 , 200 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
OverLimitBehavior | Virtual voice behavior | int16 | 0 | Possible values :
| true | None | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
OverrideColor | Override Color | bool | false | None | true | None | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
Pitch | Voice Pitch | int32 | 0 | [ -2400 , 2400 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
RTPC | RTPC | List | Possible types :
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
RecoveryTime | Recovery Time | Real64 | 1 | [ 0 , 10 ] | true | None | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
ReflectionsAuxSend | Early Reflections Auxiliary Send | Reference | Possible types :
| true | |||||||||||||||||||||||||||||||||||||||||||||||||||||
ReflectionsVolume | Early Reflections Send Volume | Real64 | 0 | [ -200 , 200 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
SpeakerPanning | Speaker Panning | int16 | 0 | Possible values :
| true | None | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
SpeakerPanning3DSpatializationMix | Speaker Panning / 3D Spatialization Mix | int32 | 100 | [ 0 , 100 ] | true | Exclusive | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
UseGameAuxSends | Use Game-Defined Auxiliary Sends | bool | false | None | true | None | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
UseMaxSoundPerInstance | Limit Sound Instances | bool | false | None | true | None | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
UsedForBackgroundMusic | Mute For Background Music | bool | false | None | false | None | false | ||||||||||||||||||||||||||||||||||||||||||||||||||
UserAuxSend0 | User Auxiliary Send 0 | Reference | Possible types :
| true | |||||||||||||||||||||||||||||||||||||||||||||||||||||
UserAuxSend1 | User Auxiliary Send 1 | Reference | Possible types :
| true | |||||||||||||||||||||||||||||||||||||||||||||||||||||
UserAuxSend2 | User Auxiliary Send 2 | Reference | Possible types :
| true | |||||||||||||||||||||||||||||||||||||||||||||||||||||
UserAuxSend3 | User Auxiliary Send 3 | Reference | Possible types :
| true | |||||||||||||||||||||||||||||||||||||||||||||||||||||
UserAuxSendHPF0 | User-Defined Auxiliary HPF 0 | int16 | 0 | [ 0 , 100 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
UserAuxSendHPF1 | User-Defined Auxiliary HPF 1 | int16 | 0 | [ 0 , 100 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
UserAuxSendHPF2 | User-Defined Auxiliary HPF 2 | int16 | 0 | [ 0 , 100 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
UserAuxSendHPF3 | User-Defined Auxiliary HPF 3 | int16 | 0 | [ 0 , 100 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
UserAuxSendLPF0 | User-Defined Auxiliary LPF 0 | int16 | 0 | [ 0 , 100 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
UserAuxSendLPF1 | User-Defined Auxiliary LPF 1 | int16 | 0 | [ 0 , 100 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
UserAuxSendLPF2 | User-Defined Auxiliary LPF 2 | int16 | 0 | [ 0 , 100 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
UserAuxSendLPF3 | User-Defined Auxiliary LPF 3 | int16 | 0 | [ 0 , 100 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
UserAuxSendVolume0 | User-Defined Auxiliary Send Volume 0 | Real64 | 0 | [ -200 , 200 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
UserAuxSendVolume1 | User-Defined Auxiliary Send Volume 1 | Real64 | 0 | [ -200 , 200 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
UserAuxSendVolume2 | User-Defined Auxiliary Send Volume 2 | Real64 | 0 | [ -200 , 200 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
UserAuxSendVolume3 | User-Defined Auxiliary Send Volume 3 | Real64 | 0 | [ -200 , 200 ] | true | Additive | true | ||||||||||||||||||||||||||||||||||||||||||||||||||
Volume | Voice Volume | Real64 | 0 | [ -200 , 200 ] | true | Additive | true |
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise