[About] - [Download] - [FAQ] - [Music Files] - [Documentation]


(Hss) Command List:

PUB start : okay
This command starts the (Hss) sound engine.
You have to issue "start" before you can issue any other commands.
This will load (Hss) into the two needed COGs and start the audio DAC.

Returns: TRUE on success or FALSE on failure.


PUB stop
This command stops the (Hss) sound engine.
You issue this command when you are done using (Hss) and want to free up COGs for other tasks.
This will stop (Hss) from using two COGs and stop the audio DAC.

Returns: none.


PUB peek(addrptr) : var1
Returns the value of a WaveTable register.
addrptr is the pointer to a specific register and can range from 0 to 52.

Returns: 32bit long.


PUB hmus_load(songptr)
Loads (Hmus) player with a song file from HUB-RAM.
This command is issued before playing a (Hmus) song.
The song file located at HUB-RAM address songptr will be loaded into the player and ready for playback.

Returns: none.


PUB hmus_play
Plays (Hmus) file that is loaded into the player.
This command is issued after hmus_load and will begin playback of the (Hmus) file.

Returns: none.


PUB hmus_stop
Stops current (Hmus) file playing.
This command is issued after hmus_play to stop and mute the playback of the (Hmus) file.
hmus_play can be issued after hmus_stop to begin playing from where the file was left off.

Returns: none.


PUB hmus_pause
Pauses current (Hmus) file playing, but doesn't mute its audio.
This command is issued after hmus_play to pause and hold the playback of the (Hmus) file.
hmus_play can be issued after hmus_pause to begin playing from where the file was left off.

Returns: none.


PUB hmus_tempo(var1)
Modifies playback tempo of current (Hmus) file.
This command is used to change the speed of playback for a (Hmus) file with the value in var1.
hmus_tempo can be used anytime after a file is loaded.

Returns: none.


PUB get_hmus_tempo : var1
Returns playback tempo of current (Hmus) file.
This command is used to read the speed of playback for a (Hmus) file.
get_hmus_tempo can be used anytime after a file is loaded.

Returns: 8bit byte (0 to 255).


PUB hmus_vol(var1)
Modifies playback volume of current (Hmus) file.
This command is used to change the volume of playback for a (Hmus) file with the value in var1.
hmus_vol can be used anytime after a file is loaded and can range from 0 to 15.

Returns: none.


PUB get_hmus_vol : var1
Returns playback volume of current (Hmus) file.
This command is used to read the volume of playback for a (Hmus) file.
get_hmus_vol can be used anytime after a file is loaded.

Returns: 4bit value (0 to 15).


PUB sfx_play(chan, soundptr)
Plays FXsynth data at address soundptr.
This command is used to playback sound FX data.
chan is used to select one of two channels to use for playback and can be either values 1 or 2.

Returns: none.


PUB sfx_stop(chan)
Stops FXsynth channel chan from playback and mute it's output.
This command is used to stop sound FX data from playing.
chan is used to select one of two channels and can be either values 1 or 2.

Returns: none.


PUB sfx_keyoff(chan)
Keys off FXsynth channel chan from playback.
This command is used to release the envelope of a SFX.
chan is used to select one of two channels and can be either values 1 or 2.

Returns: none.


PUB dpcm_play(soundptr)
Plays an ADPCM wave file at address soundptr.
This command is used to playback compressed wave samples.

Returns: none.


PUB dpcm_stop
Stops an already playing ADPCM wave file from playing.
This command is used to stop compressed wave samples.

Returns: none.