mm_sound_effect

Definition

typedef struct t_mmsoundeffect
{
    union {
    mm_word id;
    mm_ds_sample* sample;
    }
    mm_hword rate;
    mm_sfxhand handle;
    mm_byte volume;
    mm_byte panning;
} mm_sound_effect;

Members

id

ID of sample to be played. Values are defined in the soundbank header.

sample

Address of external sample, must be in mainram. id is ignored if this entry is used.

rate

Playback rate. 6.10 fixed point number. (1024 = original sound)

handle

Handle of previous sound effect. If a valid handle is given, it will be recycled.

volume

Volume level. Ranges from 0 (silent) to 255 (normal).

panning

Panning level. Ranges from 0 (far-left) to 255 (far-right).

Description

Information for playing a sound effect. The sample entry is only supported on DS and may be used to play an external sample source.