Contents | Index | < Browse | Browse >
Command:
author = GetAuthor
Description:
Returns the author of the current playing module. If there isn't an
author it will return unknown.
Input:
None
Result:
author - The name of the author
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
name = GetChannels
Description:
Returns the number of used channels. This is virtual channels, which
means that it can vary from 1 to 32 channels.
Input:
None
Result:
type - the number of used channels.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
num = GetCMod
Description:
Returns the current playing module number. 0 if no module is playing.
Input:
None
Result:
num - the number of the current module
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
name = GetFilename num flag
Description:
Returns the module filename. "num" is the module number in the module
list. "flag" indicates if you want path. 0 means no, 1 means yes.
Input:
num - the module number
flag - path or not (see above)
Result:
name - the filename
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
info = GetInfo
Description:
Will return a longword where each bit represent the information about
the current player. Below is a table of the bits returned.
Bit Bit
0 = Rewind 10 = Length
1 = Forward 11 = Position
2 = Pause 12 = Max Patterns
3 = Volume 13 = Show Samples
4 = Fade 14 = Play Samples
5 = Tempo 15 = Accompany
6 = Channels 16 = Force Filter Off
7 = Modulename 17 = FastMem
8 = Author 18 = Own Config
9 = SubSongs 19 = Noteplayer
Input:
None
Result:
info - a number containing the above bits
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
len = GetLength
Description:
Get the length of the current playing module. If the length isn't
available 0 will be returned.
Input:
None
Result:
len - the song length
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
max = GetMaxPatterns
Description:
Returns the number of patterns in the current playing module. If the
number of patterns isn't available 0 will be returned.
Input:
None
Result:
max - number of patterns
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
max = GetMaxSamples
Description:
Returns the max number of samples the current player can handle. If the
player can't handle any samples, 0 will be returned.
Input:
None
Result:
max - the max number of samples
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
max = GetMaxTunes
Description:
Get the max number of tunes in the current playing module. It will
return 0 if there isn't a module in memory.
Input:
None
Result:
max - the number of tunes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
rate = GetMixingRate
Description:
This get the actual mixing rate used by the used noteplayer. It will
return 0 if there isn't a module in memory or if no noteplayer, with
mixing routines, is in use.
Input:
None
Result:
rate - The mixing rate
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
name = GetName
Description:
Returns the name of the current playing module. This is not the
filename but the name of the module taken from the module. If it isn't
available it will return the filename.
Input:
None
Result:
name - the module name
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
name = GetNotePlayer
Description:
Returns the name of the current noteplayer.
Input:
None
Result:
type - the noteplayer name
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
type = GetPlayer
Description:
Returns the name of the current used player library, eg. Protracker or
Future Composer.
Input:
None
Result:
type - the player name
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
mode = GetPlayMode
Description:
Get the current playing state. The result is a boolean and 1 means
VBlank and 0 means CIA.
Input:
None
Result:
mode - the current playing state
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
pos = GetPosition
Description:
Get the current position. If the current player can't get the position,
-1 will be returned.
Input:
None
Result:
pos - the current position
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
size = GetSize
Description:
Get the filesize (unpacked) in bytes of the current playing module.
Input:
None
Result:
size - the module size
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
tune = GetTune
Description:
Get the current playing tune number.
Input:
None
Result:
tune - the current tune number
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
success = SetAuthor author
Description:
Change the author. It will return an error if no module is in memory.
Input:
author - the new author name
Result:
success - this is an error code where 0 means ok and 1 means error.
Note that the result is in RC not in RESULT.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
success = SetName name
Description:
Change the module name. It will return an error if no module is in
memory.
Input:
name - the new module name
Result:
success - this is an error code where 0 means ok and 1 means error.
Note that the result is in RC not in RESULT.