Sound (SND) API Function List

Initialization

SND_Init Initializes Sound.

ARM7 Command Processes

SND_FlushCommand This function issues reserved commands.
SND_RecvCommandReply Receives the command process reply.
SND_WaitForCommandProc Waits for command processes to end.
SND_WaitForFreeCommand Waits until free commands are available.
SND_GetCurrentCommandTag Gets the current command tag.
SND_IsFinishedCommandTag Checks whether command process has ended.
SND_CountFreeCommand This function gets the number of free commands.
SND_CountReservedCommand This function gets the number of reserved commands.
SND_CountWaitingCommand This function gets the number of commands that wait for processing to end.

Sequence Commands

SND_StartSeq Plays sequence.
SND_PrepareSeq Prepares the sequence for playback.
SND_StartPreparedSeq Plays a sequence that has been prepared for playback.
SND_StopSeq Stops sequence.
SND_PauseSeq Pauses sequence or re-starts sequence.
SND_SetPlayerVolume Changes the player volume.
SND_SetPlayerTempoRatio Changes the tempo of the sequence.
SND_SetPlayerChannelPriority Changes the sound priority of the Player.
SND_SetPlayerLocalVariable Sets the Player local variable.
SND_SetPlayerGlobalVariable Sets the Player global variable.
SND_SetTrackMute Mutes tracks.
SND_SetTrackVolume Changes the volume of tracks.
SND_SetTrackPitch Changes the pitch of tracks.
SND_SetTrackPan Changes the pan of tracks.
SND_SetTrackPanRange Changes the track pan range.
SND_SetTrackModDepth Changes the modulation depth of tracks.
SND_SetTrackModSpeed Changes the modulation speed of tracks.
SND_SetTrackAllocatableChannel Changes the channel that can be allocated for the track.

Channel Commands

SND_LockChannel This function locks channels so they can be directly controlled.
SND_UnlockChannel Unlocks locked channels.
SND_StopUnlockedChannel Stops the unlocked channel.
SND_SetupChannelPcm This function sets up channels for PCM playback.
SND_SetupChannelPsg Sets up channels for PSG rectangular waveform playback.
SND_SetupChannelNoise This function sets up a channel for playing white noise.
SND_SetChannelVolume Changes the channel volume.
SND_SetChannelTimer Changes the channel timer.
SND_SetChannelPan Changes the channel pan.

Capture Commands

SND_SetupCapture Sets up captures.

Alarm Commands

SND_SetupAlarm This function sets up the Sound alarm.

Timer Commands

SND_StartTimer Starts timers.
SND_StopTimer Stops timers.

Global Settings Commands

SND_SetMasterVolume Changes the master volume.
SND_SetMasterPan Sets the master pan.
SND_ResetMasterPan Disables the master pan.
SND_SetOutputSelector Changes the output selector.

Data Invalidation Commands

SND_InvalidateSeqData Invalidates sequence data.
SND_InvalidateBankData Invalidates bank data.
SND_InvalidateWaveData Invalidates waveform data.

Driver Information Commands

SND_ReadDriverInfo Obtains sound driver information.

Banks

SND_AssignWaveArc Assigns Waveform Archives to banks.
SND_DestroyBank Destroys banks.
SND_DestroyWaveArc Destroys Waveform Archives.
SND_ReadInstData Reads instruments from banks.
SND_WriteInstData Updates the instrument data in banks.
SND_GetFirstInstDataPos Obtains the location information for scanning instrument data.
SND_GetNextInstData Obtains the instrument data in order.
SND_GetWaveDataCount Gets the amount of waveform data in the waveform archive.
SND_GetWaveDataAddress Gets the address of the waveform data in the waveform archive.
SND_SetWaveDataAddress Updates the address of the waveform data in the waveform archive.
SNDInstData The instrument data structure.
SNDWaveData Waveform data structure.

Get Information

SND_GetPlayerStatus Gets the status of the Players, showing whether they are active or not.
SND_GetChannelStatus Gets the status of the channels, showing whether they are active or not.
SND_GetCaptureStatus This function uses a return value to determine whether a sound capture is active.
SND_GetPlayerLocalVariable Gets the sequence local variable.
SND_GetPlayerGlobalVariable Gets the sequence global variable.
SND_GetPlayerTickCounter Gets the Player tick counter.
SND_ReadChannelInfo Gets the channel information.
SND_ReadPlayerInfo Gets the player information.
SND_ReadTrackInfo Gets the track information.
SNDChannelInfo This is the channel information structure.
SNDPlayerInfo This is the player information structure.
SNDTrackInfo This is the track information structure.

Utilities

SND_CalcDecibel Calculates the decibel value.
SND_CalcDecibelSquare Calculates the decibel value corresponding to square of scale value.
SND_CalcTimer Calculates the timer value after pitch conversion.
SND_CalcChannelVolume Calculates the value for the channel volume.