Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). 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.8

Plugin ID: 0
Class ID: 16

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

Name

Display Name

Type

Default

Restriction

Is Visible

Supported RTPC Type

Supports Link/Unlink

ChannelConfigOverride

Channel Configuration Override

int64

None

true

None

false

Color

Color

int16

[ 0 , 26 ]

true

None

false

Conversion

Conversion Settings

Reference

Possible types :

Conversion

true

CrossfadeDuration

Crossfade Duration

Real64

[ 0 , 60000 ]

true

None

false

CrossfadeShape

Crossfade Shape

int16

Possible values :

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

true

None

false

FadeInDuration

Fade-in Duration

Real64

[ 0 , 3600 ]

true

None

false

FadeInShape

Fade-in Curve

int16

Possible values :

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

true

None

false

FadeOutDuration

Fade-out Duration

Real64

[ 0 , 3600 ]

true

None

false

FadeOutShape

Fade-out Curve

int16

Possible values :

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

true

None

false

HdrEnvelope

HDR Envelope

Real64

[ 0 , 1 ]

false

None

false

LoopBegin

Loop Start

Real64

-0.001

None

true

None

false

LoopEnd

Loop End

Real64

-0.001

None

true

None

false

MarkerDetectionSensitivity

Marker Detection Sensitivity

Real64

[ 0 , 100 ]

true

None

false

MarkerInputMode

Marker Input Mode

int16

Possible values :

Value	Display Name
0	Import From File
1	Detect From Transients
2	Manual Markers

true

None

false

Markers

Markers

List

Possible types :

Marker

OverrideColor

Override Color

bool

false

None

true

None

false

OverrideConversion

Override Conversion Settings

bool

false

None

true

None

false

OverrideWavLoop

Override wav loop points

bool

false

None

true

None

false

TrimBegin

Trim Start

Real64

-0.001

None

true

None

false

TrimEnd

Trim End

Real64

-0.001

None

true

None

false

VolumeOffset

Make-Up Gain

Real64

[ -24 , +24 ]

true

None

true

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.

Get started with Wwise

Wwise SDK

AudioFileSource

Properties, References, Lists

Was this page helpful?

Need Support?

Tell us about your project. We're here to help.