Contents | Index | < Browse | Browse >
Command:
name,success = GetSampleName num
Description:
Get the samplename from the sample number "num". If the number is out
of range then success will be 1, and name will contain crap.
The range of numbers could vary from moduleformat to moduleformat.
Input:
num - the number of the sample from which you want the name.
Result:
name - the samplename
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 = Savesample num filename
Description:
Saves the sample "number" with the name "filename". This returns an
error if the sample number is out of range or the size is 0.
Input:
num - the samplenumber
filename - the name you want the sample to.
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:
StopSample
Description:
Stops the playing sample.
Input:
None
Result:
None
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Command:
success = PlaySample {i}num note
Description:
Play the sample "num" with the note "note". The "num" value can be
between 1 and the max number of samples the player can handle. The
"note" value can be between 0 and 35. 0 means C-1 and 35 means B-3. If
the current player can't play the sample, an error will be returned.
Input:
num - the samplenumber
note - the note number
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.