DemoGL::Reference::Functions::DEMOGL_SoundSystemPauseChannel

DEMOGL_SoundSystemPauseChannel

DEMOGL_SoundSystemPauseChannel pauses the channel with the given ChannelCodeID. This channel can then be continued using DEMOGL_SoundSystemContinueChannel or the CONTINUE[element] script command of the _SOUNDSYSTEM object. When the channel that needs to be paused is started using a scriptcommand, you have to convert the ChannelScriptID to its ChannelCodeID first using DEMOGL_SoundSystemChannelScriptID2ChannelCodeID. Do not continue the individual paused channel using DEMOGL_SoundSystemContinueAll 

int
DEMOGL_SoundSystemPauseChannel(
	const int iChannelCodeID
);
Parameters.
iChannelCodeID
Specifies the ChannelCodeID of the channel which should be paused.

Return values.
If the function succeeds, it returns SYS_OK.
If the function fails, it returns one of the following error codes:

Error code Description
DGL_SS_ERR_CHANNELACTIONFAILED The underlying sound library reported an error while processing the pause command.
DGL_SS_ERR_CHANNELNOTINUSE The iChannelCodeID value is not found as an active channel.
DGL_SS_ERR_ILLEGALELEMENTTYPE The channel specified is playing data belonging to an element of an unknown type. This is caused by an implementation error. Should not happen.

Remarks.

Example.

Requirements.
DemoGL v1.3 (build 0112 or higher)

See also.
DEMOGL_SoundSystemContinueChannel, DEMOGL_SoundSystemChannelScriptID2ChannelCodeID, _SOUNDSYSTEM commands

Last changed on 18-jan-2001

©1999-2001 Solutions Design