# NNS_SndPlayerSetTrackModDepth

## Syntax

      #include <nnsys/snd.h>

      void NNS_SndPlayerSetTrackModDepth(
              NNSSndHandle* handle,
              u16 trackBitMask,
              int depth );

## Arguments

`handle` | The sound handle pointer.
`trackBitMask` | This is the track bit mask.
`depth` | Modulation depth value. Takes a value between 0 and 255.

## Return Values

None.

## Description

Changes modulation depth of the sequence track.

This function changes the modulation depth of the sequence that is bound to the sound handle `handle`. This function does not perform any action if the sound handle is invalid.

Use `trackBitMask` to specify the tracks to be set. The tracks are identified from the lower bit in sequence: Track 0, Track 1, Track 2 .... All tracks that have enabled bits will have their modulation depth changed. For example, to change the modulation depth of Track 2 and Track 5, use (1 << 2) | (1 << 5); i.e., 0x0024.

The default `depth` value is 0 and there is no modulation effect. A larger value creates a larger effect. For example, if the modulation type is the default "whole tone pitch change," at a value of 127 the depth will be +/- 1 semitone or half step.

### Note

If a modulation depth value is already set inside the sequence data, the value set later is the one that is valid.

## See Also

None.

## Revision History

2004/06/01 Revised to state that the Sound Handle binds to the sequence
2004/04/01 Initial version

CONFIDENTIAL