BASS.NET API for the Un4seen BASS Audio LibraryBassEncBASS_Encode_StopEx Method BASS.NET API for the Un4seen BASS Audio Library
Stops async encoding on a channel.

Namespace: Un4seen.Bass.AddOn.Enc
Assembly: Bass.Net (in Bass.Net.dll) Version: 2.4.12.0
Syntax

[DllImportAttribute("bassenc.dll", CharSet = CharSet.Auto)]
public static bool BASS_Encode_StopEx(
	int handle,
	bool queue
)

Parameters

handle
Type: SystemInt32
The encoder or channel handle... a HENCODE, HSTREAM, HMUSIC, or HRECORD.
queue
Type: SystemBoolean
Process the queue first? If so, the encoder will not be freed until after any data remaining in the queue has been processed, and it will not accept any new data in the meantime.

Return Value

Type: Boolean
If successful, is returned, else is returned. Use BASS_ErrorGetCode to get the error code.
Remarks

When an encoder is told to wait for its queue to be processed, this function will return immediately and the encoder will be freed in the background after the queued data has been processed. BASS_Encode_SetNotify(Int32, ENCODENOTIFYPROC, IntPtr) can be used to request notification of when the encoder has been freed. BASS_Encode_Stop(Int32) (or this function with queue = ) can be used to cancel to queue processing and free the encoder immediately.

ERROR CODEDescription
BASS_ERROR_HANDLEhandle is not valid.

See Also

Reference