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
Wwise Guitar Distortion
  • Plugin ID: 126
  • Class ID: 8257539

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
DistortionDriveDistortion DriveReal3250[ 0 , 100 ]trueAdditivefalse
DistortionToneDistortion ToneReal3250[ 0 , 100 ]trueAdditivefalse
DistortionTypeDistortion Typeint320

Possible values :

Value Display Name
0None
1Overdrive
2Heavy
3Fuzz
4Clip

trueExclusivefalse
OutputLevelOutput GainReal320[ -24 , 24 ]trueAdditivefalse
PostEQBand1EnablePost-Distortion EQ Band 1 EnableboolfalseNonetrueBooleanfalse
PostEQBand1FilterTypePost-Distortion EQ Band 1 Filter Typeint320

Possible values :

Value Display Name
0Low Shelf
1Peaking
2High Shelf
3Low Pass
4High Pass
5Band Pass
6Notch

trueExclusivefalse
PostEQBand1FrequencyPost-Distortion EQ Band 1 FrequencyReal321000[ 20 , 20000 ]trueExclusivefalse
PostEQBand1GainPost-Distortion EQ Band 1 GainReal320[ -48 , 48 ]trueAdditivefalse
PostEQBand1QFactorPost-Distortion EQ Band 1 Quality FactorReal321[ 0.1 , 20 ]trueExclusivefalse
PostEQBand2EnablePost-Distortion EQ Band 2 EnableboolfalseNonetrueBooleanfalse
PostEQBand2FilterTypePost-Distortion EQ Band 2 Filter Typeint320

Possible values :

Value Display Name
0Low Shelf
1Peaking
2High Shelf
3Low Pass
4High Pass
5Band Pass
6Notch

trueExclusivefalse
PostEQBand2FrequencyPost-Distortion EQ Band 2 FrequencyReal321000[ 20 , 20000 ]trueExclusivefalse
PostEQBand2GainPost-Distortion EQ Band 2 GainReal320[ -48 , 48 ]trueAdditivefalse
PostEQBand2QFactorPost-Distortion EQ Band 2 Quality FactorReal321[ 0.1 , 20 ]trueExclusivefalse
PostEQBand3EnablePost-Distortion EQ Band 3 EnableboolfalseNonetrueBooleanfalse
PostEQBand3FilterTypePost-Distortion EQ Band 3 Filter Typeint320

Possible values :

Value Display Name
0Low Shelf
1Peaking
2High Shelf
3Low Pass
4High Pass
5Band Pass
6Notch

trueExclusivefalse
PostEQBand3FrequencyPost-Distortion EQ Band 3 FrequencyReal321000[ 20 , 20000 ]trueExclusivefalse
PostEQBand3GainPost-Distortion EQ Band 3 GainReal320[ -48 , 48 ]trueAdditivefalse
PostEQBand3QFactorPost-Distortion EQ Band 3 Quality FactorReal321[ 0.1 , 20 ]trueExclusivefalse
PreEQBand1EnablePre-Distortion EQ Band 1 EnableboolfalseNonetrueBooleanfalse
PreEQBand1FilterTypePre-Distortion EQ Band 1 Filter Typeint320

Possible values :

Value Display Name
0Low Shelf
1Peaking
2High Shelf
3Low Pass
4High Pass
5Band Pass
6Notch

trueExclusivefalse
PreEQBand1FrequencyPre-Distortion EQ Band 1 FrequencyReal321000[ 20 , 20000 ]trueExclusivefalse
PreEQBand1GainPre-Distortion EQ Band 1 GainReal320[ -48 , 48 ]trueAdditivefalse
PreEQBand1QFactorPre-Distortion EQ Band 1 Quality FactorReal321[ 0.1 , 20 ]trueExclusivefalse
PreEQBand2EnablePre-Distortion EQ Band 2 EnableboolfalseNonetrueBooleanfalse
PreEQBand2FilterTypePre-Distortion EQ Band 2 Filter Typeint320

Possible values :

Value Display Name
0Low Shelf
1Peaking
2High Shelf
3Low Pass
4High Pass
5Band Pass
6Notch

trueExclusivefalse
PreEQBand2FrequencyPre-Distortion EQ Band 2 FrequencyReal321000[ 20 , 20000 ]trueExclusivefalse
PreEQBand2GainPre-Distortion EQ Band 2 GainReal320[ -48 , 48 ]trueAdditivefalse
PreEQBand2QFactorPre-Distortion EQ Band 2 Quality FactorReal321[ 0.1 , 20 ]trueExclusivefalse
PreEQBand3EnablePre-Distortion EQ Band 3 EnableboolfalseNonetrueBooleanfalse
PreEQBand3FilterTypePre-Distortion EQ Band 3 Filter Typeint320

Possible values :

Value Display Name
0Low Shelf
1Peaking
2High Shelf
3Low Pass
4High Pass
5Band Pass
6Notch

trueExclusivefalse
PreEQBand3FrequencyPre-Distortion EQ Band 3 FrequencyReal321000[ 20 , 20000 ]trueExclusivefalse
PreEQBand3GainPre-Distortion EQ Band 3 GainReal320[ -48 , 48 ]trueAdditivefalse
PreEQBand3QFactorPre-Distortion EQ Band 3 Quality FactorReal321[ 0.1 , 20 ]trueExclusivefalse
RectificationDistortion RectificationReal320[ 0 , 100 ]trueAdditivefalse
WetDryMixWet/Dry MixReal32100[ 0 , 100 ]trueAdditivefalse

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