<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>Audacious: playlist-api.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Audacious
 <span id="projectnumber">$Id:Doxyfile42802007-03-2104:39:00Znenolod$</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_fdd964b4528d5f83ff8d7299f798486d.html">audacious</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">playlist-api.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="playlist-api_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * playlist-api.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2010-2012 John Lindgren</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * modification, are permitted provided that the following conditions are met:</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * 1. Redistributions of source code must retain the above copyright notice,</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * this list of conditions, and the following disclaimer.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * this list of conditions, and the following disclaimer in the documentation</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * provided with the distribution.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * This software is provided "as is" and without any warranty, express or</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * implied. In no event shall the authors be liable for any damages arising from</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * the use of this software.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/* Do not include this file directly; use playlist.h instead. */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/* Any functions in this API with a return type of (char *) return pooled</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * strings that must not be modified and must be released with str_unref() when</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * no longer needed. */</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/* --- PLAYLIST CORE API --- */</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/* Returns the number of playlists currently open. There will always be at</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * least one playlist open. The playlists are numbered starting from zero. */</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <a class="code" href="api-alias-begin_8h.html#ad02cbe226d6b54abc201f249a51877d7">AUD_FUNC0</a> (<span class="keywordtype">int</span>, <a class="code" href="playlist-new_8c.html#aaa7713b0dd18a729e53a2bb13e47dc6d">playlist_count</a>)</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/* Adds a new playlist before the one numbered <at>. If <at> is negative or</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * equal to the number of playlists, adds a new playlist after the last one. */</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <a class="code" href="api-alias-begin_8h.html#a6e493ca6519bcce93595fbee4d0c56e5">AUD_VFUNC1</a> (<a class="code" href="playlist-new_8c.html#a92e8b67c83fbb7cea463c322fa622bc1">playlist_insert</a>, <span class="keywordtype">int</span>, <a class="code" href="playlist-api_8h.html#a9b77ffc728c31f7c2bfb388fb96e1e05">at</a>)</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/* Moves a contiguous block of <count> playlists starting with the one numbered</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * <from> such that that playlist ends up at the position <to>. */</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <a class="code" href="api-alias-begin_8h.html#a5ce80b9db5e0e45a1669c5fb78b9cf3e">AUD_VFUNC3</a> (<a class="code" href="playlist-new_8c.html#ae5952efa3292c36a2a667cfa2b3bee3d">playlist_reorder</a>, <span class="keywordtype">int</span>, <a class="code" href="audio_8c.html#a62b017d3766f53106a7732cf592551cf">from</a>, <span class="keywordtype">int</span>, <a class="code" href="audio_8c.html#ad8e0aa430ac4f3c92bb182ef435bf245">to</a>, <span class="keywordtype">int</span>, count)</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">/* Closes a playlist. CAUTION: The playlist is not saved, and no confirmation</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * is presented to the user. If <playlist> is the only playlist, a new playlist</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * is added. If <playlist> is the active playlist, another playlist is marked</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * active. If <playlist> is the currently playing playlist, playback is</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * stopped. In this case, calls to playlist_get_playing() will return -1. */</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <a class="code" href="api-alias-begin_8h.html#a6e493ca6519bcce93595fbee4d0c56e5">AUD_VFUNC1</a> (<a class="code" href="playlist-new_8c.html#aa08ffa749fa21a3e9531481d07d3b1a6">playlist_delete</a>, <span class="keywordtype">int</span>, <a class="code" href="playlist-api_8h.html#aa2e76850274a9232d0827720e094179d">playlist</a>)</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">/* Returns a unique non-negative integer which can be used to identify a given</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * playlist even if its numbering changes (as when playlists are reordered).</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * On error, returns -1. */</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <a class="code" href="api-alias-begin_8h.html#abfbd278d15d4b0b8f71086d8aa64424b">AUD_FUNC1</a> (<span class="keywordtype">int</span>, <a class="code" href="playlist-new_8c.html#a3273c94e29e41e2c0304783d78edd953">playlist_get_unique_id</a>, <span class="keywordtype">int</span>, <a class="code" href="playlist-api_8h.html#aa2e76850274a9232d0827720e094179d">playlist</a>)</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">/* Returns the number of the playlist identified by a given integer ID as</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * returned by playlist_get_unique_id(). If the playlist no longer exists,</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * returns -1. */</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <a class="code" href="api-alias-begin_8h.html#abfbd278d15d4b0b8f71086d8aa64424b">AUD_FUNC1</a> (<span class="keywordtype">int</span>, <a class="code" href="playlist-new_8c.html#a703ae8672e4e1efea4b1424b1b5ea022">playlist_by_unique_id</a>, <span class="keywordtype">int</span>, <span class="keywordtype">id</span>)</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">/* Sets the filename associated with a playlist. (Audacious currently makes no</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * use of the filename.) */</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <a class="code" href="api-alias-begin_8h.html#a1edf24989c582abf0c1a072e77a6bb39">AUD_VFUNC2</a> (<a class="code" href="playlist-new_8c.html#a1a7d5ac74a278302dc1a713068293c65">playlist_set_filename</a>, <span class="keywordtype">int</span>, <a class="code" href="playlist-api_8h.html#aa2e76850274a9232d0827720e094179d">playlist</a>, const <span class="keywordtype">char</span> *, <a class="code" href="misc-api_8h.html#a8e824805f6e62c9bd91eec8b26f73e3f">filename</a>)</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">/* Returns the filename associated with a playlist. */</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <a class="code" href="api-alias-begin_8h.html#abfbd278d15d4b0b8f71086d8aa64424b">AUD_FUNC1</a> (<span class="keywordtype">char</span> *, <a class="code" href="playlist-new_8c.html#a44fd9b139ce10fcc026ed2bc00b051a4">playlist_get_filename</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">/* Sets the title associated with a playlist. */</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <a class="code" href="api-alias-begin_8h.html#a1edf24989c582abf0c1a072e77a6bb39">AUD_VFUNC2</a> (<a class="code" href="playlist-new_8c.html#a133d014b22bb859e996589f29a336232">playlist_set_title</a>, <span class="keywordtype">int</span>, playlist, const <span class="keywordtype">char</span> *, title)</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">/* Returns the title associated with a playlist. */</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <a class="code" href="api-alias-begin_8h.html#abfbd278d15d4b0b8f71086d8aa64424b">AUD_FUNC1</a> (<span class="keywordtype">char</span> *, <a class="code" href="playlist-new_8c.html#a9501250bd7ce156be2bfcd79c2ef6683">playlist_get_title</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">/* Sets the active playlist. This is the playlist that user interfaces will</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * show to the user. */</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <a class="code" href="api-alias-begin_8h.html#a6e493ca6519bcce93595fbee4d0c56e5">AUD_VFUNC1</a> (<a class="code" href="playlist-new_8c.html#aff384cdb15d1eccc15730454763a6cbf">playlist_set_active</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">/* Returns the number of the active playlist. */</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <a class="code" href="api-alias-begin_8h.html#ad02cbe226d6b54abc201f249a51877d7">AUD_FUNC0</a> (<span class="keywordtype">int</span>, <a class="code" href="playlist-new_8c.html#a4104dedc0e49c06df517e456277eb4fb">playlist_get_active</a>)</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">/* Sets the currently playing playlist. Any information needed to resume</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * playback from the previously playing playlist is saved, and playback is</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * resumed in the newly set playlist if possible. (See playlist_set_position()</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * for a way to prevent this resuming.) */</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <a class="code" href="api-alias-begin_8h.html#a6e493ca6519bcce93595fbee4d0c56e5">AUD_VFUNC1</a> (<a class="code" href="playlist-new_8c.html#ac79e02125fc684117f0b8c4a29befa68">playlist_set_playing</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">/* Returns the number of the currently playing playlist, or -1 if there is none. */</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <a class="code" href="api-alias-begin_8h.html#ad02cbe226d6b54abc201f249a51877d7">AUD_FUNC0</a> (<span class="keywordtype">int</span>, <a class="code" href="playlist-new_8c.html#a6ac3e6ea5c9ed22deb56489b067f55dd">playlist_get_playing</a>)</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">/* Returns the number of a "blank" playlist. The active playlist is returned if</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * it has the default title and has no entries; otherwise, a new playlist is</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * added and returned. */</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <a class="code" href="api-alias-begin_8h.html#ad02cbe226d6b54abc201f249a51877d7">AUD_FUNC0</a> (<span class="keywordtype">int</span>, <a class="code" href="playlist-new_8c.html#a2a19fe2f28dfa921d50802eeae341295">playlist_get_blank</a>)</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">/* Returns the number of the "temporary" playlist (which is no different from</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * any other playlist except in name). If the playlist does not exist, a</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * "blank" playlist is obtained from playlist_get_blank() and is renamed to</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * become the temporary playlist. */</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <a class="code" href="api-alias-begin_8h.html#ad02cbe226d6b54abc201f249a51877d7">AUD_FUNC0</a> (<span class="keywordtype">int</span>, <a class="code" href="playlist-new_8c.html#aa9100e35dacce73511d917588ce83e6b">playlist_get_temporary</a>)</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">/* Returns the number of entries in a playlist. The entries are numbered</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * starting from zero. */</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <a class="code" href="api-alias-begin_8h.html#abfbd278d15d4b0b8f71086d8aa64424b">AUD_FUNC1</a> (<span class="keywordtype">int</span>, <a class="code" href="playlist-new_8c.html#abb697234305e51250c044e804bf51665">playlist_entry_count</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment">/* Adds a song file, playlist file, or folder to a playlist before the entry</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * numbered <at>. If <at> is negative or equal to the number of entries, the</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * item is added after the last entry. <tuple> may be NULL, in which case</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * Audacious will attempt to read metadata from the song file. The caller gives</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * up one reference count to <tuple>. If <play> is nonzero, Audacious will</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * begin playback of the items once they have been added.</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * Because adding items to the playlist can be a slow process, this function may</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * return before the process is complete. Hence, the caller must not assume</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * that there will be new entries in the playlist immediately. */</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <a class="code" href="playlist-api_8h.html#aabf761910a6167a5ed987105769eacb5">AUD_VFUNC5</a> (<a class="code" href="adder_8c.html#ac830ab99471259ed1e88baa0dfaa0bad">playlist_entry_insert</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, <a class="code" href="playlist-api_8h.html#a9b77ffc728c31f7c2bfb388fb96e1e05">at</a>, const <span class="keywordtype">char</span> *,</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <a class="code" href="misc-api_8h.html#a8e824805f6e62c9bd91eec8b26f73e3f">filename</a>, Tuple *, tuple, <a class="code" href="playlist-api_8h.html#a9c0371229a271517ff8b2eb9901063eb">bool_t</a>, <a class="code" href="main_8c.html#a1b5ea4d88873775f2d78cfb56001f418">play</a>)</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">/* Similar to playlist_entry_insert, adds multiple song files, playlist files,</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * or folders to a playlist. The filenames, stored as (char *) in an index</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * (see libaudcore/index.h), must be pooled with str_get(); the caller gives up</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * one reference count to each filename. Tuples are likewise stored as</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * (Tuple *) in an index of the same length; the caller gives up one reference</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * count to each tuple. <tuples> may be NULL, or individual pointers within it</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * may be NULL. Finally, the caller also gives up ownership of the indexes</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * themselves and should not access them after the call. */</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"><a class="code" href="playlist-api_8h.html#a1fcaf4b3cb00c398b1d7c1447a3c229e"> 122</a></span> <a class="code" href="playlist-api_8h.html#aabf761910a6167a5ed987105769eacb5">AUD_VFUNC5</a> (<a class="code" href="adder_8c.html#a57d9f94f17ee5bb6188c851eca759594">playlist_entry_insert_batch</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, at,</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  Index *, <a class="code" href="main_8c.html#a4a0ffc3e2bb1095cee8ee5e31a24c6fe">filenames</a>, Index *, <a class="code" href="playlist-api_8h.html#a1fcaf4b3cb00c398b1d7c1447a3c229e">tuples</a>, bool_t, <a class="code" href="main_8c.html#a1b5ea4d88873775f2d78cfb56001f418">play</a>)</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment">/* Similar to playlist_entry_insert_batch, but allows the caller to prevent some</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * items from being added by returning false from the <filter> callback. Useful</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * for searching a folder and adding only new files to the playlist. <user> is</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * an untyped pointer passed to the <filter> callback. */</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <a class="code" href="playlist-api_8h.html#ae21aca3777324799bb8b54d12e34f604">AUD_VFUNC7</a> (<a class="code" href="adder_8c.html#a1423a56bafdef4a6fc10285b15f4d456">playlist_entry_insert_filtered</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, at,</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  Index *, filenames, Index *, tuples, <a class="code" href="playlist_8h.html#a827ea2ac75d02928bbaff40cedd80e82">PlaylistFilterFunc</a>, filter,</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keywordtype">void</span> *, user, bool_t, <a class="code" href="main_8c.html#a1b5ea4d88873775f2d78cfb56001f418">play</a>)</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment">/* Removes a contiguous block of <number> entries starting from the one numbered</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * <at> from a playlist. If the last song played is in this block, playback is</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * stopped. In this case, calls to playlist_get_position() will return -1, and</span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * the behavior of drct_play() is unspecified. */</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <a class="code" href="api-alias-begin_8h.html#a5ce80b9db5e0e45a1669c5fb78b9cf3e">AUD_VFUNC3</a> (<a class="code" href="playlist-new_8c.html#a1508d6f561c4120d72cb3942fa107dbd">playlist_entry_delete</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, at, <span class="keywordtype">int</span>, number)</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment">/* Returns the filename of an entry. */</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <a class="code" href="misc-api_8h.html#ac6c0e9c5c81092d35111c77d5a8383ae">AUD_FUNC2</a> (<span class="keywordtype">char</span> *, <a class="code" href="playlist-new_8c.html#ae58ede9b2d9ea3b33e3f4f045bb49ba5">playlist_entry_get_filename</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, <a class="code" href="playlist-api_8h.html#a086fa3126e07b28f91ea01f7cd80f828">entry</a>)</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment">/* Returns a handle to the decoder plugin associated with an entry, or NULL if</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * none can be found. If <fast> is nonzero, returns NULL if no decoder plugin</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * has yet been found. */</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"><a class="code" href="playlist-api_8h.html#a9e941bc1eb871a62fe5e7a94bb60c3d0"> 145</a></span> <a class="code" href="api-alias-begin_8h.html#a053ec5122d1507eb85b481a2e9aae2da">AUD_FUNC3</a> (<a class="code" href="structPluginHandle.html">PluginHandle</a> *, <a class="code" href="playlist-api_8h.html#a9e941bc1eb871a62fe5e7a94bb60c3d0">playlist_entry_get_decoder</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>,</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <a class="code" href="playlist-api_8h.html#a086fa3126e07b28f91ea01f7cd80f828">entry</a>, bool_t, fast)</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment">/* Returns the tuple associated with an entry, or NULL if one is not available.</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * The reference count of the tuple is incremented. If <fast> is nonzero,</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * returns NULL if metadata for the entry has not yet been read from the song</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * file. */</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <a class="code" href="api-alias-begin_8h.html#a053ec5122d1507eb85b481a2e9aae2da">AUD_FUNC3</a> (Tuple *, <a class="code" href="playlist-new_8c.html#aa981e140130fba2e4d11ed7794452b78">playlist_entry_get_tuple</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, entry,</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  bool_t, fast)</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment">/* Returns a formatted title string for an entry. This may include information</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * such as the filename, song title, and/or artist. If <fast> is nonzero,</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * returns a "best guess" based on the entry's filename if metadata for the</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * entry has not yet been read. */</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"><a class="code" href="playlist-api_8h.html#ac1d20f19c2c8c67dc067279a3d35bc85"> 159</a></span> <a class="code" href="api-alias-begin_8h.html#a053ec5122d1507eb85b481a2e9aae2da">AUD_FUNC3</a> (<span class="keywordtype">char</span> *, <a class="code" href="playlist-api_8h.html#ac1d20f19c2c8c67dc067279a3d35bc85">playlist_entry_get_title</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, entry,</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  bool_t, fast)</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment">/* Returns three strings (title, artist, and album) describing an entry. The</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * strings are pooled, and the usual cautions apply. If <fast> is nonzero,</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * returns a "best guess" based on the entry's filename if metadata for the</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * entry has not yet been read. The caller may pass NULL for any values that</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * are not needed; NULL may also be returned for any values that are not</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * available. */</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <a class="code" href="playlist-api_8h.html#a22898bc725c213a8d6764beb0d2a3a7f">AUD_VFUNC6</a> (<a class="code" href="playlist-new_8c.html#ad67e7b0c9744902babb3e815ca78072b">playlist_entry_describe</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, entry,</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keywordtype">char</span> * *, title, <span class="keywordtype">char</span> * *, artist, <span class="keywordtype">char</span> * *, album, bool_t, fast)</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment">/* Returns the length in milliseconds of an entry, or -1 if the length is not</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * known. <fast> is as in playlist_entry_get_tuple(). */</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"><a class="code" href="playlist-api_8h.html#a177a9f9d0682ba2a55a144a850834e81"> 173</a></span> <a class="code" href="api-alias-begin_8h.html#a053ec5122d1507eb85b481a2e9aae2da">AUD_FUNC3</a> (<span class="keywordtype">int</span>, <a class="code" href="playlist-api_8h.html#a177a9f9d0682ba2a55a144a850834e81">playlist_entry_get_length</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, entry,</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  bool_t, fast)</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment">/* Sets the entry which will be played (if this playlist is selected with</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * playlist_set_playing()) when drct_play() is called. If a song from this</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> * playlist is already playing, it will be stopped. If the playlist has resume</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * information set, it will be cleared. It is possible to set a position of -1,</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * meaning that no entry is set to be played. */</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <a class="code" href="api-alias-begin_8h.html#a1edf24989c582abf0c1a072e77a6bb39">AUD_VFUNC2</a> (<a class="code" href="playlist-new_8c.html#a8a891960e8198ee9eb8ce6558e7167bb">playlist_set_position</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, position)</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment">/* Returns the number of the entry set to be played (which may or may not be</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * currently playing), or -1 if there is none. */</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <a class="code" href="api-alias-begin_8h.html#abfbd278d15d4b0b8f71086d8aa64424b">AUD_FUNC1</a> (<span class="keywordtype">int</span>, <a class="code" href="playlist-new_8c.html#a06f18caaee95142294c0ffe5fd78f6c3">playlist_get_position</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment">/* Sets whether an entry is selected. */</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <a class="code" href="api-alias-begin_8h.html#a5ce80b9db5e0e45a1669c5fb78b9cf3e">AUD_VFUNC3</a> (<a class="code" href="playlist-new_8c.html#a383d0a55b088220ccdbba83ad7b03d0e">playlist_entry_set_selected</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, entry,</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  bool_t, selected)</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> </div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment">/* Returns whether an entry is selected. */</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <a class="code" href="misc-api_8h.html#ac6c0e9c5c81092d35111c77d5a8383ae">AUD_FUNC2</a> (bool_t, <a class="code" href="playlist-new_8c.html#a09706e12b384784773a268b791f808cd">playlist_entry_get_selected</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, entry)</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> </div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment">/* Returns the number of selected entries in a playlist. */</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <a class="code" href="api-alias-begin_8h.html#abfbd278d15d4b0b8f71086d8aa64424b">AUD_FUNC1</a> (<span class="keywordtype">int</span>, <a class="code" href="playlist-new_8c.html#a224ec180971477715850c8773e741146">playlist_selected_count</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> </div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment">/* Selects all (or none) of the entries in a playlist. */</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <a class="code" href="api-alias-begin_8h.html#a1edf24989c582abf0c1a072e77a6bb39">AUD_VFUNC2</a> (<a class="code" href="playlist-new_8c.html#a289e7930fcb2e7e96f92c0150fa60a54">playlist_select_all</a>, <span class="keywordtype">int</span>, playlist, bool_t, selected)</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> </div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment">/* Moves a selected entry within a playlist by an offset of <distance> entries.</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> * Other selected entries are gathered around it. Returns the offset by which</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * the entry was actually moved, which may be less in absolute value than the</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> * requested offset. */</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <a class="code" href="api-alias-begin_8h.html#a053ec5122d1507eb85b481a2e9aae2da">AUD_FUNC3</a> (<span class="keywordtype">int</span>, <a class="code" href="playlist-new_8c.html#aa97ece68edbac4ac71716867f677a2e8">playlist_shift</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, position, <span class="keywordtype">int</span>, distance)</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> </div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment">/* Removes the selected entries from a playlist. If the currently playing entry</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * is among these, playback is stopped. */</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <a class="code" href="api-alias-begin_8h.html#a6e493ca6519bcce93595fbee4d0c56e5">AUD_VFUNC1</a> (<a class="code" href="playlist-new_8c.html#add28db2a07368e5a6f0df0ef7778cf69">playlist_delete_selected</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> </div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment">/* Sorts the entries in a playlist based on filename. The callback function</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * should return negative if the first filename comes before the second,</span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> * positive if it comes after, or zero if the two are indistinguishable. */</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"><a class="code" href="playlist-api_8h.html#a9df23865a54cfcb5a23f6f0d77d1f04a"> 213</a></span> <a class="code" href="api-alias-begin_8h.html#a1edf24989c582abf0c1a072e77a6bb39">AUD_VFUNC2</a> (<a class="code" href="playlist-new_8c.html#a015328ace40aab30fb6f4f3c0f32433b">playlist_sort_by_filename</a>, <span class="keywordtype">int</span>, playlist,</div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <a class="code" href="playlist_8h.html#a6cbe99f021b1ecd567d1c7264736cd87">PlaylistStringCompareFunc</a>, compare)</div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> </div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment">/* Sorts the entries in a playlist based on tuple. May fail if metadata</span></div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> * scanning is still in progress (or has been disabled). */</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <a class="code" href="api-alias-begin_8h.html#a1edf24989c582abf0c1a072e77a6bb39">AUD_VFUNC2</a> (<a class="code" href="playlist-new_8c.html#aa49907bf44821e1df69396de8ee2accb">playlist_sort_by_tuple</a>, <span class="keywordtype">int</span>, playlist,</div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <a class="code" href="playlist_8h.html#a85822f181d873ad4fdda2a5596a87d5e">PlaylistTupleCompareFunc</a>, compare)</div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> </div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment">/* Sorts the entries in a playlist based on formatted title string. May fail if</span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> * metadata scanning is still in progress (or has been disabled). */</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <a class="code" href="api-alias-begin_8h.html#a1edf24989c582abf0c1a072e77a6bb39">AUD_VFUNC2</a> (<a class="code" href="playlist-new_8c.html#ae05a5eeefec59c3a399e6a54b0b69a60">playlist_sort_by_title</a>, <span class="keywordtype">int</span>, playlist,</div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  PlaylistStringCompareFunc, compare)</div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> </div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment">/* Sorts only the selected entries in a playlist based on filename. */</span></div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <a class="code" href="api-alias-begin_8h.html#a1edf24989c582abf0c1a072e77a6bb39">AUD_VFUNC2</a> (<a class="code" href="playlist-new_8c.html#a9f506207e6d3ac219ff328d908ed4201">playlist_sort_selected_by_filename</a>, <span class="keywordtype">int</span>, playlist,</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  PlaylistStringCompareFunc, compare)</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment">/* Sorts only the selected entries in a playlist based on tuple. May fail if</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> * metadata scanning is still in progress (or has been disabled). */</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"><a class="code" href="playlist-api_8h.html#a346dbafa4a8697691670f97e3c0db491"> 232</a></span> <a class="code" href="api-alias-begin_8h.html#a1edf24989c582abf0c1a072e77a6bb39">AUD_VFUNC2</a> (<a class="code" href="playlist-new_8c.html#a66cf50882cd9691b82359cfd55481804">playlist_sort_selected_by_tuple</a>, <span class="keywordtype">int</span>, playlist,</div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  PlaylistTupleCompareFunc, compare)</div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> </div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment">/* Sorts only the selected entries in a playlist based on formatted title</span></div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> * string. May fail if metadata scanning is still in progress (or has been</span></div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> * disabled). */</span></div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <a class="code" href="api-alias-begin_8h.html#a1edf24989c582abf0c1a072e77a6bb39">AUD_VFUNC2</a> (<a class="code" href="playlist-new_8c.html#a0d319bddfabff1443e11e4df551d9056">playlist_sort_selected_by_title</a>, <span class="keywordtype">int</span>, playlist,</div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  PlaylistStringCompareFunc, compare)</div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> </div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment">/* Reverses the order of the entries in a playlist. */</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <a class="code" href="api-alias-begin_8h.html#a6e493ca6519bcce93595fbee4d0c56e5">AUD_VFUNC1</a> (<a class="code" href="playlist-new_8c.html#aa1c2bb80f2f2893281f4ee7176b71209">playlist_reverse</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> </div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment">/* Reorders the entries in a playlist randomly. */</span></div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <a class="code" href="api-alias-begin_8h.html#a6e493ca6519bcce93595fbee4d0c56e5">AUD_VFUNC1</a> (<a class="code" href="playlist-new_8c.html#a83e1358f2371e13c96e442b0eb70b775">playlist_randomize</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> </div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment">/* Discards the metadata stored for all the entries in a playlist and starts</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> * reading it afresh from the song files in the background. */</span></div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <a class="code" href="api-alias-begin_8h.html#a6e493ca6519bcce93595fbee4d0c56e5">AUD_VFUNC1</a> (<a class="code" href="playlist-new_8c.html#a2b548c7b67fc9413733f5244013be445">playlist_rescan</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> </div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment">/* Like playlist_rescan, but applies only to the selected entries in a playlist. */</span></div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <a class="code" href="api-alias-begin_8h.html#a6e493ca6519bcce93595fbee4d0c56e5">AUD_VFUNC1</a> (<a class="code" href="playlist-new_8c.html#ac1184dd76043ebd09e653b8cdd4a2f91">playlist_rescan_selected</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> </div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment">/* Discards the metadata stored for all the entries that refer to a particular</span></div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> * song file, in whatever playlist they appear, and starts reading it afresh</span></div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> * from that file in the background. */</span></div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <a class="code" href="api-alias-begin_8h.html#a6e493ca6519bcce93595fbee4d0c56e5">AUD_VFUNC1</a> (<a class="code" href="playlist-new_8c.html#a5273dd1f0b45d855ad427805a42c7d36">playlist_rescan_file</a>, const <span class="keywordtype">char</span> *, filename)</div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> </div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment">/* Calculates the total length in milliseconds of all the entries in a playlist.</span></div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment"> * Only takes into account entries for which metadata has already been read. */</span></div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <a class="code" href="api-alias-begin_8h.html#abfbd278d15d4b0b8f71086d8aa64424b">AUD_FUNC1</a> (int64_t, <a class="code" href="playlist-new_8c.html#a7a1e848569aaa6869d594e8471399f26">playlist_get_total_length</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> </div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment">/* Calculates the total length in milliseconds of only the selected entries in a</span></div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> * playlist. Only takes into account entries for which metadata has already</span></div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> * been read. */</span></div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <a class="code" href="api-alias-begin_8h.html#abfbd278d15d4b0b8f71086d8aa64424b">AUD_FUNC1</a> (int64_t, <a class="code" href="playlist-new_8c.html#a888d9e7b58657756014f007c82a54cb5">playlist_get_selected_length</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span> </div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment">/* Returns the number of entries in a playlist queue. The entries are numbered</span></div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> * starting from zero, lower numbers being played first. */</span></div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <a class="code" href="api-alias-begin_8h.html#abfbd278d15d4b0b8f71086d8aa64424b">AUD_FUNC1</a> (<span class="keywordtype">int</span>, <a class="code" href="playlist-new_8c.html#a60e7a81400c03995332e81392e843bcd">playlist_queue_count</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span> </div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment">/* Adds an entry to a playlist's queue before the entry numbered <at> in the</span></div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> * queue. If <at> is negative or equal to the number of entries in the queue,</span></div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> * adds the entry after the last one in the queue. The same entry cannot be</span></div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> * added to the queue more than once. */</span></div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <a class="code" href="api-alias-begin_8h.html#a5ce80b9db5e0e45a1669c5fb78b9cf3e">AUD_VFUNC3</a> (<a class="code" href="playlist-new_8c.html#a20574b7e05f1470ac92dc4ebe48d8351">playlist_queue_insert</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, at, <span class="keywordtype">int</span>, entry)</div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span> </div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment">/* Adds the selected entries in a playlist to the queue, if they are not already</span></div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> * in it. */</span></div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <a class="code" href="api-alias-begin_8h.html#a1edf24989c582abf0c1a072e77a6bb39">AUD_VFUNC2</a> (<a class="code" href="playlist-new_8c.html#ad4d8af99b7c02be1a81bf885333fb3e6">playlist_queue_insert_selected</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, at)</div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> </div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment">/* Returns the position in the playlist of the entry at a given position in the</span></div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> * queue. */</span></div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <a class="code" href="misc-api_8h.html#ac6c0e9c5c81092d35111c77d5a8383ae">AUD_FUNC2</a> (<span class="keywordtype">int</span>, <a class="code" href="playlist-new_8c.html#a9d2cddaf307471b5dcf30e13d790d0aa">playlist_queue_get_entry</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, at)</div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> </div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment">/* Returns the position in the queue of the entry at a given position in the</span></div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> * playlist. If it is not in the queue, returns -1. */</span></div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <a class="code" href="misc-api_8h.html#ac6c0e9c5c81092d35111c77d5a8383ae">AUD_FUNC2</a> (<span class="keywordtype">int</span>, <a class="code" href="playlist-new_8c.html#a2b092d2171d615187c3821ae8f488b7c">playlist_queue_find_entry</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, entry)</div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span> </div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment">/* Removes a contiguous block of <number> entries starting with the one numbered</span></div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> * <at> from the queue. */</span></div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <a class="code" href="api-alias-begin_8h.html#a5ce80b9db5e0e45a1669c5fb78b9cf3e">AUD_VFUNC3</a> (<a class="code" href="playlist-new_8c.html#a58108f374b999e8a6ccade2ce7d4ab44">playlist_queue_delete</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, at, <span class="keywordtype">int</span>, number)</div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span> </div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment">/* Removes the selected entries in a playlist from the queue, if they are in it. */</span></div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <a class="code" href="api-alias-begin_8h.html#a6e493ca6519bcce93595fbee4d0c56e5">AUD_VFUNC1</a> (<a class="code" href="playlist-new_8c.html#a9d8fc61880929a4c5ff07537ccae5cd9">playlist_queue_delete_selected</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> </div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment">/* Returns nonzero if a "playlist update" hook call is pending. If called from</span></div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> * within the hook, the current hook call is not considered pending. */</span></div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <a class="code" href="api-alias-begin_8h.html#ad02cbe226d6b54abc201f249a51877d7">AUD_FUNC0</a> (bool_t, <a class="code" href="playlist-new_8c.html#a812982af9951216a57a6de5b0164f856">playlist_update_pending</a>)</div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span> </div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment">/* May be called within the "playlist update" hook to determine the update level</span></div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment"> * and number of entries changed in a playlist. Returns the update level for</span></div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment"> * the playlist, storing the number of the first entry changed in <at> and the</span></div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"> * number of contiguous entries to be updated in <count>. Note that entries may</span></div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment"> * have been added or removed within this range. If no entries in the playlist</span></div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment"> * have changed, returns zero. */</span></div>
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <a class="code" href="api-alias-begin_8h.html#a053ec5122d1507eb85b481a2e9aae2da">AUD_FUNC3</a> (<span class="keywordtype">int</span>, <a class="code" href="playlist-new_8c.html#a6cf0c5a2f3bcb968a1ba62a5bd053149">playlist_updated_range</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span> *, at, <span class="keywordtype">int</span> *, count)</div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> </div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment">/* Returns nonzero if entries are being added to a playlist in the background. */</span></div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <a class="code" href="api-alias-begin_8h.html#abfbd278d15d4b0b8f71086d8aa64424b">AUD_FUNC1</a> (bool_t, <a class="code" href="adder_8c.html#a0e9d9f843020de4a2e93a103d0407668">playlist_add_in_progress</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> </div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment">/* Returns nonzero if entries in a playlist are being scanned for metadata in</span></div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> * the background. */</span></div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <a class="code" href="api-alias-begin_8h.html#abfbd278d15d4b0b8f71086d8aa64424b">AUD_FUNC1</a> (bool_t, <a class="code" href="playlist-new_8c.html#ad4b42a7249a751ee6e54233b31329e19">playlist_scan_in_progress</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span> </div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment">/* --- PLAYLIST UTILITY API --- */</span></div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span> </div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment">/* Sorts the entries in a playlist according to one of the schemes listed in</span></div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> * playlist.h. */</span></div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <a class="code" href="api-alias-begin_8h.html#a1edf24989c582abf0c1a072e77a6bb39">AUD_VFUNC2</a> (<a class="code" href="playlist-utils_8c.html#a2aae7fe456b1096221341d07e598858e">playlist_sort_by_scheme</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, scheme)</div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span> </div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment">/* Sorts only the selected entries in a playlist according to one of those</span></div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> * schemes. */</span></div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <a class="code" href="api-alias-begin_8h.html#a1edf24989c582abf0c1a072e77a6bb39">AUD_VFUNC2</a> (<a class="code" href="playlist-utils_8c.html#acff4c99146682ba77b9a9fb7073e1836">playlist_sort_selected_by_scheme</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>, scheme)</div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span> </div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment">/* Removes duplicate entries in a playlist according to one of those schemes.</span></div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"> * As currently implemented, first sorts the playlist. */</span></div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <a class="code" href="api-alias-begin_8h.html#a1edf24989c582abf0c1a072e77a6bb39">AUD_VFUNC2</a> (<a class="code" href="playlist-utils_8c.html#ae2b81f226293a1392f612d9f83c0ea44">playlist_remove_duplicates_by_scheme</a>, <span class="keywordtype">int</span>, playlist, <span class="keywordtype">int</span>,</div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span>  scheme)</div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span> </div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment">/* Removes all entries referring to unavailable files in a playlist. ("Remove</span></div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"> * failed" is something of a misnomer for the current behavior.) As currently</span></div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> * implemented, only works for file:// URIs. */</span></div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <a class="code" href="api-alias-begin_8h.html#a6e493ca6519bcce93595fbee4d0c56e5">AUD_VFUNC1</a> (<a class="code" href="playlist-utils_8c.html#a8d5008b91c25bb80ca13f90984109ec6">playlist_remove_failed</a>, <span class="keywordtype">int</span>, playlist)</div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span> </div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment">/* Selects all the entries in a playlist that match regular expressions stored</span></div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment"> * in the fields of a tuple. Does not free the memory used by the tuple.</span></div>
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> * Example: To select all the songs whose title starts with the letter "A",</span></div>
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> * create a blank tuple and set its title field to "^A". */</span></div>
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <a class="code" href="api-alias-begin_8h.html#a1edf24989c582abf0c1a072e77a6bb39">AUD_VFUNC2</a> (<a class="code" href="playlist-utils_8c.html#a23a7a78f5ada34f598f38362eac08234">playlist_select_by_patterns</a>, <span class="keywordtype">int</span>, playlist, const Tuple *,</div>
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span>  patterns)</div>
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span> </div>
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment">/* Returns nonzero if <filename> refers to a playlist file. */</span></div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <a class="code" href="api-alias-begin_8h.html#abfbd278d15d4b0b8f71086d8aa64424b">AUD_FUNC1</a> (bool_t, <a class="code" href="playlist-files_8c.html#a28844660498c6d31585b46119853a55b">filename_is_playlist</a>, const <span class="keywordtype">char</span> *, filename)</div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span> </div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment">/* Saves the entries in a playlist to a playlist file. The format of the file</span></div>
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment"> * is determined from the file extension. Returns nonzero on success. */</span></div>
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <a class="code" href="misc-api_8h.html#ac6c0e9c5c81092d35111c77d5a8383ae">AUD_FUNC2</a> (bool_t, <a class="code" href="playlist-files_8c.html#a2ae862366f544e34d92467f50061ba06">playlist_save</a>, <span class="keywordtype">int</span>, playlist, const <span class="keywordtype">char</span> *, filename)</div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>
