6.Function specifications/list

6.1 Function list

The following table lists the functions of 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 processing	*) PCM_Finish	1.2
	ADPCM usage declaration	A) PCM_DeclareUseAdpcm	1.3
	SaturnPCM usage declaration (file system)	FS) PCM_DeclareUseSapGfs	1.4
	SaturnPCM usage declaration (stream system)	SS) PCM_DeclareUseSapStm	1.5
handle operation			2.0
	Creating a handle (memory)	M) PCM_CreateMemHandle	2.1
	Erasing handles (memory)	M) PCM_DestroyMemHandle	2.2
	Creating a handle (file system)	F) PCM_CreateGfsHandle	2.3
	Clearing a handle (file system)	F) PCM_DestroyGfsHandle	2.4
	Creating a handle (stream system)	S) PCM_CreateStmHandle	2.5
	Clearing handles (stream system)	S) PCM_DestroyStmHandle	2.6
	replay task	*) PCM_Task	2.7
	V blank IN processing function	*) PCM_VblIn	2.8
playback control			3.0
	Start playing	E) PCM_Start	3.1
	Stop playing	PCM_Stop	3.2
	Pause	P) PCM_Pause	3.3
	Registering the handle to play next	E) PCM_EntryNext	3.4
	Force playback handle switching	PCM_Change	3.5
	Get switching status	PCM_CheckChange	3.6
	Setting the loop playback count	PCM_SetLoop	3.7
Information setting function			4.0
	Setting the maximum number of transferred sectors	PCM_SetLoadNum	4.1
	Playback PAN settings	PCM_SetPan	4.2
	Setting playback volume	PCM_SetVolume	4.3
	Change PCM playback parameters	PCM_ChangePcmPara	4.4
	Setting the PCM stream playback number	B) PCM_SetPcmStreamNo	4.5
	Setting the workpiece for pose processing	P) PCM_SetPauseWork	4.6
	Data transfer method setting (CD block → ring buffer)	PCM_SetTrModeCd	4.7
	Setting playback information	X) PCM_SetInfo	4.8
	Setting the processing upper limit per task	PCM_Set1TaskSample	4.9
	Setting the playback start trigger size	PCM_SetStartTrgSize	4.10
	Setting the playback start trigger sample	PCM_SetStartTrgSample	4.11
	Setting the playback stop trigger sample	PCM_SetStopTrgSample	4.12
Information retrieval function			5.0
	Get playback time	PCM_GetTime	5.1
	Get playback status	*) PCM_GetPlayStatus	5.2
buffer control			6.0
	Get write buffer	m) PCM_GetWriteBuf	6.1
	Write size notification	M) PCM_NotifyWriteSize	6.2
	Preloading files	PCM_PreloadFile	6.3
error control			7.0
	Get error information	PCM_GetErr	7.1
	Registering an error function	PCM_SetErrFunc	7.2

remarks

*) Required

A) Required when using ADPCM

B) Required for multi playback

E) One is required

F) Required when in file playback mode

M) Required when 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 when in stream playback mode

X) Required when playing CD-ROM XA Audio

FS) Required for SaturnPCM (file playback)

SS) Required for SaturnPCM (stream playback)