.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "pods::SDL::Mixer::Groups 3pm"
.TH pods::SDL::Mixer::Groups 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
SDL::Mixer::Groups \- Audio channel group functions
.SH CATEGORY
.IX Header "CATEGORY"
Mixer
.SH METHODS
.IX Header "METHODS"
.SS reserve_channels
.IX Subsection "reserve_channels"
.Vb 1
\& my $reserved = SDL::Mixer::Groups::reserve_channels( $num );
.Ve
.PP
\&\f(CW$num\fR is the number of channels to reserve from default mixing. Zero removes all reservations.
.PP
Reserve \f(CW$num\fR channels from being used when playing samples when passing in \f(CW\-1\fR as a channel number to playback functions. 
The channels are reserved starting from channel \f(CW0\fR to \f(CW\*(C`$num\-1\*(C'\fR. Passing in zero will unreserve all channels. Normally SDL_mixer starts 
without any channels reserved.
.PP
The following functions are affected by this setting:
.IP \(bu 4
SDL::Mixer::Channels::play_channel
.IP \(bu 4
SDL::Mixer::Channels::play_channel_timed
.IP \(bu 4
SDL::Mixer::Channels::fade_in_channel
.IP \(bu 4
SDL::Mixer::Channels::fade_in_channel_timed
.PP
Returns: The number of channels reserved. Never fails, but may return less channels than you ask for, depending on the number of channels 
previously allocated (see SDL::Mixer::Channels::allocate_channels).
.SS group_channel
.IX Subsection "group_channel"
.Vb 1
\& my $grouped = SDL::Mixer::Groups::group_channel( $channel, $group );
.Ve
.PP
Add a channel to group id (any positive integer), or reset it's group to the default group by passing (\-1).
.PP
Returns: \fBTrue\fR\|(1) on success. \fBFalse\fR\|(0) is returned when the channel specified is invalid.
.SS group_channels
.IX Subsection "group_channels"
.Vb 1
\& my $grouped = SDL::Mixer::Groups::group_channels( $from_channel, $to_channel, $group );
.Ve
.PP
Add a range of channels to group id (any positive integer), or reset their group to the default group by passing (\-1).
.PP
Returns: The number of affected channels.
.SS group_available
.IX Subsection "group_available"
.Vb 1
\& my $channel = SDL::Mixer::Groups::group_count( $group );
.Ve
.PP
\&\f(CW\*(C`group_newer\*(C'\fR returns the first available channel of this group.
.SS group_count
.IX Subsection "group_count"
.Vb 1
\& my $channels = SDL::Mixer::Groups::group_count( $group );
.Ve
.PP
\&\f(CW\*(C`group_newer\*(C'\fR returns the number of channels in this group.
.SS group_oldest
.IX Subsection "group_oldest"
.Vb 1
\& my $channel = SDL::Mixer::Groups::group_oldest( $group );
.Ve
.PP
\&\f(CW\*(C`group_newer\*(C'\fR returns the channel number which started to play at first.
.SS group_newer
.IX Subsection "group_newer"
.Vb 1
\& my $channel = SDL::Mixer::Groups::group_newer( $group );
.Ve
.PP
\&\f(CW\*(C`group_newer\*(C'\fR returns the channel number which started to play at last.
.SS fade_out_group
.IX Subsection "fade_out_group"
.Vb 1
\& SDL::Mixer::Groups::fade_out_group( $group, $ms );
.Ve
.PP
Fades out the channels by the given group id. The fade-out-time is specified by \f(CW$ms\fR.
.PP
Returns the number of affected channels.
.SS halt_group
.IX Subsection "halt_group"
.Vb 1
\& SDL::Mixer::Groups::hals_group( $group );
.Ve
.PP
Halts the channels by the given group id.
.PP
Returns \f(CW0\fR.
.SH AUTHORS
.IX Header "AUTHORS"
See "AUTHORS" in SDL.