BASSenc

BASS_Encode_StopEx

Frees an encoder or all encoders on a channel, optionally delaying it until the queue has been processed.

BOOL BASS_Encode_StopEx(
    DWORD handle,
    BOOL queue
);

Parameters

handle	The encoder or channel handle... a HENCODE, HSTREAM, HMUSIC, or HRECORD.
queue	Wait for the queue? If so, the encoder will not be freed until any data remaining in the queue has been processed, and it will not accept any new data in the meantime.

Return value

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

Remarks

When an encoder has been told to wait for its queue to be processed, BASS_Encode_Stop (or this function with queue = FALSE) can be used to cancel that and free the encoder immediately.

Error codes

BASS_ERROR_HANDLE

handle is not valid.