BASS_Encode_IsActive

Checks if an encoder is running.

DWORD BASS_Encode_IsActive(
    DWORD handle
);

Parameters

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

Return value

The return value is one of the following.
BASS_ACTIVE_STOPPEDThe encoder is not running. No more data will be accepted.
BASS_ACTIVE_ENCODINGThe encoder is running.
BASS_ACTIVE_PAUSEDThe encoder's DSP feed is paused.
BASS_ACTIVE_DRAININGThe encoder's queue is being drained before being freed. No new data will be accepted.

Remarks

When a channel handle (rather than encoder handle) is used and there are multiple encoders on the channel, BASS_ACTIVE_ENCODING will be returned if any of them are active.

If an encoder stops running prematurely, BASS_Encode_Stop or BASS_Encode_StopEx should still be called to release resources that were allocated for the encoding.

See also

BASS_Encode_GetCount, BASS_Encode_SetNotify, BASS_Encode_SetPaused, BASS_Encode_Stop