pods::...Samples(3pm)

💖 NAME 💖

okay so bestie, welcome to the pods::...Samples(3pm) page — this is User Contributed Perl Documentation for SDL::Mixer::Samples. It's literally the functions for loading sound samples. 🎧✨ No cap.

🎀 CATEGORY 🎀

Mixer — that's the category, and yes it's giving main character energy. 🌀

✨ METHODS ✨

🌸 get_num_chunk_decoders

my $num_decoders = SDL::Mixer::Samples::get_num_chunk_decoders();

Returns the number of available decoders. That's the whole vibe — count 'em and move on. 🔢

🦋 get_chunk_decoder

my $decoder = SDL::Mixer::Samples::get_chunk_decoder( $num_decoder );

Returns the decoder for the given id. You hand it the id, it hands you the decoder. periodt. 🎯

💅 load_WAV

my $mix_chunk = SDL::Mixer::Samples::load_WAV( $file );

load_WAV reads a file and passes it to SDL::Mixer::Samples::load_WAV_RW. so yeah, this is a quick way to load a file into a chunk. Lowkey iconic. 🎶

Example:

my $chunk = SDL::Mixer::Samples::load_WAV('sample.wav');

SDL::Mixer::Channels::play_channel(-1, $chunk, -1);
SDL::delay(2000);

🎧 load_WAV_RW

my $mix_chunk = SDL::Mixer::Samples::load_WAV_RW( $rwops, $free );

load_WAV_RW is a macro that loads a sound sample from a block of memory. It supports WAVE-, MOD-, MIDI-, OGG- and MP3 files (sometimes depends on compilation options). It accepts two arguments: the first is a RWops object from which to read, and the second is a flag to free the source memory after loading is complete or not. 🧠✨

Returns a Mix_Chunk containing the whole sample on success, or undef on error. Slay. 🫶

⚠️ Note: Do not reuse the RWops-object for another call to this function! Not even once, bestie. 🙈

Example:

my $rwops = SDL::RWOps->new_file('sample.wav', 'r');

my $chunk = SDL::Mixer::Samples::load_WAV_RW($rwops, 0);

SDL::Mixer::Channels::play_channel(-1, $chunk, -1);
SDL::delay(2000);

🧚 quick_load_WAV

SDL::Mixer::Samples::quick_load_WAV( $buf );

to be documented. Literally just that. 📝

🍓 quick_load_RAW

SDL::Mixer::Samples::quick_load_RAW( $buf, $len );

to be documented. Same deal, bestie. 📝

🔥 volume_chunk

my $volume_before = SDL::Mixer::Samples::volume_chunk( $chunk, $new_volume );

volume_chunk lets you set and get the volume of a chunk. When a chunk is created, its volume is MIX_MAX_VOLUME (128). 🔊

If you pass -1 as $new_volume, you just get its volume without changing it. 🎚️

👑 AUTHORS 👑

See "AUTHORS" in SDL. That's the whole section — go check the SDL AUTHORS, iykyk. 🫡

mwah 💋 — perl v5.42.0, dated 2024-05-01.