BASS.NET API for the Un4seen BASS Audio Library

BassMixBASS_Split_StreamResetEx Method

BASS.NET API for the Un4seen BASS Audio Library
Resets a splitter stream and sets its position in the source buffer.

Namespace:  Un4seen.Bass.AddOn.Mix
Assembly:  Bass.Net (in Bass.Net.dll) Version: 2.4.17.5
Syntax

[DllImportAttribute("bassmix")]
public static bool BASS_Split_StreamResetEx(
	int handle,
	int offset
)

Parameters

handle
Type: SystemInt32
The splitter (as obtained by BASS_Split_StreamCreate(Int32, BASSFlag, Int32)) or the source channel handle.
offset
Type: SystemInt32
How far back (in bytes) to position the splitter in the source buffer. This is based on the source's sample format, which may have a different channel count to the splitter.

Return Value

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

This function is the same as BASS_Split_StreamReset(Int32) except that it also provides the ability to position the splitter stream within the buffer that is shared by all of the splitter streams of the same source. A splitter stream's buffer position determines what data it will next receive. For example, if its position is half a second back, it will receive half a second of buffered data before receiving new data from the source. Calling this function with offset = 0 will result in the next data that the splitter stream receives being new data from the source, and is identical to using BASS_Split_StreamReset(Int32).

offset is automatically limited to the amount of data that the source buffer contains, which is in turn limited to the buffer size, determined by the BASS_CONFIG_SPLIT_BUFFER config option. The amount of source data buffered, as well as a splitter stream's position within it, is available from BASS_Split_StreamGetAvailable(Int32).

ERROR CODEDescription
BASS_ERROR_HANDLEThe handle is neither a splitter stream or source.

See Also

Reference