BASS_ChannelSetPosition

Sets the current position of a channel.

BOOL BASS_ChannelSetPosition(
    DWORD handle,
    QWORD pos,
    DWORD mode
);

Parameters

handle

The channel handle... a HCHANNEL, HMUSIC, HSTREAM, or HRECORD.

pos

The position, in units determined by the mode.

mode

How to set the position. One of the following, with optional flags.

BASS_POS_BYTE	The position is in bytes. Rounded down to the nearest sample boundary.
BASS_POS_MUSIC_ORDER	The position is in orders and rows... use MAKELONG(order,row). (HMUSIC only)
BASS_POS_OGG	The position is a bitstream number in an OGG file... 0 = first.
BASS_POS_END	The position is in bytes and is where the channel will end... 0 = normal end position. This will have no effect if it is beyond the channel's normal end position. If the channel is already at/beyond the position then it will end at its current position.
BASS_POS_LOOP	The position is in bytes and is where looping will start from (when looping is enabled). Rounded down to the nearest sample boundary. If this is at/beyond the end then the default loop position of 0 will be used instead.
BASS_POS_DECODETO	Flag: Decode/render up to the position rather than seeking to it. This is useful for streams that are unseekable or that have inexact seeking, but it is generally slower than normal seeking and the requested position cannot be behind the current decoding position. This flag can only be used with the BASS_POS_BYTE mode.
BASS_POS_FLUSH	Flag: Flush all output buffers (including FX) so that no remnant of the old position is heard after seeking. This is automatic on normal playback channels (not decoding channels) outside of a "mixtime" SYNCPROC.
BASS_POS_INEXACT	Flag: Allow inexact seeking. For speed, seeking may stop at the beginning of a block rather than partially processing the block to reach the requested position.
BASS_POS_RELATIVE	Flag: The requested position is relative to the current position. pos is treated as signed in this case and can be negative.
BASS_POS_RESET	Flag: Reset user file buffers. This allows a user file stream with the BASS_STREAM_BLOCK flag set to be reset, so that it is ready to process new data. This flag can only be used with the BASS_POS_BYTE mode, and pos must be 0.
BASS_POS_SCAN	Flag: Scan the file to build a seek table up to the position, if it has not already been scanned. Scanning will continue from where it left off previously rather than restarting from the beginning of the file each time. This flag only applies to MP3/MP2/MP1 files and will be ignored with other file formats.
BASS_MUSIC_POSRESET	Flag: Stop all notes. This flag is applied automatically if it has been set on the channel, eg. via BASS_ChannelFlags. (HMUSIC)
BASS_MUSIC_POSRESETEX	Flag: Stop all notes and reset bpm/etc to defaults. This flag is applied automatically if it has been set on the channel, eg. via BASS_ChannelFlags. (HMUSIC)

other modes & flags may be supported by add-ons, see the documentation.

Return value

If successful, then TRUE is returned, else FALSE is returned. Use BASS_ErrorGetCode to get the error code.

Error codes

BASS_ERROR_HANDLE	handle is not a valid channel.
BASS_ERROR_NOTFILE	The stream is not a file stream.
BASS_ERROR_POSITION	The requested position is invalid, eg. it is beyond the end or the download has not yet reached it.
BASS_ERROR_NOTAVAIL	The requested mode is not available. Invalid flags are ignored and do not result in this error.
BASS_ERROR_UNKNOWN	Some other mystery problem!

Remarks

Setting the position of a MOD music in bytes (other than 0) requires that the BASS_MUSIC_PRESCAN flag was used in the BASS_MusicLoad call, or the use of the BASS_POS_DECODETO flag. When setting the position in orders and rows, the channel's byte position (as reported by BASS_ChannelGetPosition) is reset to 0. That is because it is not possible to get the byte position of an order/row position; it is possible for an order/row position to never be played in the normal course of events, or it may be played multiple times.

When setting the position of a MOD music, and the BASS_MUSIC_POSRESET flag is active, all notes that were playing before the position changed will be stopped. Otherwise, the notes will continue playing until they are stopped in the MOD music. When setting the position in bytes, the BPM, speed and global volume are updated to what they would normally be at the new position. Otherwise they are left as they were prior to the position change, unless the seek position is 0 (the start), in which case they are also reset to the starting values (with the BASS_MUSIC_POSRESET flag). When the BASS_MUSIC_POSRESETEX flag is active, the BPM, speed and global volume are reset with every seek. The BASS_MUSIC_POSRESETEX flag (or seeking to position 0) also resets channel volume and panning to defaults.

For MP3/MP2/MP1 streams, unless the file is scanned via the BASS_POS_SCAN flag or the BASS_STREAM_PRESCAN flag at stream creation, seeking will be approximate but generally still quite accurate. Besides scanning, exact seeking can also be achieved with the BASS_POS_DECODETO flag.

Seeking in internet file (and "buffered" user file) streams is possible once the download has reached the requested position, so long as the file is not being streamed in blocks (BASS_STREAM_BLOCK flag).

The BASS_POS_RESET flag can be used to reset/flush a buffered user file stream, so that new data can be processed, but it may not be supported by some decoders. When it is not supported, BASS_StreamCreateFileUser can be used again instead to create a new stream for the new data.

User streams (created with BASS_StreamCreate) are not seekable, but it is possible to reset a user stream (including its buffer contents) by setting its position to byte 0.

The BASS_POS_DECODETO flag can be used to seek forwards in streams that are not normally seekable, like custom streams or internet streams that are using the BASS_STREAM_BLOCK flag, but it will only go as far as what is currently available; it will not wait for more data to be downloaded, for example.

In some cases, particularly when the BASS_POS_INEXACT flag is used, the new position may not be what was requested. BASS_ChannelGetPosition can be used to confirm what the new position actually is.

The BASS_POS_SCAN flag works the same way as the BASS_StreamCreateFile BASS_STREAM_PRESCAN flag, and can be used to delay the scanning until after the stream has been created. When a position beyond the end is requested, the call will fail (BASS_ERROR_POSITION error code) but the seek table and exact length will have been scanned. When a file has been scanned, all seeking (even without the BASS_POS_SCAN flag) within the scanned part of it will use the scanned infomation.

When looping is enabled, the BASS_POS_LOOP and BASS_POS_END modes can be used to set custom loop start and end points in bytes. Non-byte position (eg. BASS_POS_MUSIC_ORDER) custom looping is also possible by setting a "mixtime" sync at the loop end position via BASS_ChannelSetSync and then seeking to the loop start position in the SYNCPROC callback.

Example

Set the position of a channel to 1000000 bytes.

BASS_ChannelSetPosition(channel, 1000000, BASS_POS_BYTE);

Set the position of a MOD music to row 20 of order 10, and stop all currently playing notes.