<!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"/>
<title>libmpdclient: mpd/output.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="tabs">
<ul>
<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>
<div class="contents">
<h1>mpd/output.h File Reference</h1>
<p>MPD client library.
<a href="#_details">More...</a></p>
<p><a href="output_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_malloc struct <a class="el" href="structmpd__output.html">mpd_output</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="output_8h.html#a3642639fcc32008b222bc354799172bf">mpd_output_begin</a> (const struct <a class="el" href="structmpd__pair.html">mpd_pair</a> *pair)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="output_8h.html#a98dba16cdcb71caacd039d213239a298">mpd_output_feed</a> (struct <a class="el" href="structmpd__output.html">mpd_output</a> *output, const struct <a class="el" href="structmpd__pair.html">mpd_pair</a> *pair)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="output_8h.html#aabcb99bcafc7b9e3f7dd36300a72bab2">mpd_output_free</a> (struct <a class="el" href="structmpd__output.html">mpd_output</a> *output)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_pure unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="output_8h.html#a54cf4779b44b143efdbb414c5dfcb196">mpd_output_get_id</a> (const struct <a class="el" href="structmpd__output.html">mpd_output</a> *output)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_pure const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="output_8h.html#ac5f9d87bbe13e37939430296a574c46c">mpd_output_get_name</a> (const struct <a class="el" href="structmpd__output.html">mpd_output</a> *output)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_pure bool </td><td class="memItemRight" valign="bottom"><a class="el" href="output_8h.html#a6a3781abd484b322b14cb1423aebab6f">mpd_output_get_enabled</a> (const struct <a class="el" href="structmpd__output.html">mpd_output</a> *output)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="output_8h.html#aa12f0ea3a204fc3f0f4b090c7ce8273c">mpd_send_outputs</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">mpd_malloc struct <a class="el" href="structmpd__output.html">mpd_output</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="output_8h.html#a0dc50b420a5daff815e2c4ee540f2f0b">mpd_recv_output</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="output_8h.html#a47fe0b1c8647dd6a7fb092654ab3b971">mpd_send_enable_output</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, unsigned output_id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="output_8h.html#a014c57ddf51ea4d25dac67df3d3bbb61">mpd_run_enable_output</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, unsigned output_id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="output_8h.html#ade7c0dff0e0f86455770a5c6e29e5a84">mpd_send_disable_output</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, unsigned output_id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="output_8h.html#aa3ab3611b3f6f5906dafd73c32eed0da">mpd_run_disable_output</a> (struct <a class="el" href="structmpd__connection.html">mpd_connection</a> *connection, unsigned output_id)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<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="output_8h_source.html">output.h</a>.</p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a3642639fcc32008b222bc354799172bf"></a><!-- doxytag: member="output.h::mpd_output_begin" ref="a3642639fcc32008b222bc354799172bf" args="(const struct mpd_pair *pair)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_malloc struct <a class="el" href="structmpd__output.html">mpd_output</a>* mpd_output_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><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Begins parsing a new <a class="el" href="structmpd__output.html">mpd_output</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pair</em> </td><td>the first pair in this output (name is "outputid") </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the new <a class="el" href="structmpd__output.html">mpd_output</a> object, or NULL on error (out of memory, or wrong pair name) </dd></dl>
</div>
</div>
<a class="anchor" id="a98dba16cdcb71caacd039d213239a298"></a><!-- doxytag: member="output.h::mpd_output_feed" ref="a98dba16cdcb71caacd039d213239a298" args="(struct mpd_output *output, const struct mpd_pair *pair)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_output_feed </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__output.html">mpd_output</a> * </td>
<td class="paramname"> <em>output</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><td> </td>
</tr>
<tr>
<td></td>
<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__output.html">mpd_output</a> object.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the pair was parsed and added to the output (or if the pair was not understood and ignored), false if this pair is the beginning of the next output </dd></dl>
</div>
</div>
<a class="anchor" id="aabcb99bcafc7b9e3f7dd36300a72bab2"></a><!-- doxytag: member="output.h::mpd_output_free" ref="aabcb99bcafc7b9e3f7dd36300a72bab2" args="(struct mpd_output *output)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mpd_output_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structmpd__output.html">mpd_output</a> * </td>
<td class="paramname"> <em>output</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Frees a <a class="el" href="structmpd__output.html">mpd_output</a> object returned from mpd_output_get_next(). </p>
</div>
</div>
<a class="anchor" id="a6a3781abd484b322b14cb1423aebab6f"></a><!-- doxytag: member="output.h::mpd_output_get_enabled" ref="a6a3781abd484b322b14cb1423aebab6f" args="(const struct mpd_output *output)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure bool mpd_output_get_enabled </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__output.html">mpd_output</a> * </td>
<td class="paramname"> <em>output</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this output is enabled </dd></dl>
</div>
</div>
<a class="anchor" id="a54cf4779b44b143efdbb414c5dfcb196"></a><!-- doxytag: member="output.h::mpd_output_get_id" ref="a54cf4779b44b143efdbb414c5dfcb196" args="(const struct mpd_output *output)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure unsigned mpd_output_get_id </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__output.html">mpd_output</a> * </td>
<td class="paramname"> <em>output</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the id of the specified <a class="el" href="structmpd__output.html">mpd_output</a> object </dd></dl>
</div>
</div>
<a class="anchor" id="ac5f9d87bbe13e37939430296a574c46c"></a><!-- doxytag: member="output.h::mpd_output_get_name" ref="ac5f9d87bbe13e37939430296a574c46c" args="(const struct mpd_output *output)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_pure const char* mpd_output_get_name </td>
<td>(</td>
<td class="paramtype">const struct <a class="el" href="structmpd__output.html">mpd_output</a> * </td>
<td class="paramname"> <em>output</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the configured name of the specified <a class="el" href="structmpd__output.html">mpd_output</a> object </dd></dl>
</div>
</div>
<a class="anchor" id="a0dc50b420a5daff815e2c4ee540f2f0b"></a><!-- doxytag: member="output.h::mpd_recv_output" ref="a0dc50b420a5daff815e2c4ee540f2f0b" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mpd_malloc struct <a class="el" href="structmpd__output.html">mpd_output</a>* mpd_recv_output </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><code> [read]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads the next <a class="el" href="structmpd__output.html">mpd_output</a> from the MPD response. Free the return value with <a class="el" href="output_8h.html#aabcb99bcafc7b9e3f7dd36300a72bab2">mpd_output_free()</a>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a <a class="el" href="structmpd__output.html">mpd_output</a> object on success, NULL on error or end-of-response </dd></dl>
</div>
</div>
<a class="anchor" id="aa3ab3611b3f6f5906dafd73c32eed0da"></a><!-- doxytag: member="output.h::mpd_run_disable_output" ref="aa3ab3611b3f6f5906dafd73c32eed0da" args="(struct mpd_connection *connection, unsigned output_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_run_disable_output </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>output_id</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Shortcut for <a class="el" href="output_8h.html#ade7c0dff0e0f86455770a5c6e29e5a84">mpd_send_disable_output()</a> and <a class="el" href="response_8h.html#af59dc292f7df1ffce944972dd4a7150f">mpd_response_finish()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>A valid and connected <a class="el" href="structmpd__connection.html">mpd_connection</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output_id</em> </td><td>an identifier for the output device (see mpd_output_get_next()) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success </dd></dl>
</div>
</div>
<a class="anchor" id="a014c57ddf51ea4d25dac67df3d3bbb61"></a><!-- doxytag: member="output.h::mpd_run_enable_output" ref="a014c57ddf51ea4d25dac67df3d3bbb61" args="(struct mpd_connection *connection, unsigned output_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_run_enable_output </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>output_id</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Shortcut for <a class="el" href="output_8h.html#a47fe0b1c8647dd6a7fb092654ab3b971">mpd_send_enable_output()</a> and <a class="el" href="response_8h.html#af59dc292f7df1ffce944972dd4a7150f">mpd_response_finish()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>A valid and connected <a class="el" href="structmpd__connection.html">mpd_connection</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output_id</em> </td><td>an identifier for the output device (see mpd_output_get_next()) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success </dd></dl>
</div>
</div>
<a class="anchor" id="ade7c0dff0e0f86455770a5c6e29e5a84"></a><!-- doxytag: member="output.h::mpd_send_disable_output" ref="ade7c0dff0e0f86455770a5c6e29e5a84" args="(struct mpd_connection *connection, unsigned output_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_send_disable_output </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>output_id</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends the "disableoutput" command to MPD.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>A valid and connected <a class="el" href="structmpd__connection.html">mpd_connection</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output_id</em> </td><td>an identifier for the output device (see mpd_output_get_next()) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success </dd></dl>
</div>
</div>
<a class="anchor" id="a47fe0b1c8647dd6a7fb092654ab3b971"></a><!-- doxytag: member="output.h::mpd_send_enable_output" ref="a47fe0b1c8647dd6a7fb092654ab3b971" args="(struct mpd_connection *connection, unsigned output_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_send_enable_output </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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>output_id</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends the "enableoutput" command to MPD.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>A valid and connected <a class="el" href="structmpd__connection.html">mpd_connection</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output_id</em> </td><td>an identifier for the output device (see mpd_output_get_next()) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success </dd></dl>
</div>
</div>
<a class="anchor" id="aa12f0ea3a204fc3f0f4b090c7ce8273c"></a><!-- doxytag: member="output.h::mpd_send_outputs" ref="aa12f0ea3a204fc3f0f4b090c7ce8273c" args="(struct mpd_connection *connection)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mpd_send_outputs </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>Sends the "outputs" command to MPD. Call mpd_output_get_next() to read the response.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td>A valid and connected <a class="el" href="structmpd__connection.html">mpd_connection</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sun Aug 8 15:52:35 2010 for libmpdclient by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
