/usr/lib/perl5/pods/SDL/Mixer/Groups.pod is in libsdl-perl 2.540-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 | =pod
=head1 NAME
SDL::Mixer::Groups - Audio channel group functions
=head1 CATEGORY
Mixer
=head1 METHODS
=head2 reserve_channels
my $reserved = SDL::Mixer::Groups::reserve_channels( $num );
C<$num> is the number of channels to reserve from default mixing. Zero removes all reservations.
Reserve C<$num> channels from being used when playing samples when passing in C<-1> as a channel number to playback functions.
The channels are reserved starting from channel C<0> to C<$num-1>. Passing in zero will unreserve all channels. Normally SDL_mixer starts
without any channels reserved.
The following functions are affected by this setting:
=over 4
=item *
L<SDL::Mixer::Channels::play_channel|SDL::Mixer::Channels/"play_channel">
=item *
L<SDL::Mixer::Channels::play_channel_timed|SDL::Mixer::Channels/"play_channel_timed">
=item *
L<SDL::Mixer::Channels::fade_in_channel|SDL::Mixer::Channels/"fade_in_channel">
=item *
L<SDL::Mixer::Channels::fade_in_channel_timed|SDL::Mixer::Channels/"fade_in_channel_timed">
=back
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 L<SDL::Mixer::Channels::allocate_channels|SDL::Mixer::Channels/"allocate_channels">).
=head2 group_channel
my $grouped = SDL::Mixer::Groups::group_channel( $channel, $group );
Add a channel to group id (any positive integer), or reset it's group to the default group by passing (-1).
Returns: True(1) on success. False(0) is returned when the channel specified is invalid.
=head2 group_channels
my $grouped = SDL::Mixer::Groups::group_channels( $from_channel, $to_channel, $group );
Add a range of channels to group id (any positive integer), or reset their group to the default group by passing (-1).
Returns: The number of affected channels.
=head2 group_available
my $channel = SDL::Mixer::Groups::group_count( $group );
C<group_newer> returns the first available channel of this group.
=head2 group_count
my $channels = SDL::Mixer::Groups::group_count( $group );
C<group_newer> returns the number of channels in this group.
=head2 group_oldest
my $channel = SDL::Mixer::Groups::group_oldest( $group );
C<group_newer> returns the channel number which started to play at first.
=head2 group_newer
my $channel = SDL::Mixer::Groups::group_newer( $group );
C<group_newer> returns the channel number which started to play at last.
=head2 fade_out_group
SDL::Mixer::Groups::fade_out_group( $group, $ms );
Fades out the channels by the given group id. The fade-out-time is specified by C<$ms>.
Returns the number of affected channels.
=head2 halt_group
SDL::Mixer::Groups::hals_group( $group );
Halts the channels by the given group id.
Returns C<0>.
=head1 AUTHORS
See L<SDL/AUTHORS>.
=cut
|