SNDChannelInfo

Definition

#include <nitro/snd.h>
typedef struct SNDChannelInfo
{
    BOOL activeFlag : 1;
    BOOL lockFlag : 1;
    
    u16 volume;
    u8 pan;
    u8 pad_;
    
    SNDEnvStatus envStatus;
} SNDChannelInfo;

Elements

activeFlag The active flag. Indicates whether the channel is currently operating.
lockFlag The lock flag. Indicates whether the channel is currently locked.

The following members are valid only when activeFlag is TRUE.

volume The volume. Takes a value between 0 and 2032.
pan The pan. Takes values in the range of 0 (left) to 64 (center) to 127 (right).

The following member is valid only when activeFlag is TRUE and lockFlag is FALSE.

envStatus The envelope status.

Description

This is the channel information structure. It stores the information for a single channel.

The contents of this structure can be obtained with the SND_ReadChannelInfo function.

The envelope status envStatus takes one of the following values.

Table. SNDEnvStatus

Label Description
SND_ENV_ATTACK Attack
SND_ENV_DECAY Decay
SND_ENV_SUSTAIN Sustain
SND_ENV_RELEASE Release

Note

The structure size and the member arrangement may be changed in the future.

See Also

SND_ReadChannelInfo

Revision History

2005/02/17 Initial version.


CONFIDENTIAL