pods::SDL::CD(3pm)

💿 NAME 💿

okay bestie, you're on the pods::SDL::CD(3pm) page — the User Contributed Perl Documentation moment for this absolute icon: SDL::CD -- SDL Bindings for structure SDL_CD. periodt 💅

🏷️ CATEGORY 🏷️

Core, CDROM, Structure

✨ SYNOPSIS ✨

here's the whole starter-pack vibe in code, no cap:

use SDL;
use SDL::CDROM;
use SDL::CD;

SDL::init(SDL_INIT_CDROM);

my $drives = SDL::CDROM::num_drives;

if( $drives > 0 )
{
 my $CD = SDL::CD->new( 0 );

  if($CD)
  {
       ...
  }

}

🎀 CONSTANTS 🎀

the constants are exported by default, bestie. you can avoid this by doing:

use SDL::CD ();

and access them directly like this:

SDL::CD::CD_TRAYEMPTY;

or by choosing the export tags below 🫶

📦 Export tag: ':status' 📦

• CD_TRAYEMPTY
• CD_STOPPED
• CD_PLAYING
• CD_PAUSED
• CD_ERROR

📦 Export tag: ':defaults' 📦

• CD_FPS
• SDL_MAX_TRACKS

🛠️ METHOD 🛠️

🍓 new 🍓

my $CD = SDL::CD->new($drive)

makes a new SDL::CD object. returns undef if the drive is busy or inaccessible 😭

🦋 status 🦋

my $status = $CD->status();

returns the current status of the CD tray — and it's gonna be one of these constants:

• CD_TRAYEMPTY
• CD_STOPPED
• CD_PLAYING
• CD_PAUSED
• CD_ERROR

🌸 play_tracks 🌸

$CD->play_tracks($start_track, $start_frame, $ntracks, $nframes)

plays the given SDL::CD starting at track $start_track, for $ntracks tracks.

$start_frame is the frame offset, from the beginning of the $start_track, at which to start. $nframes is the frame offset, from the beginning of the last track ($start_track+$ntracks), at which to end playing.

play_tracks() should only be called after calling status to get information about the CD — no skipping the vibe check, bestie 🫶

Note: Data tracks are ignored.

returns 0, or -1 if there was an error.

🔥 play 🔥

$CD->play($start, $length);

plays the given SDL::CD, starting a frame $start for $length frames.

returns 0 on success, -1 on error.

💜 pause 💜

$CD->pause();

pauses play on CD.

returns 0 on success, or -1 on an error.

🌈 resume 🌈

$CD->resume();

returns 0 on success, or -1 on an error. that's the whole note on this one, bestie 💅

⭐ stop ⭐

$CD->stop();

stops play on the CD.

returns 0 on success, or -1 on an error.

🧚 eject 🧚

$CD->eject();

ejects the CD.

returns 0 on success, or -1 on an error.

👑 id 👑

$CD->id();

private drive identifier.

🍓 num_tracks 🍓

$CD->num_tracks();

number of tracks on the CD.

🦋 cur_track 🦋

$CD->cur_track();

current track on the CD;

🌸 track 🌸

my $track =  $CD->track($number);

retrieves track description of track $number in CD. see SDL::CDTrack.

🎀 FRAMES_TO_MSF 🎀

my ($min, $sec, $fra) = FRAMES_TO_MSF($frames);

conversion functions from frames to Minute/Second/Frames.

✨ MSF_TO_FRAMES ✨

my $frames = MSF_TO_FRAMES($min, $sec, $fra);

that's the whole note for this one too — just the signature, bestie 😌

👀 SEE ALSO 👀

• SDL::CDROM
• SDL::CDTrack

💖 AUTHORS 💖

See "AUTHORS" in SDL.

---

mwah 💋 — this iconic page is from perl v5.42.0, dated 2024-05-01, and it's the pods::SDL::CD(3pm) manual page. bye bestie! 🎀