BASS_Encode_Stop

Frees an encoder or all encoders on a channel.

BOOL BASS_Encode_Stop(
    DWORD handle
);

Parameters

handleThe encoder or channel handle... a HENCODE, HSTREAM, HMUSIC, or HRECORD.

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 valid.

Remarks

This function will discard any data that may be remaining in the encoder's queue. BASS_Encode_StopEx can be used instead to have the queue processed first.

A command-line encoder process (eg. started by BASS_Encode_Start) will be forcefully terminated if it does not finish up within a period determined by the BASS_CONFIG_ENCODE_TERMINATE config option. That can be overridden with BASS_Encode_StopEx.

See also

BASS_Encode_Start, BASS_Encode_StopEx