* * HELP & MANUAL PREMIUM PACK 4 DEMO VERSION * *
This documentation was styled with a demo skin from the Premium Pack 4 add-on for Help & Manual. The contents of the skin are encrypted and not configurable. You can only publish HM projects with this skin. You cannot edit it or change it.
This version is copyright and may only be used for local testing purposes. It may not be distributed.
Please purchase the full version of the Premium Pack to get the configurable skins and remove this notice. The package will also include the Toolbox configuration utility for Premium Pack skins.
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
