Location: PHPKode > scripts > MP3 Jukebox > mp3-jukebox/docs/mp3_filelist.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>mp3_filelist</title>
<link rel="stylesheet" href="pod.css" type="text/css" />
<link rev="made" href="mailto:" />
</head>

<body>
<table border="0" width="100%" cellspacing="0" cellpadding="3">
<tr><td class="block" valign="middle">
<big><strong><span class="block">&nbsp;mp3_filelist</span></strong></big>
</td></tr>
</table>

<p><a name="__index__"></a></p>
<!-- INDEX BEGIN -->

<ul>

	<li><a href="#mp3_filelist">mp3_filelist</a></li>
	<ul>

		<li><a href="#dogma__constants_and_variables_">DOGMA (Constants and Variables)</a></li>
		<ul>

			<li><a href="#_string__mp3_filelist__mp3_dir">(string) mp3_filelist::MP3_DIR</a></li>
			<li><a href="#_string__mp3_filelist__lb">(string) mp3_filelist::LB</a></li>
			<li><a href="#_string__mp3_filelist__mp3_list">(string) mp3_filelist::MP3_LIST</a></li>
			<li><a href="#_string__mp3_filelist__mp3_last">(string) mp3_filelist::MP3_LAST</a></li>
			<li><a href="#_array__mp3_filelist__raw_filelist">(array) mp3_filelist::raw_filelist</a></li>
			<li><a href="#_array__mp3_filelist__old_filelist">(array) mp3_filelist::old_filelist</a></li>
			<li><a href="#_array__mp3_filelist__filelist">(array) mp3_filelist::filelist</a></li>
		</ul>

		<li><a href="#ritual__methods_">RITUAL (Methods)</a></li>
		<ul>

			<li><a href="#_void__mp3_filelist__create_raw_filelist__">(void) mp3_filelist::create_raw_filelist()</a></li>
			<li><a href="#_void__mp3_filelist__create_new_filelist__">(void) mp3_filelist::create_new_filelist()</a></li>
		</ul>

	</ul>

</ul>
<!-- INDEX END -->

<hr />
<p>
</p>
<h1><a name="mp3_filelist">mp3_filelist</a></h1>
<p>This class provides some methods for handling playlists when setting up online radio. 
It's a helper class for <a href='mp3_radio.html'>mp3_radio</a>.</p><p>
</p>
<h2><a name="dogma__constants_and_variables_">DOGMA (Constants and Variables)</a></h2>
<p>
</p>
<h3><a name="_string__mp3_filelist__mp3_dir">(string) mp3_filelist::MP3_DIR</a></h3>
<p>The name of the directory, where the music in mp3 format resides.</p>
<p>
</p>
<h3><a name="_string__mp3_filelist__lb">(string) mp3_filelist::LB</a></h3>
<p>The format of the line-break. Could be ``\r\n'' for win32, ``\n'' for Unix/Linux or ``\r'' (Mac).</p>
<p>
</p>
<h3><a name="_string__mp3_filelist__mp3_list">(string) mp3_filelist::MP3_LIST</a></h3>
<p>The name of the playlist file.</p>
<p>
</p>
<h3><a name="_string__mp3_filelist__mp3_last">(string) mp3_filelist::MP3_LAST</a></h3>
<p>The name of the file storing last served filename.</p>
<p>
</p>
<h3><a name="_array__mp3_filelist__raw_filelist">(array) mp3_filelist::raw_filelist</a></h3>
<p>List of all the files residing in the mp3_filelist::MP3_DIR directory when the request came.</p>
<p>
</p>
<h3><a name="_array__mp3_filelist__old_filelist">(array) mp3_filelist::old_filelist</a></h3>
<p>Old filelist</p>
<p>
</p>
<h3><a name="_array__mp3_filelist__filelist">(array) mp3_filelist::filelist</a></h3>
<p>New filelist. See the description of the mp3_filelist::create_new_filelist method</p>
<p>
</p>
<h2><a name="ritual__methods_">RITUAL (Methods)</a></h2>
<p>
</p>
<h3><a name="_void__mp3_filelist__create_raw_filelist__">(void) mp3_filelist::create_raw_filelist()</a></h3>
<p>Creates a list of all music files currently in the mp3_filelist::MP3_DIR directory. Now working
only with the mp3 files.</p>
<p>
</p>
<h3><a name="_void__mp3_filelist__create_new_filelist__">(void) mp3_filelist::create_new_filelist()</a></h3>
<p>Opens old filelist from the mp3_filelist::MP3_LIST file, then compares it to the 
mp3_filelist::raw_filelist. Places the intersection at the beginning and appends 
to its end a list of files added since previous call. This creates FIFO-like
queue of mp3's. Then saves it.

</p>
<table border="0" width="100%" cellspacing="0" cellpadding="3">
<tr><td class="block" valign="middle">
<big><strong><span class="block">&nbsp;mp3_filelist</span></strong></big>
</td></tr>
</table>

</body>

</html>
Return current item: MP3 Jukebox