Version

menu_open
Wwise SDK 2023.1.5
Action
  • Plugin ID: 5
  • Class ID: 327696

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
AbsoluteOrRelativeAbsolute/Relativeint160

Possible values :

Value Display Name
0Absolute
1Relative

trueNonefalse
ActionTypeTypeint161

Possible values :

Value Display Name
1/Play
2/Stop/Stop
3/Stop/Stop All
7/Pause/Pause
8/Pause/Pause All
9/Pause/Resume
10/Pause/Resume All
34/Break
36/Seek/Seek
37/Seek/Seek All
41/Post Event
11---/Bus Volume/Set Bus Volume
14/Bus Volume/Reset Bus Volume
15/Bus Volume/Reset Bus Volume All
12/Voice Volume/Set Voice Volume
16/Voice Volume/Reset Voice Volume
17/Voice Volume/Reset Voice Volume All
13/Voice Pitch/Set Voice Pitch
18/Voice Pitch/Reset Pitch
19/Voice Pitch/Reset Pitch All
26/Voice Low-pass Filter/Set LPF
27/Voice Low-pass Filter/Reset LPF
28/Voice Low-pass Filter/Reset LPF All
29/Voice High-pass Filter/Set HPF
30/Voice High-pass Filter/Reset HPF
31/Voice High-pass Filter/Reset HPF All
4/Mute/Mute
5/Mute/UnMute
6/Mute/UnMute All
38---/Game Parameter/Set Game Parameter
39/Game Parameter/Reset Game Parameter
20/States/Enable State
21/States/Disable State
22/States/Set State
23/Set Switch
35/Trigger
40/Release Envelope
42/Reset Playlist
50---/Bypass Effect/Set - Bypass Effect Slot
51/Bypass Effect/Reset - Bypass Effect Slot
52/Bypass Effect/Reset - Bypass Effect Slot - All
53/Bypass Effect/---Set - Bypass All Effects
54/Bypass Effect/Reset - Bypass All Effects
55/Bypass Effect/Reset - Bypass All Effects - All
56/Bypass Effect/---Reset - All Effect Bypasses
57/Bypass Effect/Reset - All Effect Bypasses - All
43---/Set Effect/Set Effect
44/Set Effect/Reset Set Effect
45/Set Effect/Reset Set Effect All

trueNonefalse
ApplyToDynamicSequenceApply to Dynamic SequencesbooltrueNonetrueNonefalse
ApplyToStateTransitionApply to State TransitionsbooltrueNonetrueNonefalse
BypassFlagBypassbooltrueNonetrueNonefalse
BypassGameParameterInternalTransitionBypass Game Parameter InterpolationboolfalseNonetrueNonefalse
DelayDelayReal640[ 0 , 600 ]trueNonefalse
EffectSlotEffect Slotint160[ 0 , 254 ]trueNonefalse
FadeInCurveFade-in Curveint164

Possible values :

Value Display Name
0Logarithmic (Base 3)
1Sine
2Logarithmic (Base 1.41)
3Inverted S-Curve
4Linear
5S-Curve
6Exponential (Base 1.41)
7Reciprocal Sine
8Exponential (Base 3)

trueNonefalse
FadeOutCurveFade-out Curveint164

Possible values :

Value Display Name
0Logarithmic (Base 3)
1Sine
2Logarithmic (Base 1.41)
3Inverted S-Curve
4Linear
5S-Curve
6Exponential (Base 1.41)
7Reciprocal Sine
8Exponential (Base 3)

trueNonefalse
FadeTimeFade TimeReal640[ 0 , 60 ]trueNonefalse
GameParameterValueGame Parameter ValueReal640NonetrueNonefalse
HighpassVoice High-pass Filterint160[ -100 , 100 ]trueNonefalse
InclusionInclusionbooltrueNonetrueNonetrue
LowpassVoice Low-pass Filterint160[ -100 , 100 ]trueNonefalse
MasterResumeMaster ResumeboolfalseNonetrueNonefalse
PauseDelayedResumeActionInclude Delayed Resume ActionsbooltrueNonetrueNonefalse
PitchVoice Pitchint320[ -4800 , 4800 ]trueNonefalse
ProbabilityProbabilityReal64100[ 0 , 100 ]trueNonefalse
ResumeStateTransitionResume State TransitionsbooltrueNonetrueNonefalse
ScopeScopeint160

Possible values :

Value Display Name
0Game Object
1Global

trueNonefalse
SeekPercentSeek PercentReal640[ 0 , 100 ]trueNonefalse
SeekTimeSeek TimeReal640[ 0 , 3600 ]trueNonefalse
SeekToMarkerSeek to Nearest MarkerboolfalseNonetrueNonefalse
SeekTypeSeek Typeint160

Possible values :

Value Display Name
0Percent
1Time

trueNonefalse
TargetTargetReference Nonetrue  
TargetEffectTarget EffectReference 

Possible types :

Effect

true  
VolumeVolumeReal640[ -200 , 200 ]trueNonefalse

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