BASS_SampleStop

---

Stops all instances of a sample.

BOOL BASS_SampleStop(
    HSAMPLE handle
);

Parameters

handle

The sample handle.

Return value

If successful, TRUE is returned, else FALSE is returned. Use BASS_ErrorGetCode to get the error code.

Error codes

BASS_ERROR_HANDLE

handle is not a valid sample.

Remarks

If a sample is playing simultaneously multiple times, calling this function will stop them all, which is obviously simpler than calling BASS_ChannelStop multiple times.

See also

BASS_ChannelStop