mixHaltGroup function

int mixHaltGroup(
  1. int tag
)

Halt playing of a group of channels by arbitrary tag.

This will stop further playback on all channels with a specific tag, until a new chunk is started there.

A tag is an arbitrary number that can be assigned to several mixer channels, to form groups of channels.

The default tag for a channel is -1.

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

\param tag an arbitrary value, assigned to channels, to search for. \returns zero, whether any channels were halted or not.

\since This function is available since SDL_mixer 2.0.0.

extern DECLSPEC int SDLCALL Mix_HaltGroup(int tag)

Implementation

int mixHaltGroup(int tag) {
  final mixHaltGroupLookupFunction = libSdl2Mixer.lookupFunction<
      Int32 Function(Int32 tag), int Function(int tag)>('Mix_HaltGroup');
  return mixHaltGroupLookupFunction(tag);
}