Version
menu_open
Wwise SDK 2019.1.11
MusicTrack

(Plugin ID : 28)
(Class ID : 1835024)
Refer to ak.wwise.core.object.setProperty and ak.wwise.core.object.setReference to set properties and references with WAAPI. Also refer to Querying the Wwise Project to learn how to query properties and references.

Properties

Name Display Name Type Default Restriction Read-only Supported RTPC Type Supports Link/Unlink
3DPosition 3D Position int16 0 Possible values :
Value Display Name
0 Emitter
1 Emitter with Automation
2 Listener with Automation





false None false
3DSpatialization 3D Spatialization int16 0 Possible values :
Value Display Name
0 None
1 Position
2 Position + Orientation





false None false
AttachableMixerInput Mixer Plug-in Input Reference   None true    
Attenuation Attenuation Reference   Possible types :
Attenuation



false    
BelowThresholdBehavior Virtual voice behavior int16 0 Possible values :
Value Display Name
0 Continue to play
1 Kill voice
2 Send to virtual voice
3 Kill if finite else virtual






false None false
BypassEffect Bypass All Effects bool false None false Boolean true
BypassEffect0 Bypass Effect 0 bool false None false Boolean true
BypassEffect1 Bypass Effect 1 bool false None false Boolean true
BypassEffect2 Bypass Effect 2 bool false None false Boolean true
BypassEffect3 Bypass Effect 3 bool false None false Boolean true
CenterPercentage Center % int32 0 [ 0 , 100 ] false Exclusive true
Color Color int16 0 [ 0 , 26 ] false None false
Conversion Conversion Settings Reference   Possible types :
Conversion



false    
DefaultSwitchOrState Switch/State Reference   Possible types :
Switch
State




false    
Effect0 Effect 0 Reference   Possible types :
Effect



false    
Effect1 Effect 1 Reference   Possible types :
Effect



false    
Effect2 Effect 2 Reference   Possible types :
Effect



false    
Effect3 Effect 3 Reference   Possible types :
Effect



false    
EnableAttenuation Enable Attenuation bool true None false Boolean false
EnableLoudnessNormalization Enable Loudness Normalization bool false None false None false
GameAuxSendHPF Game-Defined Auxiliary Sends HPF int16 0 [ 0 , 100 ] false Additive true
GameAuxSendLPF Game-Defined Auxiliary Sends LPF int16 0 [ 0 , 100 ] false Additive true
GameAuxSendVolume Game-Defined Auxiliary Sends Volume Real64 0 [ -200 , 200 ] false Additive true
HdrActiveRange HDR Active Range Real64 12 [ 0 , 96 ] false Exclusive true
HdrEnableEnvelope Enable Envelope bool false None false None false
HdrEnvelopeSensitivity HDR Envelope Sensitivity Real64 20 [ 0 , 100 ] false None false
Highpass Voice High-pass Filter int16 0 [ 0 , 100 ] false Additive true
HoldEmitterPositionOrientation Hold Emitter Position and Orientation bool false None false None false
HoldListenerOrientation Hold Listener Orientation bool false None false None false
IgnoreParentMaxSoundInstance Ignore Parent Playback Limit bool false None false None false
Inclusion Inclusion bool true None false None true
IsGlobalLimit Limitation scope int16 0 Possible values :
Value Display Name
0 Per game object
1 Globally




false None false
IsNonCachable Non-cachable bool false None false None true
IsStreamingEnabled Is Streaming Enabled bool false None false None true
IsZeroLantency Zero latency bool false None false None true
ListenerRelativeRouting Listener Relative Routing bool true None false None false
LookAheadTime Look-ahead time (ms) int16 100 [ 0 , 10000 ] false None true
Lowpass Voice Low-pass Filter int16 0 [ 0 , 100 ] false Additive true
MakeUpGain Make-up Gain Real64 0 [ -96 , 96 ] false Additive true
MaxReachedBehavior When priority is equal int16 0 Possible values :
Value Display Name
0 Discard oldest instance
1 Discard newest instance




false None false
MaxSoundPerInstance Sound Instance Limit int16 50 [ 1 , 1000 ] false Exclusive true
MidiTarget MIDI Target Reference   Possible types :
RandomSequenceContainer
SwitchContainer
BlendContainer
Sound






false    
MidiTempoSource MIDI Clip Tempo Source int16 0 Possible values :
Value Display Name
0 Hierarchy
1 File




false None false
MusicTrackType Music Track Type int16 0 Possible values :
Value Display Name
0 Normal
1 Random Step
2 Sequence Step
3 Switch






false None false
OutputBus Output Bus Reference   Possible types :
Bus



Must not be Null
 false    
OutputBusHighpass Output Bus High-pass Filter int16 0 [ 0 , 100 ] false Additive true
OutputBusLowpass Output Bus Low-pass Filter int16 0 [ 0 , 100 ] false Additive true
OutputBusVolume Output Bus Volume Real64 0 [ -200 , 200 ] false Additive true
OverLimitBehavior Virtual voice behavior int16 0 Possible values :
Value Display Name
0 Kill voice
1 Use virtual voice settings




false None false
OverrideAnalysis Override Loudness Normalization bool false None false None false
OverrideAttachableMixerInput Override Mixer Plug-in Input bool false None false None false
OverrideColor Override Color bool false None true None false
OverrideConversion Override Conversion Settings bool false None false None false
OverrideEffect Override Effects bool false None false None false
OverrideGameAuxSends Override Game-Defined Auxiliary Sends bool false None false None false
OverrideHdrEnvelope Override HDR Envelope bool false None false None false
OverrideMidiTarget Override Parent MIDI Target bool false None false None false
OverrideMidiTempo Override MIDI Clip Tempo bool false None false None false
OverrideOutput Override Output Bus bool 0 None false None false
OverridePositioning Override Positioning bool false None false None false
OverridePriority Override Priority bool false None false None false
OverrideUserAuxSends Override User-Defined Auxiliary Sends bool false None false None false
OverrideVirtualVoice Override Virtual Voice bool false None false None false
PreFetchLength Prefetch length (ms) int16 100 [ 0 , 10000 ] false None true
Priority Priority int16 50 [ 0 , 100 ] false Additive true
PriorityDistanceFactor Use Priority Distance Factor bool false None false None false
PriorityDistanceOffset Offset at max distance int16 -10 [ -100 , 100 ] false None true
RenderEffect0 Render Effect 0 bool false None false None true
RenderEffect1 Render Effect 1 bool false None false None true
RenderEffect2 Render Effect 2 bool false None false None true
RenderEffect3 Render Effect 3 bool false None false None true
SpeakerPanning Speaker Panning int16 0 Possible values :
Value Display Name
0 Direct Assignment
1 Balance-Fade




false None false
SpeakerPanning3DSpatializationMix Speaker Panning / 3D Spatialization Mix int32 100 [ 0 , 100 ] false Exclusive false
SwitchGroupOrStateGroup SwitchGroup/StateGroup Reference   Possible types :
SwitchGroup
StateGroup




false    
UseGameAuxSends Use Game-Defined Auxiliary Sends bool false None false None false
UseMaxSoundPerInstance Limit Sound Instances bool false None false None true
UserAuxSend0 User Auxiliary Send 0 Reference   Possible types :
AuxBus



false    
UserAuxSend1 User Auxiliary Send 1 Reference   Possible types :
AuxBus



false    
UserAuxSend2 User Auxiliary Send 2 Reference   Possible types :
AuxBus



false    
UserAuxSend3 User Auxiliary Send 3 Reference   Possible types :
AuxBus



false    
UserAuxSendHPF0 User-Defined Auxiliary HPF 0 int16 0 [ 0 , 100 ] false Additive true
UserAuxSendHPF1 User-Defined Auxiliary HPF 1 int16 0 [ 0 , 100 ] false Additive true
UserAuxSendHPF2 User-Defined Auxiliary HPF 2 int16 0 [ 0 , 100 ] false Additive true
UserAuxSendHPF3 User-Defined Auxiliary HPF 3 int16 0 [ 0 , 100 ] false Additive true
UserAuxSendLPF0 User-Defined Auxiliary LPF 0 int16 0 [ 0 , 100 ] false Additive true
UserAuxSendLPF1 User-Defined Auxiliary LPF 1 int16 0 [ 0 , 100 ] false Additive true
UserAuxSendLPF2 User-Defined Auxiliary LPF 2 int16 0 [ 0 , 100 ] false Additive true
UserAuxSendLPF3 User-Defined Auxiliary LPF 3 int16 0 [ 0 , 100 ] false Additive true
UserAuxSendVolume0 User-Defined Auxiliary Send Volume 0 Real64 0 [ -200 , 200 ] false Additive true
UserAuxSendVolume1 User-Defined Auxiliary Send Volume 1 Real64 0 [ -200 , 200 ] false Additive true
UserAuxSendVolume2 User-Defined Auxiliary Send Volume 2 Real64 0 [ -200 , 200 ] false Additive true
UserAuxSendVolume3 User-Defined Auxiliary Send Volume 3 Real64 0 [ -200 , 200 ] false Additive true
VirtualVoiceQueueBehavior On return to physical voice int16 1 Possible values :
Value Display Name
0 Play from beginning
1 Play from elapsed time
2 Resume





false None false
Volume Voice Volume Real64 0 [ -200 , 200 ] false Additive 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.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise