PROGRAMMER'S GUIDEStream system library
BackForward
Stream system library

7. Function specifications-2


7.2 Stream group


 List
 Title

Function specifications

 Function

Opening a stream group

 Function Name

STM_OpenGrp

 No

2.1

Form
StmGrpHn STM_OpenGrp (void)
input
none
output
none
Function value
NULL for stream group handle error
function
Open the stream group.

 List
 Title

Function specifications

 Function

Stream group close

 Function Name

STM_CloseGrp

 No

2.2

Form
void STM_CloseGrp (StmGrpHn grp)
input
grp: stream group handle
output
none
Function value
none
function
Close the stream group.
remarks
All streams that belong to the stream group are closed.

 List
 Title

Function specifications

 Function

Get the number of streams

 Function Name

STM_GetStmNum

 No

2.3

Form
Sint32 STM_GetStmNum (StmGrpHn grp)
input
grp: stream group handle
output
none
Function value
The number of streams that belong to the stream group.
function
Gets the number of streams that belong to the specified stream group.

 List
 Title

Function specifications

 Function

Get stream handle

 Function Name

STM_GetStmHndl

 No

2.4

Form
StmHn STM_GetStmHndl (StmGrpHn grp, Sint32 nstm)
input
 grp
 : Stream group handle
 nstm
 : Playback sequence number (0 ≤ nstm <STM_GetStmNum)
output
none
Function value
Stream handle with the specified playback sequence number.
NULL if there is no corresponding stream.
function
Gets the handle of a stream that belongs to the specified stream group.
remarks
If the following four streams belong to the same stream group, the playback order numbers will be in the order of streams A, B, C, and D.

 List
 Title

Function specifications

 Function

Registration of buffer size monitoring function

 Function Name

STM_SetCdbufFunc

 No

2.5

Form
void STM_SetCdbufFunc (StmGrpHn grp, StmHn stm, Sint32 nsct, StmCdbufFunc func, void * obj)
input
 grp
 : Stream group handle
 stm
 : Stream handle (STM_CDBUF_REST when checking for free sectors)
 nsct
 : Number of sectors
 func
 : Buffer size monitoring function (STM_CDBUF_NULLFUNC when canceling)
 obj
 : Registered object
output
none
Function value
none
function
Registers the buffer size monitoring function for the specified stream group. The registration function is called under the following conditions.
 value of stm
 Conditions under which the monitoring function func is called
 Normal stream handle
 Stream data in CD buffer> nsct
 STM_CDBUF_REST
 Free space in the CD buffer ≤ nsct
remarks

  1. The registration function has the following format:
    void (* StmCdbufFunc) (void * obj)

  2. The registration object is passed as the first argument of the registration function.


BackForward
PROGRAMMER'S GUIDEStream system library
Copyright SEGA ENTERPRISES, LTD., 1997