BASS_SampleStop

Stops and frees all of a sample's channels (HCHANNEL). 

BOOL BASS_SampleStop(
    HSAMPLE handle
);

Parameters

handleThe 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_HANDLEhandle is not a valid sample.

Remarks

This function is basically equivalent to calling BASS_ChannelStop on each of a sample's channels (HCHANNEL). The sample's streams (HSTREAM) are not affected.

See also

BASS_ChannelStop