DS GBA
mmEffect

Back to Index

Prototype

mm_sfxhand mmEffect( mm_word sample_ID );

Parameters

sample_ID

Index of sample to be played. Values are defined in the soundbank header. (prefixed with "SFX_")

Return

Sound effect handle. This value can be used to modify parameters of the sound effect while it is playing.

Description

Plays a sound effect with default settings. Default settings are: Volume=Max, Panning=Center, Rate=Center (specified in sample).

The value returned from this function is a handle and can be used to modify the sound effect while it's actively playing.

For DS, make sure the sample is loaded (mmLoadEffect).

See Also

mmLoadEffect, mmEffectEx