Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.9.8628 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2023.1.9
Mastering Suite
  • Plugin ID: 186
  • Class ID: 12189699

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
compressorBand1AttackCompressor Attack (Band 1)Real320.01[ 0.01 , 0.5 ]trueNonefalse
compressorBand1EnabledCompressor Band 1 EnabledbooltrueNonetrueNonefalse
compressorBand1KneeCompressor Knee (Band 1)Real320[ 0 , 20 ]trueNonefalse
compressorBand1MakeupGainCompressor Makeup Gain (Band 1)Real320[ -18 , 18 ]trueNonefalse
compressorBand1RatioCompressor Ratio (Band 1)Real321[ 1 , 30 ]trueNonefalse
compressorBand1ReleaseCompressor Release (Band 1)Real320.1[ 0.01 , 5 ]trueNonefalse
compressorBand1ThresholdCompressor Threshold (Band 1)Real320[ -60 , 0 ]trueNonefalse
compressorBand2AttackCompressor Attack (Band 2)Real320.01[ 0.01 , 0.5 ]trueNonefalse
compressorBand2EnabledCompressor Band 2 EnabledbooltrueNonetrueNonefalse
compressorBand2KneeCompressor Knee (Band 2)Real320[ 0 , 20 ]trueNonefalse
compressorBand2MakeupGainCompressor Makeup Gain (Band 2)Real320[ -18 , 18 ]trueNonefalse
compressorBand2RatioCompressor Ratio (Band 2)Real321[ 1 , 30 ]trueNonefalse
compressorBand2ReleaseCompressor Release (Band 2)Real320.1[ 0.01 , 5 ]trueNonefalse
compressorBand2ThresholdCompressor Threshold (Band 2)Real320[ -60 , 0 ]trueNonefalse
compressorBand3AttackCompressor Attack (Band 3)Real320.01[ 0.01 , 0.5 ]trueNonefalse
compressorBand3EnabledCompressor Band 3 EnabledbooltrueNonetrueNonefalse
compressorBand3KneeCompressor Knee (Band 3)Real320[ 0 , 20 ]trueNonefalse
compressorBand3MakeupGainCompressor Makeup Gain (Band 3)Real320[ -18 , 18 ]trueNonefalse
compressorBand3RatioCompressor Ratio (Band 3)Real321[ 1 , 30 ]trueNonefalse
compressorBand3ReleaseCompressor Release (Band 3)Real320.1[ 0.01 , 5 ]trueNonefalse
compressorBand3ThresholdCompressor Threshold (Band 3)Real320[ -60 , 0 ]trueNonefalse
compressorBand4AttackCompressor Attack (Band 4)Real320.01[ 0.01 , 0.5 ]trueNonefalse
compressorBand4EnabledCompressor Band 4 EnabledbooltrueNonetrueNonefalse
compressorBand4KneeCompressor Knee (Band 4)Real320[ 0 , 20 ]trueNonefalse
compressorBand4MakeupGainCompressor Makeup Gain (Band 4)Real320[ -18 , 18 ]trueNonefalse
compressorBand4RatioCompressor Ratio (Band 4)Real321[ 1 , 30 ]trueNonefalse
compressorBand4ReleaseCompressor Release (Band 4)Real320.1[ 0.01 , 5 ]trueNonefalse
compressorBand4ThresholdCompressor Threshold (Band 4)Real320[ -60 , 0 ]trueNonefalse
compressorCrossoverFrequency1Compressor Crossover Frequency 1Real32150[ 10 , 24000 ]trueNonefalse
compressorCrossoverFrequency2Compressor Crossover Frequency 2Real321000[ 10 , 24000 ]trueNonefalse
compressorCrossoverFrequency3Compressor Crossover Frequency 3Real326000[ 10 , 24000 ]trueNonefalse
compressorLinkModeCompressor Link Modeint321

Possible values :

Value Display Name
0No link
1All channels
2Partial link

trueNonefalse
compressorLinkStereoPairsCompressor Stereo LinkboolfalseNonetrueNonefalse
compressorLinkStrengthCompressor Link StrengthReal320[ 0 , 100 ]trueNonefalse
compressorNumBandsCompressor Band Countint324[ 1 , 4 ]trueNonefalse
limiterAttackLimiter AttackReal320[ 0 , 2.6 ]trueNonefalse
limiterLinkChannelsLimiter Channel LinkbooltrueNonetrueNonefalse
limiterModeLimiter Modeint320

Possible values :

Value Display Name
0Soft
1Hard
2Advanced

trueNonefalse
limiterOutputGainLimiter Output GainReal320[ 0 , 30 ]trueNonefalse
limiterReleaseLimiter ReleaseReal320[ 0 , 5 ]trueNonefalse
limiterThresholdLimiter ThresholdReal320[ -30 , 0 ]trueNonefalse
masterVolumeChannel1Master Volume Channel LeftReal320[ -100 , 12 ]trueNonefalse
masterVolumeChannel10Master Volume Channel Height Back LeftReal320[ -100 , 12 ]trueNonefalse
masterVolumeChannel11Master Volume Channel Height Front RightReal320[ -100 , 12 ]trueNonefalse
masterVolumeChannel12Master Volume Channel Low Frequency EffectsReal320[ -100 , 12 ]trueNonefalse
masterVolumeChannel2Master Volume Channel RightReal320[ -100 , 12 ]trueNonefalse
masterVolumeChannel3Master Volume Channel CenterReal320[ -100 , 12 ]trueNonefalse
masterVolumeChannel4Master Volume Channel Surround LeftReal320[ -100 , 12 ]trueNonefalse
masterVolumeChannel5Master Volume Channel Surround RightReal320[ -100 , 12 ]trueNonefalse
masterVolumeChannel6Master Volume Channel Back LeftReal320[ -100 , 12 ]trueNonefalse
masterVolumeChannel7Master Volume Channel Back RightReal320[ -100 , 12 ]trueNonefalse
masterVolumeChannel8Master Volume Channel Height Front LeftReal320[ -100 , 12 ]trueNonefalse
masterVolumeChannel9Master Volume Channel Height Front RightReal320[ -100 , 12 ]trueNonefalse
moduleEnableCompressorCompressor Module EnabledbooltrueNonetrueNonefalse
moduleEnableLimiterLimiter Module EnabledbooltrueNonetrueNonefalse
moduleEnableMasterVolumeMaster Volume Module EnabledbooltrueNonetrueNonefalse
moduleEnableParamEQParam EQ Module EnabledbooltrueNonetrueNonefalse
paramBand1EnabledParam EQ Band 1 EnabledbooltrueNonetrueNonefalse
paramBand1FilterModeParam EQ Filter Mode (Band 1)int325

Possible values :

Value Display Name
1Low pass resonant
2High pass resonant
3Peak
4High shelf
5Low shelf
6Low pass one-pole
7High pass one-pole

trueNonefalse
paramBand1FrequencyParam EQ Frequency (Band 1)Real32100[ 10 , 24000 ]trueNonefalse
paramBand1GainParam EQ Gain (Band 1)Real320[ -20 , 20 ]trueNonefalse
paramBand1ResonanceParam EQ Resonance (Band 1)Real321[ 0.1 , 12 ]trueNonefalse
paramBand2EnabledParam EQ Band 2 EnabledbooltrueNonetrueNonefalse
paramBand2FilterModeParam EQ Filter Mode (Band 2)int323

Possible values :

Value Display Name
1Low pass resonant
2High pass resonant
3Peak
4High shelf
5Low shelf
6Low pass one-pole
7High pass one-pole

trueNonefalse
paramBand2FrequencyParam EQ Frequency (Band 2)Real32200[ 10 , 24000 ]trueNonefalse
paramBand2GainParam EQ Gain (Band 2)Real320[ -20 , 20 ]trueNonefalse
paramBand2ResonanceParam EQ Resonance (Band 2)Real321[ 0.1 , 12 ]trueNonefalse
paramBand3EnabledParam EQ Band 3 EnabledbooltrueNonetrueNonefalse
paramBand3FilterModeParam EQ Filter Mode (Band 3)int323

Possible values :

Value Display Name
1Low pass resonant
2High pass resonant
3Peak
4High shelf
5Low shelf
6Low pass one-pole
7High pass one-pole

trueNonefalse
paramBand3FrequencyParam EQ Frequency (Band 3)Real32500[ 10 , 24000 ]trueNonefalse
paramBand3GainParam EQ Gain (Band 3)Real320[ -20 , 20 ]trueNonefalse
paramBand3ResonanceParam EQ Resonance (Band 3)Real321[ 0.1 , 12 ]trueNonefalse
paramBand4EnabledParam EQ Band 4 EnabledbooltrueNonetrueNonefalse
paramBand4FilterModeParam EQ Filter Mode (Band 4)int324

Possible values :

Value Display Name
1Low pass resonant
2High pass resonant
3Peak
4High shelf
5Low shelf
6Low pass one-pole
7High pass one-pole

trueNonefalse
paramBand4FrequencyParam EQ Frequency (Band 4)Real321000[ 10 , 24000 ]trueNonefalse
paramBand4GainParam EQ Gain (Band 4)Real320[ -20 , 20 ]trueNonefalse
paramBand4ResonanceParam EQ Resonance (Band 4)Real321[ 0.1 , 12 ]trueNonefalse
paramBand5EnabledParam EQ Band 5 EnabledboolfalseNonetrueNonefalse
paramBand5FilterModeParam EQ Filter Mode (Band 5)int323

Possible values :

Value Display Name
1Low pass resonant
2High pass resonant
3Peak
4High shelf
5Low shelf
6Low pass one-pole
7High pass one-pole

trueNonefalse
paramBand5FrequencyParam EQ Frequency (Band 5)Real323000[ 10 , 24000 ]trueNonefalse
paramBand5GainParam EQ Gain (Band 5)Real320[ -20 , 20 ]trueNonefalse
paramBand5ResonanceParam EQ Resonance (Band 5)Real321[ 0.1 , 12 ]trueNonefalse
paramBand6EnabledParam EQ Band 6 EnabledboolfalseNonetrueNonefalse
paramBand6FilterModeParam EQ Filter Mode (Band 6)int323

Possible values :

Value Display Name
1Low pass resonant
2High pass resonant
3Peak
4High shelf
5Low shelf
6Low pass one-pole
7High pass one-pole

trueNonefalse
paramBand6FrequencyParam EQ Frequency (Band 6)Real326000[ 10 , 24000 ]trueNonefalse
paramBand6GainParam EQ Gain (Band 6)Real320[ -20 , 20 ]trueNonefalse
paramBand6ResonanceParam EQ Resonance (Band 6)Real321[ 0.1 , 12 ]trueNonefalse
paramEqNumBandsParam EQ Band Countint324[ 1 , 6 ]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