Version
menu_open
Wwise SDK 2024.1.1
MusicSegment
  • Plugin ID: 27
  • Class ID: 1769488

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
3DPosition3D Positionint160

Possible values :

Value Display Name
0Emitter
1Emitter with Automation
2Listener with Automation

trueNonefalse
3DSpatialization3D Spatializationint160

Possible values :

Value Display Name
0None
1Position
2Position + Orientation

trueNonefalse
AttenuationAttenuationReference 

Possible types :

Attenuation

true  
AttenuationDistanceScalingDistance Scaling %Real321[ 0.01 , 100 ]trueMultiplicativefalse
BelowThresholdBehaviorVirtual Voice Behaviorint160

Possible values :

Value Display Name
0Continue to play
1Kill voice
2Send to virtual voice
3Kill if finite else virtual

trueNonefalse
BypassEffectBypass All EffectsboolfalseNonetrueBooleantrue
CenterPercentageCenter %int320[ 0 , 100 ]trueExclusivetrue
ColorColorint160[ 0 , 26 ]trueNonefalse
ConversionConversion SettingsReference 

Possible types :

Conversion

true  
CuesMusic CuesList 

Possible types :

MusicCue

   
EffectsEffectsList 

Possible types :

EffectSlot

   
EnableAttenuationEnable AttenuationbooltrueNonetrueBooleanfalse
EnableDiffractionDiffraction and TransmissionboolfalseNonetrueNonefalse
EnableLoudnessNormalizationEnable Loudness NormalizationboolfalseNonetrueNonefalse
EndPositionEnd PositionReal644000[ 0 , 10000000000 ]falseNonefalse
GameAuxSendHPFGame-Defined Auxiliary Sends HPFint160[ 0 , 100 ]trueAdditivetrue
GameAuxSendLPFGame-Defined Auxiliary Sends LPFint160[ 0 , 100 ]trueAdditivetrue
GameAuxSendVolumeGame-Defined Auxiliary Sends VolumeReal640[ -200 , 200 ]trueAdditivetrue
GridFrequencyPresetGrid Frequencyint1650

Possible values :

Value Display Name
504 Bars
512 Bars
521 Bar
53Beat
541/1 (whole note)
551/2 (half note)
561/4 (quarter note)
571/8 (eighth note)
641/16
671/32
581/2 triplet
591/4 triplet
601/8 triplet
651/16 triplet
681/32 triplet
611/2 dotted
621/4 dotted
631/8 dotted
661/16 dotted
691/32 dotted

trueNonefalse
GridOffsetCustomGrid Offset CustomReal640[ 0 , 99999 ]trueNonefalse
GridOffsetPresetGrid Offsetint160

Possible values :

Value Display Name
0No
1Custom
504 Bars
512 Bars
521 Bar
53Beat
541/1 (whole note)
551/2 (half note)
561/4 (quarter note)
571/8 (eighth note)
641/16
671/32
581/2 triplet
591/4 triplet
601/8 triplet
651/16 triplet
681/32 triplet
611/2 dotted
621/4 dotted
631/8 dotted
661/16 dotted
691/32 dotted

trueNonefalse
HdrActiveRangeHDR Active RangeReal6412[ 0 , 96 ]trueExclusivetrue
HdrEnableEnvelopeEnable Envelope TrackingboolfalseNonetrueNonefalse
HdrEnvelopeSensitivityHDR Envelope SensitivityReal6420[ 0 , 100 ]trueNonefalse
HighpassVoice HPFint160[ 0 , 100 ]trueAdditivetrue
HoldEmitterPositionOrientationHold Emitter Position and OrientationboolfalseNonetrueNonefalse
HoldListenerOrientationHold Listener OrientationboolfalseNonetrueNonefalse
IgnoreParentMaxSoundInstanceIgnore Parent Playback LimitboolfalseNonetrueNonefalse
InclusionInclusionbooltrueNonetrueNonetrue
IsGlobalLimitLimitation Scopeint160

Possible values :

Value Display Name
0Per game object
1Globally

trueNonefalse
ListenerRelativeRoutingListener Relative RoutingbooltrueNonetrueNonefalse
LoudnessNormalizationTargetLoudness Normalization TargetReal64-23[ -96 , 0 ]trueNonefalse
LoudnessNormalizationTypeLoudness Normalization Typeint160

Possible values :

Value Display Name
0Integrated
1Momentary Max

trueNonefalse
LowpassVoice LPFint160[ 0 , 100 ]trueAdditivetrue
MakeUpGainMake-Up GainReal640[ -96 , 96 ]trueAdditivetrue
MaxReachedBehaviorWhen Priority is Equalint160

Possible values :

Value Display Name
0Discard oldest instance
1Discard newest instance

trueNonefalse
MaxSoundPerInstanceSound Instance Limitint1650[ 1 , 1000 ]trueExclusivetrue
MetadataMetadataList 

Possible types :

Metadata

   
MidiTargetMIDI TargetReference 

Possible types :

RandomSequenceContainer
SwitchContainer
BlendContainer
Sound

true  
MidiTempoSourceMIDI Clip Tempo Sourceint160

Possible values :

Value Display Name
0Hierarchy
1File

trueNonefalse
OutputBusOutput BusReference 

Possible types :

Bus


Must not be Null

true  
OutputBusHighpassOutput Bus HPFint160[ 0 , 100 ]trueAdditivetrue
OutputBusLowpassOutput Bus LPFint160[ 0 , 100 ]trueAdditivetrue
OutputBusVolumeOutput Bus VolumeReal640[ -200 , 200 ]trueAdditivetrue
OverLimitBehaviorWhen Limit is Reachedint160

Possible values :

Value Display Name
0Kill voice
1Use virtual voice settings

trueNonefalse
OverrideAnalysisOverride Loudness NormalizationboolfalseNonetrueNonefalse
OverrideClockSettingsOverride Clock SettingsboolfalseNonetrueNonefalse
OverrideColorOverride ColorboolfalseNonetrueNonefalse
OverrideConversionOverride Conversion SettingsboolfalseNonetrueNonefalse
OverrideEarlyReflectionsOverride Early Reflections SendboolfalseNonetrueNonefalse
OverrideEffectOverride EffectsboolfalseNonetrueNonefalse
OverrideGameAuxSendsOverride Game-Defined Auxiliary SendsboolfalseNonetrueNonefalse
OverrideHdrEnvelopeOverride HDR EnvelopeboolfalseNonetrueNonefalse
OverrideMetadataOverride MetadataboolfalseNonetrueNonefalse
OverrideMidiTargetOverride MIDI TargetboolfalseNonetrueNonefalse
OverrideMidiTempoOverride MIDI Clip TempoboolfalseNonetrueNonefalse
OverrideOutputOverride Output Busbool0NonetrueNonefalse
OverridePositioningOverride PositioningboolfalseNonetrueNonefalse
OverridePriorityOverride PriorityboolfalseNonetrueNonefalse
OverrideUserAuxSendsOverride User-Defined Auxiliary SendsboolfalseNonetrueNonefalse
OverrideVirtualVoiceOverride Virtual VoiceboolfalseNonetrueNonefalse
PlaybackSpeedPlayback SpeedReal641[ 0.25 , 4 ]trueMultiplicativetrue
PriorityPriorityint1650[ 0 , 100 ]trueAdditivetrue
PriorityDistanceFactorUse Offset PriorityboolfalseNonetrueNonefalse
PriorityDistanceOffsetOffset at Max Distanceint16-10[ -100 , 100 ]trueNonetrue
RTPCRTPCList 

Possible types :

RTPC

   
ReflectionsAuxSendEarly Reflections Auxiliary SendReference 

Possible types :

AuxBus

true  
ReflectionsVolumeEarly Reflections Send VolumeReal640[ -200 , 200 ]trueAdditivetrue
SpeakerPanningSpeaker Panningint160

Possible values :

Value Display Name
0Direct Assignment
1Balance-Fade
2Steering

trueNonefalse
SpeakerPanning3DSpatializationMixSpeaker Panning / 3D Spatialization Mixint32100[ 0 , 100 ]trueExclusivefalse
StingersMusic StingersList 

Possible types :

MusicStinger

   
TempoTempoReal64120[ 1 , 400 ]trueNonefalse
TimeSignatureLowerTime Signature Lowerint164

Possible values :

Value Display Name
11
22
44
88
1616
3232

trueNonefalse
TimeSignatureUpperTime Signature Upperint164[ 1 , 64 ]trueNonefalse
UseGameAuxSendsUse Game-Defined Auxiliary SendsboolfalseNonetrueNonefalse
UseMaxSoundPerInstanceLimit Sound InstancesboolfalseNonetrueNonetrue
UserAuxSend0User-Defined Auxiliary Send 0Reference 

Possible types :

AuxBus

true  
UserAuxSend1User-Defined Auxiliary Send 1Reference 

Possible types :

AuxBus

true  
UserAuxSend2User-Defined Auxiliary Send 2Reference 

Possible types :

AuxBus

true  
UserAuxSend3User-Defined Auxiliary Send 3Reference 

Possible types :

AuxBus

true  
UserAuxSendHPF0User-Defined Auxiliary HPF 0int160[ 0 , 100 ]trueAdditivetrue
UserAuxSendHPF1User-Defined Auxiliary HPF 1int160[ 0 , 100 ]trueAdditivetrue
UserAuxSendHPF2User-Defined Auxiliary HPF 2int160[ 0 , 100 ]trueAdditivetrue
UserAuxSendHPF3User-Defined Auxiliary HPF 3int160[ 0 , 100 ]trueAdditivetrue
UserAuxSendLPF0User-Defined Auxiliary LPF 0int160[ 0 , 100 ]trueAdditivetrue
UserAuxSendLPF1User-Defined Auxiliary LPF 1int160[ 0 , 100 ]trueAdditivetrue
UserAuxSendLPF2User-Defined Auxiliary LPF 2int160[ 0 , 100 ]trueAdditivetrue
UserAuxSendLPF3User-Defined Auxiliary LPF 3int160[ 0 , 100 ]trueAdditivetrue
UserAuxSendVolume0User-Defined Auxiliary Send Volume 0Real640[ -200 , 200 ]trueAdditivetrue
UserAuxSendVolume1User-Defined Auxiliary Send Volume 1Real640[ -200 , 200 ]trueAdditivetrue
UserAuxSendVolume2User-Defined Auxiliary Send Volume 2Real640[ -200 , 200 ]trueAdditivetrue
UserAuxSendVolume3User-Defined Auxiliary Send Volume 3Real640[ -200 , 200 ]trueAdditivetrue
VirtualVoiceQueueBehaviorOn Return to Physical Voiceint161

Possible values :

Value Display Name
0Play from beginning
1Play from elapsed time
2Resume

trueNonefalse
VolumeVoice VolumeReal640[ -200 , 200 ]trueAdditivetrue

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