6. Function specifications / list

6.1 Function list

The following table shows a list of functions in this library.

Table 6.1 Function list

function		Function name	number
Initialization and termination processing			1.0
	Library initialization	*) PCM_Init	1.1
	Library termination process	*) PCM_Finish	1.2
	Declaration of use of ADPCM	A) PCM_DeclareUseAdpcm	1.3 1.3
	Saturn PCM usage declaration (file system)	FS) PCM_DeclareUseSapGfs	1.4
	Saturn PCM usage declaration (stream system)	SS) PCM_DeclareUseSapStm	1.5
Handle operation			2.0
	Creating a handle (memory)	M) PCM_CreateMemHandle	2.1
	Erase handle (memory)	M) PCM_DestroyMemHandle	2.2
	Creating a handle (file system)	F) PCM_CreateGfsHandle	2.3
	Erase handle (file system)	F) PCM_DestroyGfsHandle	2.4
	Creating a handle (stream system)	S) PCM_CreateStmHandle	2.5
	Erase handle (stream system)	S) PCM_DestroyStmHandle	2.6
	Play task	*) PCM_Task	2.7 2.7
	V blank IN processing function	*) PCM_VblIn	2.8
Playback control			3.0
	Start playing	E) PCM_Start	3.1 3.1
	Stop playing	PCM_Stop	3.2
	Pause	P) PCM_Pause	3.3
	Register the handle to play next	E) PCM_EntryNext	3.4 3.4
	Forced switching of play handle	PCM_Change	3.5
	Get switching status	PCM_CheckChange	3.6
	Setting the number of loop playbacks	PCM_SetLoop	3.7
Information setting function			4.0
	Setting the maximum number of transfer sectors	PCM_SetLoadNum	4.1
	Playback PAN settings	PCM_SetPan	4.2
	Playback volume setting	PCM_SetVolume	4.3
	Change PCM playback parameters	PCM_ChangePcmPara	4.4
	PCM stream playback number setting	B) PCM_SetPcmStreamNo	4.5
	Work setting for pause processing	P) PCM_SetPauseWork	4.6
	Data transfer method setting (CD block → ring buffer)	PCM_SetTrModeCd	4.7
	Playback information settings	X) PCM_SetInfo	4.8
	Setting the processing upper limit value per task	PCM_Set1TaskSample	4.9
	Playback start trigger size setting	PCM_SetStartTrgSize	4.10
	Playback start trigger sample setting	PCM_SetStartTrgSample	4.11
	Playback stop trigger sample setting	PCM_SetStopTrgSample	4.12
Information acquisition function			5.0
	Get playback time	PCM_GetTime	5.1
	Get playback status	*) PCM_GetPlayStatus	5.2.
Buffer control			6.0 6.0
	Get write buffer	m) PCM_GetWriteBuf	6.1
	Write size notification	M) PCM_NotifyWriteSize	6.2.
	File preload	PCM_PreloadFile	6.3
Error control			7.0 7.0
	Get error information	PCM_GetErr	7.1
	Error function registration	PCM_SetErrFunc	7.2

remarks

*) Required

A) Required when using ADPCM

B) Required for multi-playback

E) Either one is required

F) Required in file playback mode

M) Required in memory playback mode

m) Required when supplying data to the ring buffer in memory playback mode

P) Required when using the pause function

S) Required in stream playback mode

X) CD-ROM XA Audio Required for playback

FS) Required for Saturn PCM (file playback)

SS) Required for Saturn PCM (stream playback)