pods::...Groups(3pm)

🌸 NAME 🌸

okay bestie, welcome to pods::...Groups(3pm) β€” a User Contributed Perl Documentation page, no cap. The actual title is SDL::Mixer::Groups - Audio channel group functions, and it's giving audio-channel-group main character energy. πŸ’–βœ¨

πŸŽ€ CATEGORY πŸŽ€

Mixer β€” that's the vibe check, periodt. πŸŽšοΈπŸ¦‹

πŸ’… METHODS πŸ’…

✨ reserve_channels ✨

my $reserved = SDL::Mixer::Groups::reserve_channels( $num );

So $num is literally the number of channels you're reserving from default mixing. Zero removes all reservations. 🌸

The way this works: reserve $num channels so they won't be used when playing samples if you pass in -1 as a channel number to playback functions. The channels are reserved starting from channel 0 to $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:

  • SDL::Mixer::Channels::play_channel
  • SDL::Mixer::Channels::play_channel_timed
  • SDL::Mixer::Channels::fade_in_channel
  • SDL::Mixer::Channels::fade_in_channel_timed

Returns: the number of channels reserved. It never fails, but it may return less channels than you ask for, depending on the number of channels previously allocated (see SDL::Mixer::Channels::allocate_channels). πŸ’œ

✨ group_channel ✨

my $grouped = SDL::Mixer::Groups::group_channel( $channel, $group );

Add a channel to a group id (any positive integer), or reset its group to the default group by passing (-1). πŸŽ€

Returns: True(1) on success. False(0) is returned when the channel specified is invalid. Ngl, that's a clean little true/false moment. πŸ’…

✨ group_channels ✨

my $grouped = SDL::Mixer::Groups::group_channels( $from_channel, $to_channel, $group );

Add a range of channels to a group id (any positive integer), or reset their group to the default group by passing (-1). ✨

Returns: the number of affected channels. Slay. πŸ¦‹

✨ group_available ✨

my $channel = SDL::Mixer::Groups::group_count( $group );

okay so the description literally says: "group_newer" returns the first available channel of this group. Bestie, I'm not fixing the source β€” I'm just reporting exactly what's on the page. πŸ™ˆ

✨ group_count ✨

my $channels = SDL::Mixer::Groups::group_count( $group );

The description literally says: "group_newer" returns the number of channels in this group. Same quoted-function-name situation, fr fr. πŸ“

✨ group_oldest ✨

my $channel = SDL::Mixer::Groups::group_oldest( $group );

The description literally says: "group_newer" returns the channel number which started to play at first. πŸŽ€

✨ group_newer ✨

my $channel = SDL::Mixer::Groups::group_newer( $group );

The description literally says: "group_newer" returns the channel number which started to play at last. Iconic consistency, lowkey. πŸ’–

✨ 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 $ms. 🧚

Returns: the number of affected channels. 🌈

✨ halt_group ✨

SDL::Mixer::Groups::hals_group( $group );

Halts the channels by the given group id. πŸ›‘

Returns 0.

Heads up, bestie: the synopsis above literally says SDL::Mixer::Groups::hals_group( $group ); β€” yes, hals. I'm keeping it exactly as the page has it. Not me being tempted to "fix" it. πŸ˜­πŸ’€

🫢 AUTHORS 🫢

It says, literally: See "AUTHORS" in SDL. iykyk. πŸ‘‘


okay that's the whole page, bestie πŸ’– this little number is from perl v5.42.3, dated 2026-08-19, and it's the pods::...Groups(3pm) page β€” mwah! πŸ’‹βœ¨

πŸ“¦ where this page comes from