mixHaltChannel function

int mixHaltChannel(
  1. int channel
)

Halt playing of a particular channel.

This will stop further playback on that channel until a new chunk is started there.

Specifying a channel of -1 will halt all channels, except for any playing music.

Any halted channels will have any currently-registered effects deregistered, and will call any callback specified by Mix_ChannelFinished() before this function returns.

You may not specify MAX_CHANNEL_POST for a channel.

\param channel channel to halt, or -1 to halt all channels. \returns 0 on success, or -1 on error.

\since This function is available since SDL_mixer 2.0.0.

extern DECLSPEC int SDLCALL Mix_HaltChannel(int channel)

Implementation

int mixHaltChannel(int channel) {
  final mixHaltChannelLookupFunction = libSdl2Mixer.lookupFunction<
      Int32 Function(Int32 channel),
      int Function(int channel)>('Mix_HaltChannel');
  return mixHaltChannelLookupFunction(channel);
}