BASS.NET API for the Un4seen BASS Audio LibraryBaseEncoderStop Method (Boolean)BASS.NET API for the Un4seen BASS Audio Library
Stops the encoder (if started).

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

public virtual bool Stop(
	bool queue
)

Parameters

queue
Type: SystemBoolean
to tell BASSenc to wait for the async queue to be processed (the function will still return immediately but the encoder won't be freed yet).

Return Value

Type: Boolean
Returns , if the encoder was successfully stopped - else is returned.
Remarks

This overload is only in effect, if UseAsyncQueue is set (to ). Internally BASS_Encode_StopEx(Int32, Boolean) is called using the EncoderHandle. After the encoder was stopped successfully the EncoderHandle is set to 0 (zero). If the encoder was not stopped the EncoderHandle is left unchanged.

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

See Also

Reference