XACT Event, Stop

The Stop event allows the audio designer to specify the time that playback of a wave is to terminate. For example, the audio designer may wish to have an in-memory looping wave or sound play for three seconds and then stop. The Stop event allows the audio designer (rather than the title programmer) to control this behavior.

The Stop event may halt wave playback abruptly, but it doesn't have to. The audio designer may define a release envelope that specifies the volume and/or pitch of the wave to fade out slowly. The Stop event permits the audio designer to associate a release envelope with the track and to specify when it is to be invoked.

Properties

Event Properties

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

Repeat Properties

The common set of repeat properties that specify how often and in what manner the event is to automatically repeat itself.

Stop Wave Properties

Property Name Description
StopEntireCue Stop the cue instance, allow for a release envelope.
StopImmediately Stop the sound immediately, no release envelope.

Timing Properties

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

See Also

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