Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2022.1.17.8543 ). 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 2022.1.17
RandomSequenceContainer
  • Plugin ID: 9
  • Class ID: 589840

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
AttachableMixerInputMixer Plug-in InputReference Nonefalse  
AttenuationAttenuationReference 

Possible types :

Attenuation

true  
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
BypassEffect0Bypass Effect 0boolfalseNonetrueBooleantrue
BypassEffect1Bypass Effect 1boolfalseNonetrueBooleantrue
BypassEffect2Bypass Effect 2boolfalseNonetrueBooleantrue
BypassEffect3Bypass Effect 3boolfalseNonetrueBooleantrue
CenterPercentageCenter %int320[ 0 , 100 ]trueExclusivetrue
ColorColorint160[ 0 , 26 ]trueNonefalse
ConversionConversion SettingsReference 

Possible types :

Conversion

true  
Effect0Effect 0Reference 

Possible types :

Effect

true  
Effect1Effect 1Reference 

Possible types :

Effect

true  
Effect2Effect 2Reference 

Possible types :

Effect

true  
Effect3Effect 3Reference 

Possible types :

Effect

true  
EnableAttenuationEnable AttenuationbooltrueNonetrueBooleanfalse
EnableDiffractionEnable DiffractionboolfalseNonetrueNonefalse
EnableLoudnessNormalizationEnable Loudness NormalizationboolfalseNonetrueNonefalse
EnableMidiNoteTrackingEnable MIDI note trackingboolfalseNonetrueNonefalse
GameAuxSendHPFGame-Defined Auxiliary Sends HPFint160[ 0 , 100 ]trueAdditivetrue
GameAuxSendLPFGame-Defined Auxiliary Sends LPFint160[ 0 , 100 ]trueAdditivetrue
GameAuxSendVolumeGame-Defined Auxiliary Sends VolumeReal640[ -200 , 200 ]trueAdditivetrue
GlobalOrPerObjectGlobal Or Per Objectint161

Possible values :

Value Display Name
0Game object
1Global

trueNonefalse
HdrActiveRangeHDR Active RangeReal6412[ 0 , 96 ]trueExclusivetrue
HdrEnableEnvelopeEnable EnvelopeboolfalseNonetrueNonefalse
HdrEnvelopeSensitivityHDR Envelope SensitivityReal6420[ 0 , 100 ]trueNonefalse
HighpassVoice High-pass Filterint160[ 0 , 100 ]trueAdditivetrue
HoldEmitterPositionOrientationHold Emitter Position and OrientationboolfalseNonetrueNonefalse
HoldListenerOrientationHold Listener OrientationboolfalseNonetrueNonefalse
IgnoreParentMaxSoundInstanceIgnore Parent Playback LimitboolfalseNonetrueNonefalse
InclusionInclusionbooltrueNonetrueNonetrue
InitialDelayInitial DelayReal640[ 0 , 3600 ]trueAdditivetrue
IsGlobalLimitLimitation scopeint160

Possible values :

Value Display Name
0Per game object
1Globally

trueNonefalse
ListenerRelativeRoutingListener Relative RoutingbooltrueNonetrueNonefalse
LowpassVoice Low-pass Filterint160[ 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

   
MidiBreakOnNoteOffMIDI break on note-offboolfalseNonetrueNonefalse
MidiChannelFilterChannel Filterint3265535[ 0 , 65535 ]trueNonefalse
MidiKeyFilterMaxKey Range Maxint32127[ 0 , 127 ]trueNonefalse
MidiKeyFilterMinKey Range Minint320[ 0 , 127 ]trueNonefalse
MidiPlayOnNoteTypeMIDI play onint161

Possible values :

Value Display Name
1Note-On
2Note-Off

trueNonefalse
MidiTrackingRootNoteMIDI tracking root noteint3260[ 0 , 127 ]trueNonefalse
MidiTranspositionTranspositionint320[ -127 , 127 ]trueAdditivefalse
MidiVelocityFilterMaxVelocity Maxint32127[ 0 , 127 ]trueNonefalse
MidiVelocityFilterMinVelocity Minint320[ 0 , 127 ]trueNonefalse
MidiVelocityOffsetVelocity Offsetint320[ -127 , 127 ]trueAdditivefalse
NormalOrShuffleRandom typeint161

Possible values :

Value Display Name
0Shuffle
1Standard

trueNonefalse
OutputBusOutput BusReference 

Possible types :

Bus


Must not be Null

true  
OutputBusHighpassOutput Bus High-pass Filterint160[ 0 , 100 ]trueAdditivetrue
OutputBusLowpassOutput Bus Low-pass Filterint160[ 0 , 100 ]trueAdditivetrue
OutputBusVolumeOutput Bus VolumeReal640[ -200 , 200 ]trueAdditivetrue
OverLimitBehaviorVirtual voice behaviorint160

Possible values :

Value Display Name
0Kill voice
1Use virtual voice settings

trueNonefalse
OverrideAnalysisOverride Loudness NormalizationboolfalseNonetrueNonefalse
OverrideAttachableMixerInputOverride Mixer Plug-in InputboolfalseNonetrueNonefalse
OverrideColorOverride ColorboolfalseNonetrueNonefalse
OverrideConversionOverride Conversion SettingsboolfalseNonetrueNonefalse
OverrideEarlyReflectionsOverride Early Reflections SendboolfalseNonetrueNonefalse
OverrideEffectOverride EffectsboolfalseNonetrueNonefalse
OverrideGameAuxSendsOverride Game-Defined Auxiliary SendsboolfalseNonetrueNonefalse
OverrideHdrEnvelopeOverride HDR EnvelopeboolfalseNonetrueNonefalse
OverrideMetadataOverride MetadataboolfalseNonetrueNonefalse
OverrideMidiEventsBehaviorOverride MIDI events behaviorboolfalseNonetrueNonefalse
OverrideMidiNoteTrackingOverride MIDI note trackingboolfalseNonetrueNonefalse
OverrideOutputOverride Output Busbool0NonetrueNonefalse
OverridePositioningOverride PositioningboolfalseNonetrueNonefalse
OverridePriorityOverride PriorityboolfalseNonetrueNonefalse
OverrideUserAuxSendsOverride User-Defined Auxiliary SendsboolfalseNonetrueNonefalse
OverrideVirtualVoiceOverride Virtual VoiceboolfalseNonetrueNonefalse
PitchVoice Pitchint320[ -2400 , 2400 ]trueAdditivetrue
PlayMechanismInfiniteOrNumberOfLoopsInfinite Loopingint161

Possible values :

Value Display Name
0No. of loops
1Infinite

trueNonefalse
PlayMechanismLoopLoopboolfalseNonetrueNonefalse
PlayMechanismLoopCountNo. of loopsint322[ 1 , 32767 ]trueNonefalse
PlayMechanismResetPlaylistEachPlayAlways reset playlistbooltrueNonetrueNonefalse
PlayMechanismSpecialTransitionsTransitionsboolfalseNonetrueNonefalse
PlayMechanismSpecialTransitionsTypeTransition Typeint160

Possible values :

Value Display Name
0Xfade (amp)
4Xfade (power)
1Delay
2Sample accurate
3Trigger rate

trueNonefalse
PlayMechanismSpecialTransitionsValueDurationReal641[ 0 , 3600 ]trueAdditivefalse
PlayMechanismStepOrContinuousStep or Continuousint161

Possible values :

Value Display Name
0Continuous
1Step

trueNonefalse
PriorityPriorityint1650[ 0 , 100 ]trueAdditivetrue
PriorityDistanceFactorUse Priority Distance FactorboolfalseNonetrueNonefalse
PriorityDistanceOffsetOffset at max distanceint16-10[ -100 , 100 ]trueNonetrue
RTPCRTPCList 

Possible types :

RTPC

   
RandomAvoidRepeatingLimit repetitionbooltrueNonetrueNonefalse
RandomAvoidRepeatingCountLimit repetition toint321[ 1 , 999 ]trueNonefalse
RandomOrSequenceRandom or Sequenceint161

Possible values :

Value Display Name
0Sequence
1Random

trueNonefalse
ReflectionsAuxSendEarly Reflections Auxiliary SendReference 

Possible types :

AuxBus

true  
ReflectionsVolumeEarly Reflections Send VolumeReal640[ -200 , 200 ]trueAdditivetrue
RenderEffect0Render Effect 0boolfalseNonetrueNonetrue
RenderEffect1Render Effect 1boolfalseNonetrueNonetrue
RenderEffect2Render Effect 2boolfalseNonetrueNonetrue
RenderEffect3Render Effect 3boolfalseNonetrueNonetrue
RestartBeginningOrBackwardAt end of playlistint161

Possible values :

Value Display Name
0Play in reverse order
1Restart

trueNonefalse
SpeakerPanningSpeaker Panningint160

Possible values :

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

trueNonefalse
SpeakerPanning3DSpatializationMixSpeaker Panning / 3D Spatialization Mixint32100[ 0 , 100 ]trueExclusivefalse
UseGameAuxSendsUse Game-Defined Auxiliary SendsboolfalseNonetrueNonefalse
UseMaxSoundPerInstanceLimit Sound InstancesboolfalseNonetrueNonetrue
UserAuxSend0User Auxiliary Send 0Reference 

Possible types :

AuxBus

true  
UserAuxSend1User Auxiliary Send 1Reference 

Possible types :

AuxBus

true  
UserAuxSend2User Auxiliary Send 2Reference 

Possible types :

AuxBus

true  
UserAuxSend3User 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
WeightWeightReal6450[ 0.001 , 100 ]trueNonetrue

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