docs for SDL::Mixer::Samples

[sdlgit/SDL-Site.git] / pages / SDL-old-cdrom.html-inc

<div class="pod">
<!-- INDEX START -->
<h3 id="TOP">Index</h3>

<ul><li><a href="#NAME">NAME</a></li>
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#EXPORTS">EXPORTS</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#METHODS">METHODS</a>
<ul><li><a href="#cd_num_drives">cd_num_drives()</a></li>
<li><a href="#name_cd">name(cd)</a></li>
<li><a href="#status_cd">status(cd)</a></li>
<li><a href="#play_cd_start_length_fs_fl">play(cd,start,length,fs,fl) </a></li>
<li><a href="#pause_cd">pause(cd)</a></li>
<li><a href="#resume_cd">resume(cd)</a></li>
<li><a href="#stop_cd">stop(cd)</a></li>
<li><a href="#eject_cd">eject(cd)</a></li>
<li><a href="#id_cd">id(cd)</a></li>
<li><a href="#num_tracks_cd">num_tracks(cd)</a></li>
<li><a href="#track_cd_number">track(cd,number)</a></li>
<li><a href="#current_cd">current(cd)</a></li>
<li><a href="#current_frame_cd">current_frame(cd)</a></li>
</ul>
</li>
<li><a href="#AUTHORS">AUTHORS</a></li>
<li><a href="#SEE_ALSO">SEE ALSO</a>
</li>
</ul><hr />
<!-- INDEX END -->

<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="NAME_CONTENT">
<p>SDL::Cdrom - a SDL perl extension for managing CD-ROM drives</p>

</div>
<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="SYNOPSIS_CONTENT">
<pre>	use SDL::Cdrom;
	$cdrom = SDL::Cdrom-&gt;new(0);
	$cdrom-&gt;play();

</pre>

</div>
<h1 id="EXPORTS">EXPORTS</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="EXPORTS_CONTENT">
<ul>
		<li><code>cd_num_drives</code>.</li>
</ul>


</div>
<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="DESCRIPTION_CONTENT">
<p>Create a new SDL::Cdrom object. The passed $id is the number of the drive,
whereas 0 is the first drive etc.</p>
<pre>	use SDL::Cdrom;
	my $drive =&gt; SDL::Cdrom-&gt;new($id);

</pre>

</div>
<h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="METHODS_CONTENT">

</div>
<h2 id="cd_num_drives">cd_num_drives()</h2>
<div id="cd_num_drives_CONTENT">
<p>Returns the number of CD-ROM drives present.</p>

</div>
<h2 id="name_cd">name(cd)</h2>
<div id="name_cd_CONTENT">
<p>Returns the system dependent name of the CD-ROM device.
It takes a SDL::Cdrom as first parameter.</p>

</div>
<h2 id="status_cd">status(cd)</h2>
<div id="status_cd_CONTENT">
<p>Return the status of the drive.
It takes a SDL::Cdrom as first parameter.</p>

</div>
<h2 id="play_cd_start_length_fs_fl">play(cd,start,length,fs,fl) </h2>
<div id="play_cd_start_length_fs_fl_CONTENT">
<p>Play a track from the SDL::Cdrom given as first parameter, second parameter is the frame to start, the third is the lenght to play.
It returns 1 on succés 0 on error.</p>

</div>
<h2 id="pause_cd">pause(cd)</h2>
<div id="pause_cd_CONTENT">
<p>Pause the playing of the SDL::Cdrom given as first parameter.
It returns 1 on succés 0 on error.</p>

</div>
<h2 id="resume_cd">resume(cd)</h2>
<div id="resume_cd_CONTENT">
<p>Resume the playing of the SDL::Cdrom given as first parameter.
It returns 1 on succés 0 on error.</p>

</div>
<h2 id="stop_cd">stop(cd)</h2>
<div id="stop_cd_CONTENT">
<p>Stop the playing of the SDL::Cdrom given as first parameter.
It returns 1 on succés 0 on error.</p>

</div>
<h2 id="eject_cd">eject(cd)</h2>
<div id="eject_cd_CONTENT">
<p>Eject the medium in the SDL::Cdrom given as first parameter.
It returns 1 on succés 0 on error.</p>

</div>
<h2 id="id_cd">id(cd)</h2>
<div id="id_cd_CONTENT">
<p>Return the ID of the drive given as first parameter.</p>

</div>
<h2 id="num_tracks_cd">num_tracks(cd)</h2>
<div id="num_tracks_cd_CONTENT">
<p>Return the number of tracks on the SDL::Cdrom given as first parameter.</p>

</div>
<h2 id="track_cd_number">track(cd,number)</h2>
<div id="track_cd_number_CONTENT">
<p>Returns the track description of the track given as second parameter.
the first parameter is a SDL:Cdrom.</p>

</div>
<h2 id="current_cd">current(cd)</h2>
<div id="current_cd_CONTENT">
<p>Return the current played track number given as first parameter.</p>

</div>
<h2 id="current_frame_cd">current_frame(cd)</h2>
<div id="current_frame_cd_CONTENT">
<p>Return the current frame given as first parameter.</p>

</div>
<h1 id="AUTHORS">AUTHORS</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="AUTHORS_CONTENT">
<p>David J. Goehrig
Documentation by Tels &lt;http://bloodgate.com/&gt;.</p>

</div>
<h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="SEE_ALSO_CONTENT">
<p><a href="http://search.cpan.org/perldoc?perl">perl</a> <a href="/SDL-Mixer.html">SDL::Mixer</a> <a href="/SDL-App.html">SDL::App</a>.</p>

</div>
</div>