XACT Event, Play Wave

The Play Wave event causes a wave to commence playback. It also allows the audio designer to specify that the wave is to be repeated, or specify a list of waves that can be cycled through either in sequence or at random.

Properties

Event Properties

The common set of event properties that specify the event name and hold comments.

Level Variations

Property Name Description
VolumeVariation Randomized volume is used when the event is played.
PitchVariation Randomized pitch is used when the event is played.
RangeMinimum Minimum value to set when choosing a random value.
RangeMaximum Maximum value to set when choosing a random value.
NewValueOnLoop Determines whether a new variation should be selected each time the play event loops.
OperationToPerform

How the new setting should behave relative to other parameter settings the track may already have.

  • Replace current
  • Add to current
  • Subtract from current
  • Multiply by current

Play Wave Properties

Property Name Description
LoopEvent

Number of times to repeat the wave entry.

  • No
  • Finite
  • Infinite
LoopCount Specifies the number of additional times the event should play. For instance, setting the loop count to 1 means the event will play a total of two times.
NewVariationOnLoop When the play event loops, whether to repeat the identical wave or choose a new variation (in wave, pitch, volume, and so on)
PlayRelease For cues that use looping sounds, this setting determines how a sound will be stopped. If set to True, a cue will stop looping and play to the end of the wave. If set to False, the sound will stop immediately. An exception is made in the case of a sound that is looping and has a Release RPC attached. In that case, the sound will fade out as the Release RPC specifies while continuing to loop.

Speaker Positioning Properties

Property Name Description
EnableSpeakerPositioning

Determines whether to position the speaker at a random location around the user (true) or to use authored speaker assignment properties (false).

UseCenterSpeaker Determines whether the center speaker is used for positioning.
SpeakerPositionAngle Angle used for speaker positioning, in degrees:
  • 0 degrees — ahead
  • 90 degrees — right
  • 180 degrees — behind
  • 270 degrees — left
SpeakerPositionArcSize For a random speaker position, the size of the arc that will contain the position.
NewPositionOnLoop When the play event loops, whether to pick a new pick a new position, or keep using the same position.

Timing Properties

The common set of timing properties that hold relative time information for playback and repeats.

Variation Playlist Properties

Property Name Description
PlayListType

When there is a wave variation list associated with the sound, this property determines the play order each time the sound is played.

  • Ordered
  • Ordered from random
  • Random
  • Random (no immediate repeats)
  • Shuffle
Variations

A variation contains the following properties.

Property Description
Wave Wave attached to the variation.
Weight Weight for the variation (how frequently it will be chosen, while abiding the playlist restrictions).

See Also

XACT Events, XACT Audio Authoring, XACT Overviews, XACT Reference