<!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.5"/>
<title>libmpdclient: mpd/entity.h File Reference</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">libmpdclient
 <span id="projectnumber">2.7</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</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_89dd766eb2df7d7257dbe806a34404af.html">mpd</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">entity.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>MPD client library.
<a href="#details">More...</a></p>
<p><a href="entity_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a8c8b1c54c845de5fc64e99be73e397ed"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="entity_8h.html#a8c8b1c54c845de5fc64e99be73e397ed">mpd_entity_type</a> { <a class="el" href="entity_8h.html#a8c8b1c54c845de5fc64e99be73e397eda3c216464a1905cd350e91ad7e49c282c">MPD_ENTITY_TYPE_UNKNOWN</a>,
<a class="el" href="entity_8h.html#a8c8b1c54c845de5fc64e99be73e397eda68df75591c252d4151b1ce2ce2b39dbd">MPD_ENTITY_TYPE_DIRECTORY</a>,
<a class="el" href="entity_8h.html#a8c8b1c54c845de5fc64e99be73e397eda4c787eea2ad92f45448c6f6a0258ecc1">MPD_ENTITY_TYPE_SONG</a>,
<a class="el" href="entity_8h.html#a8c8b1c54c845de5fc64e99be73e397edaaea49285dc75e0052c45eab74b872c9d">MPD_ENTITY_TYPE_PLAYLIST</a>
}</td></tr>
<tr class="separator:a8c8b1c54c845de5fc64e99be73e397ed"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa331a1d77209ccd86d2f69b0caf9925a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="entity_8h.html#aa331a1d77209ccd86d2f69b0caf9925a">mpd_entity_free</a> (struct <a class="el" href="structmpd__entity.html">mpd_entity</a> *entity)</td></tr>
<tr class="separator:aa331a1d77209ccd86d2f69b0caf9925a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a76161953b2cae7cf8f13389d3d5324ca"><td class="memItemLeft" align="right" valign="top">mpd_pure enum <a class="el" href="entity_8h.html#a8c8b1c54c845de5fc64e99be73e397ed">mpd_entity_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="entity_8h.html#a76161953b2cae7cf8f13389d3d5324ca">mpd_entity_get_type</a> (const struct <a class="el" href="structmpd__entity.html">mpd_entity</a> *entity)</td></tr>
<tr class="separator:a76161953b2cae7cf8f13389d3d5324ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aabf146d3191a918ff4e4ae6a8d659c13"><td class="memItemLeft" align="right" valign="top">mpd_pure struct <a class="el" href="structmpd__directory.html">mpd_directory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="entity_8h.html#aabf146d3191a918ff4e4ae6a8d659c13">mpd_entity_get_directory</a> (const struct <a class="el" href="structmpd__entity.html">mpd_entity</a> *entity)</td></tr>
<tr class="separator:aabf146d3191a918ff4e4ae6a8d659c13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af77a940652214960dde6810ad7d66008"><td class="memItemLeft" align="right" valign="top">mpd_pure struct <a class="el" href="structmpd__song.html">mpd_song</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="entity_8h.html#af77a940652214960dde6810ad7d66008">mpd_entity_get_song</a> (const struct <a class="el" href="structmpd__entity.html">mpd_entity</a> *entity)</td></tr>
<tr class="separator:af77a940652214960dde6810ad7d66008"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7253d83fc28de301819571d4f7db1c93"><td class="memItemLeft" align="right" valign="top">mpd_pure struct <a class="el" href="structmpd__playlist.html">mpd_playlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="entity_8h.html#a7253d83fc28de301819571d4f7db1c93">mpd_entity_get_playlist</a> (const struct <a class="el" href="structmpd__entity.html">mpd_entity</a> *entity)</td></tr>
<tr class="separator:a7253d83fc28de301819571d4f7db1c93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d6e462411f3e46ea319e1690060ea34"><td class="memItemLeft" align="right" valign="top">mpd_malloc struct <a class="el" href="structmpd__entity.html">mpd_entity</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="entity_8h.html#a5d6e462411f3e46ea319e1690060ea34">mpd_entity_begin</a> (const struct <a class="el" href="structmpd__pair.html">mpd_pair</a> *pair)</td></tr>
<tr class="separator:a5d6e462411f3e46ea319e1690060ea34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aafd1393de30af8d272208675e3577bcf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="entity_8h.html#aafd1393de30af8d272208675e3577bcf">mpd_entity_feed</a> (struct <a class="el" href="structmpd__entity.html">mpd_entity</a> *entity, const struct <a class="el" href="structmpd__pair.html">mpd_pair</a> *pair)</td></tr>
<tr class="separator:aafd1393de30af8d272208675e3577bcf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a274a62a5d9d73ce63c509aa8c7eadc6d"><td class="memItemLeft" align="right" valign="top">mpd_malloc struct <a class="el" href="structmpd__entity.html">mpd_entity</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="entity_8h.html#a274a62a5d9d73ce63c509aa8c7eadc6d">mpd_recv_entity</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
<tr class="separator:a274a62a5d9d73ce63c509aa8c7eadc6d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>MPD client library. </p>
<p>Do not include this header directly. Use <a class="el" href="client_8h.html" title="MPD client library. ">mpd/client.h</a> instead. </p>
<p>Definition in file <a class="el" href="entity_8h_source.html">entity.h</a>.</p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a8c8b1c54c845de5fc64e99be73e397ed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="entity_8h.html#a8c8b1c54c845de5fc64e99be73e397ed">mpd_entity_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The type of a <a class="el" href="structmpd__entity.html">mpd_entity</a> object. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a8c8b1c54c845de5fc64e99be73e397eda3c216464a1905cd350e91ad7e49c282c"></a>MPD_ENTITY_TYPE_UNKNOWN</em> </td><td class="fielddoc">
<p>The type of the entity received from MPD is not implemented in this version of libmpdclient. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a8c8b1c54c845de5fc64e99be73e397eda68df75591c252d4151b1ce2ce2b39dbd"></a>MPD_ENTITY_TYPE_DIRECTORY</em> </td><td class="fielddoc">
<p>A directory (<a class="el" href="structmpd__directory.html">mpd_directory</a>) containing more entities. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a8c8b1c54c845de5fc64e99be73e397eda4c787eea2ad92f45448c6f6a0258ecc1"></a>MPD_ENTITY_TYPE_SONG</em> </td><td class="fielddoc">
<p>A song file (<a class="el" href="structmpd__song.html">mpd_song</a>) which can be added to the playlist. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a8c8b1c54c845de5fc64e99be73e397edaaea49285dc75e0052c45eab74b872c9d"></a>MPD_ENTITY_TYPE_PLAYLIST</em> </td><td class="fielddoc">
<p>A stored playlist (<a class="el" href="structmpd__playlist.html">mpd_playlist</a>). </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="entity_8h_source.html#l00052">52</a> of file <a class="el" href="entity_8h_source.html">entity.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="aa331a1d77209ccd86d2f69b0caf9925a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mpd_entity_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__entity.html">mpd_entity</a> * </td>
<td class="paramname"><em>entity</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases an entity. This also frees the wrapped object. </p>
</div>
</div>
<a class="anchor" id="a76161953b2cae7cf8f13389d3d5324ca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure enum <a class="el" href="entity_8h.html#a8c8b1c54c845de5fc64e99be73e397ed">mpd_entity_type</a> mpd_entity_get_type </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__entity.html">mpd_entity</a> * </td>
<td class="paramname"><em>entity</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the type of this entity. </dd></dl>
</div>
</div>
<a class="anchor" id="aabf146d3191a918ff4e4ae6a8d659c13"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure struct <a class="el" href="structmpd__directory.html">mpd_directory</a>* mpd_entity_get_directory </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__entity.html">mpd_entity</a> * </td>
<td class="paramname"><em>entity</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Obtains a pointer to the <a class="el" href="structmpd__directory.html">mpd_directory</a> object enclosed by this <a class="el" href="structmpd__entity.html">mpd_entity</a>. Calling this function is only allowed of <a class="el" href="entity_8h.html#a76161953b2cae7cf8f13389d3d5324ca">mpd_entity_get_type()</a> has returned <a class="el" href="entity_8h.html#a8c8b1c54c845de5fc64e99be73e397eda68df75591c252d4151b1ce2ce2b39dbd">MPD_ENTITY_TYPE_DIRECTORY</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>the directory object </dd></dl>
</div>
</div>
<a class="anchor" id="af77a940652214960dde6810ad7d66008"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure struct <a class="el" href="structmpd__song.html">mpd_song</a>* mpd_entity_get_song </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__entity.html">mpd_entity</a> * </td>
<td class="paramname"><em>entity</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Obtains a pointer to the <a class="el" href="structmpd__song.html">mpd_song</a> object enclosed by this <a class="el" href="structmpd__entity.html">mpd_entity</a>. Calling this function is only allowed of <a class="el" href="entity_8h.html#a76161953b2cae7cf8f13389d3d5324ca">mpd_entity_get_type()</a> has returned <a class="el" href="entity_8h.html#a8c8b1c54c845de5fc64e99be73e397eda4c787eea2ad92f45448c6f6a0258ecc1">MPD_ENTITY_TYPE_SONG</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>the song object </dd></dl>
</div>
</div>
<a class="anchor" id="a7253d83fc28de301819571d4f7db1c93"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure struct <a class="el" href="structmpd__playlist.html">mpd_playlist</a>* mpd_entity_get_playlist </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__entity.html">mpd_entity</a> * </td>
<td class="paramname"><em>entity</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Obtains a pointer to the <a class="el" href="structmpd__playlist.html">mpd_playlist</a> object enclosed by this <a class="el" href="structmpd__entity.html">mpd_entity</a>. Calling this function is only allowed of <a class="el" href="entity_8h.html#a76161953b2cae7cf8f13389d3d5324ca">mpd_entity_get_type()</a> has returned <a class="el" href="entity_8h.html#a8c8b1c54c845de5fc64e99be73e397edaaea49285dc75e0052c45eab74b872c9d">MPD_ENTITY_TYPE_PLAYLIST</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>the directory object </dd></dl>
</div>
</div>
<a class="anchor" id="a5d6e462411f3e46ea319e1690060ea34"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_malloc struct <a class="el" href="structmpd__entity.html">mpd_entity</a>* mpd_entity_begin </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__pair.html">mpd_pair</a> * </td>
<td class="paramname"><em>pair</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Begins parsing a new entity.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pair</td><td>the first pair in this entity </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the new <a class="el" href="structmpd__entity.html">mpd_entity</a> object, or NULL on error (out of memory) </dd></dl>
</div>
</div>
<a class="anchor" id="aafd1393de30af8d272208675e3577bcf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_entity_feed </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__entity.html">mpd_entity</a> * </td>
<td class="paramname"><em>entity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const struct <a class="el" href="structmpd__pair.html">mpd_pair</a> * </td>
<td class="paramname"><em>pair</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses the pair, adding its information to the specified <a class="el" href="structmpd__entity.html">mpd_entity</a> object.</p>
<dl class="section return"><dt>Returns</dt><dd>true if the pair was parsed and added to the entity (or if the pair was not understood and ignored), false if this pair is the beginning of the next entity </dd></dl>
</div>
</div>
<a class="anchor" id="a274a62a5d9d73ce63c509aa8c7eadc6d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_malloc struct <a class="el" href="structmpd__entity.html">mpd_entity</a>* mpd_recv_entity </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__connection.html">mpd_connection</a> * </td>
<td class="paramname"><em>connection</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Receives the next entity from the MPD server.</p>
<dl class="section return"><dt>Returns</dt><dd>an entity object, or NULL on error or if the entity list is finished </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Oct 18 2013 05:03:03 for libmpdclient by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
