Mus Library Reference

MusHandleSetFreqOffset()

Set the frequency offset value using a sound handle.

Syntax

  void MusHandleSetFreqOffset(musHandle handle, float offset);

Arguments

• handle is the sound handle

• offset is the frequency offset

Explanation
Define a frequency offset that is added to the frequency generated by the sound data, before the sound is generated, on the channels associated with the specified sound handle.

The handle must be a sound handle returned by MusStartSong(), MusStartEffect() or MusStartEffect2(), although it is not recommended to use this function in relation to song data. If a handle of zero is supplied, this function will always return zero.

The offset is a floating point value, with 1.0 being a semitone. A limited range of values should be applied using this function (dependant on sample rate). The default frequency offset value for all channels is 0.

Return Value
Number of channels to which the frequency offset has been applied.

Example

  void SetEngineOffset(float offset)
  {
    MusHandleSetFreqOffset(engine_handle, offset);
  }

See Also
MusStartEffect()
MusStartEffect2()

Nintendo® Confidential Warning: all information in this document is confidential and covered by a non-disclosure agreement. You are responsible for keeping this information confidential and protected. Nintendo will vigorously enforce this responsibility. Copyright © 1998-1999 Nintendo of America Inc. All rights reserved Nintendo and N64 are registered trademarks of Nintendo Last updated March 1999