XACT Event, Set Volume and Set Pitch

The Set Volume event is used to set and optionally fade the playback volume of a wave.

The Set Pitch event is used to set and optionally fade the playback pitch of a wave.

The properties of Volume and Pitch events are the same for each.

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.

Set Volume Properties

Property Name Description
SettingType

May be one of the following settings:

  • Ramp – A ramping event provides for a gradual change in a sound's property without the need to set an event to be recurring with an equation.
  • Equation – An instant change to a sound's property to a specific value or an adjustment to the current value based upon a modifier.

Ramp SettingType Properties

Property Name Description
Duration Defines how long the ramp will occur, in seconds.
StartVolume Starting volume/pitch setting when the event occurs.
EndVolume Volume/pitch setting when the event ends.
Curvature How steep the curve from start to end value is.

Equation SettingType Properties

Property Name Description
EquationType

May be one of the following settings:

  • Constant – The property is adjusted by a fixed amount.
  • Random from Range – The property is adjusted by a random amount between RangeMinimum and RangeMaximum.

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