Navigation:  ThinBASIC Modules > TBASS (Sound Module) > Channels >

TBASS_ChannelSetPosition

Previous pageReturn to chapter overviewNext page

 

Description

 

Sets the playback position of a sample, MOD music, or stream.

 

Syntax

 

n = TBASS_ChannelSetPosition(hChannel, Position [, Mode])

 

Returns

 

Number

If successful, %TBASS_TRUE is returned, else %TBASS_FALSE is returned. Use TBASS_ErrorGetCode to get the error code.

 

Parameters

 

Name

Type

Optional

Meaning

hChannel

Number

No

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

Position

Number

No

The position, in bytes.

Mode

Number

Yes

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

%TBASS_POS_BYTE

Default value if parameter not passed. The position is in bytes, which will be rounded down to the nearest sample boundary.

%TBASS_POS_MUSIC_ORDER

The position is in orders and rows... use MAKELNG(order,row). (HMUSIC only)

 

 

%TBASS_MUSIC_POSRESET

Stop all notes. This flag is applied automatically if it has been set on the channel, eg. via BASS_ChannelFlags. (HMUSIC)

%TBASS_MUSIC_POSRESETEX

Stop all notes and reset bpm/etc. This flag is applied automatically if it has been set on the channel, eg. via TBASS_ChannelFlags. (HMUSIC)

 

Remarks

 

Restrictions

 

See also

 

Examples