SoundGroup::SetFrequency

Defined in: C4Sound.h

Sets the frequency of a sound group.

Prototype

void SetFrequency(float frequency);

Parameters

frequency The new frequency of the sound group. This must be a positive number.

Description

The SetFrequency function sets the relative frequency applied to all sounds that are members of a sound group. The value of the frequency parameter multiplies the individual frequency of each sound in a group to produce a final playback frequency. A value of 1.0 (the default) means play at the frequency of the source data, a value of 0.5 means play at half the frequency, and so on. Values greater than 1.0 are allowed, but sound quality may be diminished.

A sound is added to or removed from a sound group using the Sound::SetSoundGroup function.