Sound Function - Sound Module Control Function

sdPstmSetVol

Sets the play volume of a PCM Stream port

FORMAT

SDE_ERR sdPstmSetVol( handle, ch_num, vol, fade_time )
SDPSTM handle
Sint8 ch_num
Sint8 vol
Sint16 fade_time

PARAMETER

 handle  Object handle 
 ch_num  Object channel 
 vol  Target volume  
 fade_time  Time to reach target volume 

RETURN

 SDE_ERR_NO_INIT  The Sound Library has not been initialized 
 SDE_ERR_HANDLE_NULL  The handle is NULL 
 SDE_ERR_HOST_CMD_BUF_NO_ENOUGH  No more host commands can be accepted 

DESCRIPTION

Sets the play volume of a PCM Stream port channel.

The range for vol, which specifies volume, is -007FH (min) to 0000H (mid) to 007FH (max).

The units for fade_time, which specifies the time needed to reach volume, are milliseconds, from 0000H (fastest) to 7FFFH (slowest).


NOTE

The left channel parameter is invalid for sdPstmSetVol, and is overwritten by this API function.

sdPstmSetVol
COPYRIGHT © SEGA ENTERPRISES, LTD., 1998,1999