DemoGL::Reference::Functions::DEMOGL_SoundSystemStopChannel

DEMOGL_SoundSystemStopChannel

DEMOGL_SoundSystemStopChannel kills the given channel. The play of the channel will be stopped and the ChannelCodeID and ChannelScriptID will be invalid after a call to DEMOGL_SoundSystemStopChannel. The channel can't be continued later, the element should be started again. 

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

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 stop 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_SoundSystemStartElement, _SOUNDSYSTEM commands

Last changed on 18-jan-2001

©1999-2001 Solutions Design