<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PulseAudio: context.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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PulseAudio
 <span id="projectnumber">10.0.0-1.1.mga6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('context_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">context.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Connection contexts for asynchronous communication with a server.
<a href="#details">More...</a></p>
<p><a href="context_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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aff56e9b3dd442a88227da084bb5c380a"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a></td></tr>
<tr class="memdesc:aff56e9b3dd442a88227da084bb5c380a"><td class="mdescLeft"> </td><td class="mdescRight">An opaque connection context to a daemon. <a href="#aff56e9b3dd442a88227da084bb5c380a">More...</a><br /></td></tr>
<tr class="separator:aff56e9b3dd442a88227da084bb5c380a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a19074e289d91ccae8dd58d15e912fc13"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a19074e289d91ccae8dd58d15e912fc13">pa_context_notify_cb_t</a>) (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, void *userdata)</td></tr>
<tr class="memdesc:a19074e289d91ccae8dd58d15e912fc13"><td class="mdescLeft"> </td><td class="mdescRight">Generic notification callback prototype. <a href="#a19074e289d91ccae8dd58d15e912fc13">More...</a><br /></td></tr>
<tr class="separator:a19074e289d91ccae8dd58d15e912fc13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a086b985c499c50efc628c267e8923fb1"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a086b985c499c50efc628c267e8923fb1">pa_context_success_cb_t</a>) (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, int success, void *userdata)</td></tr>
<tr class="memdesc:a086b985c499c50efc628c267e8923fb1"><td class="mdescLeft"> </td><td class="mdescRight">A generic callback for operation completion. <a href="#a086b985c499c50efc628c267e8923fb1">More...</a><br /></td></tr>
<tr class="separator:a086b985c499c50efc628c267e8923fb1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a039e0805d8276906397d4f55c78f13f4"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a039e0805d8276906397d4f55c78f13f4">pa_context_event_cb_t</a>) (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, const char *name, <a class="el" href="proplist_8h.html#acdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p, void *userdata)</td></tr>
<tr class="memdesc:a039e0805d8276906397d4f55c78f13f4"><td class="mdescLeft"> </td><td class="mdescRight">A callback for asynchronous meta/policy event messages. <a href="#a039e0805d8276906397d4f55c78f13f4">More...</a><br /></td></tr>
<tr class="separator:a039e0805d8276906397d4f55c78f13f4"><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:a2784c754947a97f02c78b73d7b1c2d5f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a2784c754947a97f02c78b73d7b1c2d5f">pa_context_new</a> (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *mainloop, const char *name)</td></tr>
<tr class="memdesc:a2784c754947a97f02c78b73d7b1c2d5f"><td class="mdescLeft"> </td><td class="mdescRight">Instantiate a new connection context with an abstract mainloop API and an application name. <a href="#a2784c754947a97f02c78b73d7b1c2d5f">More...</a><br /></td></tr>
<tr class="separator:a2784c754947a97f02c78b73d7b1c2d5f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a38182a2cd9439cd29d3cade7eb724405"><td class="memItemLeft" align="right" valign="top"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a38182a2cd9439cd29d3cade7eb724405">pa_context_new_with_proplist</a> (<a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> *mainloop, const char *name, <a class="el" href="proplist_8h.html#acdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *proplist)</td></tr>
<tr class="memdesc:a38182a2cd9439cd29d3cade7eb724405"><td class="mdescLeft"> </td><td class="mdescRight">Instantiate a new connection context with an abstract mainloop API and an application name, and specify the initial client property list. <a href="#a38182a2cd9439cd29d3cade7eb724405">More...</a><br /></td></tr>
<tr class="separator:a38182a2cd9439cd29d3cade7eb724405"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a344c4ccf14d6a8842e83154a0aa99311"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a344c4ccf14d6a8842e83154a0aa99311">pa_context_unref</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c)</td></tr>
<tr class="memdesc:a344c4ccf14d6a8842e83154a0aa99311"><td class="mdescLeft"> </td><td class="mdescRight">Decrease the reference counter of the context by one. <a href="#a344c4ccf14d6a8842e83154a0aa99311">More...</a><br /></td></tr>
<tr class="separator:a344c4ccf14d6a8842e83154a0aa99311"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ba151a2c3b6b469d0b8bb1f905d6589"><td class="memItemLeft" align="right" valign="top"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a4ba151a2c3b6b469d0b8bb1f905d6589">pa_context_ref</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c)</td></tr>
<tr class="memdesc:a4ba151a2c3b6b469d0b8bb1f905d6589"><td class="mdescLeft"> </td><td class="mdescRight">Increase the reference counter of the context by one. <a href="#a4ba151a2c3b6b469d0b8bb1f905d6589">More...</a><br /></td></tr>
<tr class="separator:a4ba151a2c3b6b469d0b8bb1f905d6589"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb7b395fd3a345fc181d6bfcdbe5f3d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#aeb7b395fd3a345fc181d6bfcdbe5f3d8">pa_context_set_state_callback</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, <a class="el" href="context_8h.html#a19074e289d91ccae8dd58d15e912fc13">pa_context_notify_cb_t</a> cb, void *userdata)</td></tr>
<tr class="memdesc:aeb7b395fd3a345fc181d6bfcdbe5f3d8"><td class="mdescLeft"> </td><td class="mdescRight">Set a callback function that is called whenever the context status changes. <a href="#aeb7b395fd3a345fc181d6bfcdbe5f3d8">More...</a><br /></td></tr>
<tr class="separator:aeb7b395fd3a345fc181d6bfcdbe5f3d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4b3e8eaac460fb1b8109b0e3689c510"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#ac4b3e8eaac460fb1b8109b0e3689c510">pa_context_set_event_callback</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *p, <a class="el" href="context_8h.html#a039e0805d8276906397d4f55c78f13f4">pa_context_event_cb_t</a> cb, void *userdata)</td></tr>
<tr class="memdesc:ac4b3e8eaac460fb1b8109b0e3689c510"><td class="mdescLeft"> </td><td class="mdescRight">Set a callback function that is called whenever a meta/policy control event is received. <a href="#ac4b3e8eaac460fb1b8109b0e3689c510">More...</a><br /></td></tr>
<tr class="separator:ac4b3e8eaac460fb1b8109b0e3689c510"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8262c715ef8c48bcd2fbc5ae57a6df9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#aa8262c715ef8c48bcd2fbc5ae57a6df9">pa_context_errno</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c)</td></tr>
<tr class="memdesc:aa8262c715ef8c48bcd2fbc5ae57a6df9"><td class="mdescLeft"> </td><td class="mdescRight">Return the error number of the last failed operation. <a href="#aa8262c715ef8c48bcd2fbc5ae57a6df9">More...</a><br /></td></tr>
<tr class="separator:aa8262c715ef8c48bcd2fbc5ae57a6df9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad33a71b4d3b61e678b14091bdcfe98aa"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#ad33a71b4d3b61e678b14091bdcfe98aa">pa_context_is_pending</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c)</td></tr>
<tr class="memdesc:ad33a71b4d3b61e678b14091bdcfe98aa"><td class="mdescLeft"> </td><td class="mdescRight">Return non-zero if some data is pending to be written to the connection. <a href="#ad33a71b4d3b61e678b14091bdcfe98aa">More...</a><br /></td></tr>
<tr class="separator:ad33a71b4d3b61e678b14091bdcfe98aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a439b9a712321194390584737a0a7003f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="def_8h.html#a696774cc2f758448c5ab10c2dd786c9d">pa_context_state_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a439b9a712321194390584737a0a7003f">pa_context_get_state</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c)</td></tr>
<tr class="memdesc:a439b9a712321194390584737a0a7003f"><td class="mdescLeft"> </td><td class="mdescRight">Return the current context status. <a href="#a439b9a712321194390584737a0a7003f">More...</a><br /></td></tr>
<tr class="separator:a439b9a712321194390584737a0a7003f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a983ce13d45c5f4b0db8e1a34e21f9fce"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a983ce13d45c5f4b0db8e1a34e21f9fce">pa_context_connect</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, const char *server, <a class="el" href="def_8h.html#aa330581bb9b282e6f6a28a3a2b4b634a">pa_context_flags_t</a> flags, const <a class="el" href="structpa__spawn__api.html">pa_spawn_api</a> *api)</td></tr>
<tr class="memdesc:a983ce13d45c5f4b0db8e1a34e21f9fce"><td class="mdescLeft"> </td><td class="mdescRight">Connect the context to the specified server. <a href="#a983ce13d45c5f4b0db8e1a34e21f9fce">More...</a><br /></td></tr>
<tr class="separator:a983ce13d45c5f4b0db8e1a34e21f9fce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a154b9d8057adfbb2cecfbd9406a27660"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a154b9d8057adfbb2cecfbd9406a27660">pa_context_disconnect</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c)</td></tr>
<tr class="memdesc:a154b9d8057adfbb2cecfbd9406a27660"><td class="mdescLeft"> </td><td class="mdescRight">Terminate the context connection immediately. <a href="#a154b9d8057adfbb2cecfbd9406a27660">More...</a><br /></td></tr>
<tr class="separator:a154b9d8057adfbb2cecfbd9406a27660"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab94b42b05c233e010432888b7c496c50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#ab94b42b05c233e010432888b7c496c50">pa_context_drain</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, <a class="el" href="context_8h.html#a19074e289d91ccae8dd58d15e912fc13">pa_context_notify_cb_t</a> cb, void *userdata)</td></tr>
<tr class="memdesc:ab94b42b05c233e010432888b7c496c50"><td class="mdescLeft"> </td><td class="mdescRight">Drain the context. <a href="#ab94b42b05c233e010432888b7c496c50">More...</a><br /></td></tr>
<tr class="separator:ab94b42b05c233e010432888b7c496c50"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f664306d9e9be7603cd80e811b3c29a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a9f664306d9e9be7603cd80e811b3c29a">pa_context_exit_daemon</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, <a class="el" href="context_8h.html#a086b985c499c50efc628c267e8923fb1">pa_context_success_cb_t</a> cb, void *userdata)</td></tr>
<tr class="memdesc:a9f664306d9e9be7603cd80e811b3c29a"><td class="mdescLeft"> </td><td class="mdescRight">Tell the daemon to exit. <a href="#a9f664306d9e9be7603cd80e811b3c29a">More...</a><br /></td></tr>
<tr class="separator:a9f664306d9e9be7603cd80e811b3c29a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0710abf20bd14d140c77daded9b99dd1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a0710abf20bd14d140c77daded9b99dd1">pa_context_set_default_sink</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, const char *name, <a class="el" href="context_8h.html#a086b985c499c50efc628c267e8923fb1">pa_context_success_cb_t</a> cb, void *userdata)</td></tr>
<tr class="memdesc:a0710abf20bd14d140c77daded9b99dd1"><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the default sink. <a href="#a0710abf20bd14d140c77daded9b99dd1">More...</a><br /></td></tr>
<tr class="separator:a0710abf20bd14d140c77daded9b99dd1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac70ec892113745dc85d4045234fd0a33"><td class="memItemLeft" align="right" valign="top"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#ac70ec892113745dc85d4045234fd0a33">pa_context_set_default_source</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, const char *name, <a class="el" href="context_8h.html#a086b985c499c50efc628c267e8923fb1">pa_context_success_cb_t</a> cb, void *userdata)</td></tr>
<tr class="memdesc:ac70ec892113745dc85d4045234fd0a33"><td class="mdescLeft"> </td><td class="mdescRight">Set the name of the default source. <a href="#ac70ec892113745dc85d4045234fd0a33">More...</a><br /></td></tr>
<tr class="separator:ac70ec892113745dc85d4045234fd0a33"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5cb66d55f916f30b5ea13bd5d5c755a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#ae5cb66d55f916f30b5ea13bd5d5c755a">pa_context_is_local</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c)</td></tr>
<tr class="memdesc:ae5cb66d55f916f30b5ea13bd5d5c755a"><td class="mdescLeft"> </td><td class="mdescRight">Returns 1 when the connection is to a local daemon. <a href="#ae5cb66d55f916f30b5ea13bd5d5c755a">More...</a><br /></td></tr>
<tr class="separator:ae5cb66d55f916f30b5ea13bd5d5c755a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae50c0e777b009d2bdcd32a07a91b735a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#ae50c0e777b009d2bdcd32a07a91b735a">pa_context_set_name</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, const char *name, <a class="el" href="context_8h.html#a086b985c499c50efc628c267e8923fb1">pa_context_success_cb_t</a> cb, void *userdata)</td></tr>
<tr class="memdesc:ae50c0e777b009d2bdcd32a07a91b735a"><td class="mdescLeft"> </td><td class="mdescRight">Set a different application name for context on the server. <a href="#ae50c0e777b009d2bdcd32a07a91b735a">More...</a><br /></td></tr>
<tr class="separator:ae50c0e777b009d2bdcd32a07a91b735a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5708e81def9f3d08610f7b40815288b"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#af5708e81def9f3d08610f7b40815288b">pa_context_get_server</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c)</td></tr>
<tr class="memdesc:af5708e81def9f3d08610f7b40815288b"><td class="mdescLeft"> </td><td class="mdescRight">Return the server name this context is connected to. <a href="#af5708e81def9f3d08610f7b40815288b">More...</a><br /></td></tr>
<tr class="separator:af5708e81def9f3d08610f7b40815288b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4fb9f8705d000461b2be83626e9d5635"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a4fb9f8705d000461b2be83626e9d5635">pa_context_get_protocol_version</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c)</td></tr>
<tr class="memdesc:a4fb9f8705d000461b2be83626e9d5635"><td class="mdescLeft"> </td><td class="mdescRight">Return the protocol version of the library. <a href="#a4fb9f8705d000461b2be83626e9d5635">More...</a><br /></td></tr>
<tr class="separator:a4fb9f8705d000461b2be83626e9d5635"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a012b6b7fcef6fc05676ee7f57c4b5a54"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a012b6b7fcef6fc05676ee7f57c4b5a54">pa_context_get_server_protocol_version</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c)</td></tr>
<tr class="memdesc:a012b6b7fcef6fc05676ee7f57c4b5a54"><td class="mdescLeft"> </td><td class="mdescRight">Return the protocol version of the connected server. <a href="#a012b6b7fcef6fc05676ee7f57c4b5a54">More...</a><br /></td></tr>
<tr class="separator:a012b6b7fcef6fc05676ee7f57c4b5a54"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac119e0902d7c3bf0a89f11ff10f9dc37"><td class="memItemLeft" align="right" valign="top"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#ac119e0902d7c3bf0a89f11ff10f9dc37">pa_context_proplist_update</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, <a class="el" href="proplist_8h.html#a4b73cd513add16a26378a7941a9f1fd9">pa_update_mode_t</a> mode, <a class="el" href="proplist_8h.html#acdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p, <a class="el" href="context_8h.html#a086b985c499c50efc628c267e8923fb1">pa_context_success_cb_t</a> cb, void *userdata)</td></tr>
<tr class="memdesc:ac119e0902d7c3bf0a89f11ff10f9dc37"><td class="mdescLeft"> </td><td class="mdescRight">Update the property list of the client, adding new entries. <a href="#ac119e0902d7c3bf0a89f11ff10f9dc37">More...</a><br /></td></tr>
<tr class="separator:ac119e0902d7c3bf0a89f11ff10f9dc37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae81552ae12b6609cd086e2c17b96299c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#ae81552ae12b6609cd086e2c17b96299c">pa_context_proplist_remove</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, const char *const keys[], <a class="el" href="context_8h.html#a086b985c499c50efc628c267e8923fb1">pa_context_success_cb_t</a> cb, void *userdata)</td></tr>
<tr class="memdesc:ae81552ae12b6609cd086e2c17b96299c"><td class="mdescLeft"> </td><td class="mdescRight">Update the property list of the client, remove entries. <a href="#ae81552ae12b6609cd086e2c17b96299c">More...</a><br /></td></tr>
<tr class="separator:ae81552ae12b6609cd086e2c17b96299c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a406a75aeea9d97dcaa217d150b557581"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a406a75aeea9d97dcaa217d150b557581">pa_context_get_index</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *s)</td></tr>
<tr class="memdesc:a406a75aeea9d97dcaa217d150b557581"><td class="mdescLeft"> </td><td class="mdescRight">Return the client index this context is identified in the server with. <a href="#a406a75aeea9d97dcaa217d150b557581">More...</a><br /></td></tr>
<tr class="separator:a406a75aeea9d97dcaa217d150b557581"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a421e64ffc1a7851bd90558ccf8940e4e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mainloop-api_8h.html#a45b1a5f366caddb669789d5e69338f06">pa_time_event</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a421e64ffc1a7851bd90558ccf8940e4e">pa_context_rttime_new</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, <a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> usec, <a class="el" href="mainloop-api_8h.html#adbf3f332c476d00937c54d48ae1a0195">pa_time_event_cb_t</a> cb, void *userdata)</td></tr>
<tr class="memdesc:a421e64ffc1a7851bd90558ccf8940e4e"><td class="mdescLeft"> </td><td class="mdescRight">Create a new timer event source for the specified time (wrapper for mainloop->time_new). <a href="#a421e64ffc1a7851bd90558ccf8940e4e">More...</a><br /></td></tr>
<tr class="separator:a421e64ffc1a7851bd90558ccf8940e4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f1f002135f0f1ff0f4059d1d37ce4b3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a9f1f002135f0f1ff0f4059d1d37ce4b3">pa_context_rttime_restart</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, <a class="el" href="mainloop-api_8h.html#a45b1a5f366caddb669789d5e69338f06">pa_time_event</a> *e, <a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> usec)</td></tr>
<tr class="memdesc:a9f1f002135f0f1ff0f4059d1d37ce4b3"><td class="mdescLeft"> </td><td class="mdescRight">Restart a running or expired timer event source (wrapper for mainloop->time_restart). <a href="#a9f1f002135f0f1ff0f4059d1d37ce4b3">More...</a><br /></td></tr>
<tr class="separator:a9f1f002135f0f1ff0f4059d1d37ce4b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2792dda234b6cff98dac37aea1866dd3"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a2792dda234b6cff98dac37aea1866dd3">pa_context_get_tile_size</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> *ss)</td></tr>
<tr class="memdesc:a2792dda234b6cff98dac37aea1866dd3"><td class="mdescLeft"> </td><td class="mdescRight">Return the optimal block size for passing around audio buffers. <a href="#a2792dda234b6cff98dac37aea1866dd3">More...</a><br /></td></tr>
<tr class="separator:a2792dda234b6cff98dac37aea1866dd3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d3b9520e206d724c1e0c031879a3aa5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="context_8h.html#a5d3b9520e206d724c1e0c031879a3aa5">pa_context_load_cookie_from_file</a> (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, const char *cookie_file_path)</td></tr>
<tr class="memdesc:a5d3b9520e206d724c1e0c031879a3aa5"><td class="mdescLeft"> </td><td class="mdescRight">Load the authentication cookie from a file. <a href="#a5d3b9520e206d724c1e0c031879a3aa5">More...</a><br /></td></tr>
<tr class="separator:a5d3b9520e206d724c1e0c031879a3aa5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Connection contexts for asynchronous communication with a server. </p>
<p>A pa_context object wraps a connection to a PulseAudio server using its native protocol.</p>
<p>See also <a class="el" href="async.html">Asynchronous API</a> </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="aff56e9b3dd442a88227da084bb5c380a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff56e9b3dd442a88227da084bb5c380a">◆ </a></span>pa_context</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> <a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An opaque connection context to a daemon. </p>
</div>
</div>
<a id="a039e0805d8276906397d4f55c78f13f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a039e0805d8276906397d4f55c78f13f4">◆ </a></span>pa_context_event_cb_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* pa_context_event_cb_t) (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, const char *name, <a class="el" href="proplist_8h.html#acdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p, void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A callback for asynchronous meta/policy event messages. </p>
<p>The set of defined events can be extended at any time. Also, server modules may introduce additional message types so make sure that your callback function ignores messages it doesn't know. </p><dl class="section since"><dt>Since</dt><dd>0.9.15 </dd></dl>
</div>
</div>
<a id="a19074e289d91ccae8dd58d15e912fc13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19074e289d91ccae8dd58d15e912fc13">◆ </a></span>pa_context_notify_cb_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* pa_context_notify_cb_t) (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generic notification callback prototype. </p>
</div>
</div>
<a id="a086b985c499c50efc628c267e8923fb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a086b985c499c50efc628c267e8923fb1">◆ </a></span>pa_context_success_cb_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* pa_context_success_cb_t) (<a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> *c, int success, void *userdata)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A generic callback for operation completion. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a983ce13d45c5f4b0db8e1a34e21f9fce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a983ce13d45c5f4b0db8e1a34e21f9fce">◆ </a></span>pa_context_connect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_context_connect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="def_8h.html#aa330581bb9b282e6f6a28a3a2b4b634a">pa_context_flags_t</a> </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structpa__spawn__api.html">pa_spawn_api</a> * </td>
<td class="paramname"><em>api</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Connect the context to the specified server. </p>
<p>If server is NULL, connect to the default server. This routine may but will not always return synchronously on error. Use <a class="el" href="context_8h.html#aeb7b395fd3a345fc181d6bfcdbe5f3d8" title="Set a callback function that is called whenever the context status changes. ">pa_context_set_state_callback()</a> to be notified when the connection is established. If flags doesn't have PA_CONTEXT_NOAUTOSPAWN set and no specific server is specified or accessible a new daemon is spawned. If api is non-NULL, the functions specified in the structure are used when forking a new child process. </p>
</div>
</div>
<a id="a154b9d8057adfbb2cecfbd9406a27660"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a154b9d8057adfbb2cecfbd9406a27660">◆ </a></span>pa_context_disconnect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_context_disconnect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Terminate the context connection immediately. </p>
</div>
</div>
<a id="ab94b42b05c233e010432888b7c496c50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab94b42b05c233e010432888b7c496c50">◆ </a></span>pa_context_drain()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a>* pa_context_drain </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="context_8h.html#a19074e289d91ccae8dd58d15e912fc13">pa_context_notify_cb_t</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userdata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Drain the context. </p>
<p>If there is nothing to drain, the function returns NULL </p>
</div>
</div>
<a id="aa8262c715ef8c48bcd2fbc5ae57a6df9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8262c715ef8c48bcd2fbc5ae57a6df9">◆ </a></span>pa_context_errno()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_context_errno </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the error number of the last failed operation. </p>
</div>
</div>
<a id="a9f664306d9e9be7603cd80e811b3c29a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f664306d9e9be7603cd80e811b3c29a">◆ </a></span>pa_context_exit_daemon()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a>* pa_context_exit_daemon </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="context_8h.html#a086b985c499c50efc628c267e8923fb1">pa_context_success_cb_t</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userdata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell the daemon to exit. </p>
<p>The returned operation is unlikely to complete successfully, since the daemon probably died before returning a success notification </p>
</div>
</div>
<a id="a406a75aeea9d97dcaa217d150b557581"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a406a75aeea9d97dcaa217d150b557581">◆ </a></span>pa_context_get_index()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t pa_context_get_index </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the client index this context is identified in the server with. </p>
<p>This is useful for usage with the introspection functions, such as <a class="el" href="introspect_8h.html#a824553dc1dcedf3533f0074c78fa22dc" title="Get information about a client by its index. ">pa_context_get_client_info()</a>. </p><dl class="section since"><dt>Since</dt><dd>0.9.11 </dd></dl>
</div>
</div>
<a id="a4fb9f8705d000461b2be83626e9d5635"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fb9f8705d000461b2be83626e9d5635">◆ </a></span>pa_context_get_protocol_version()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t pa_context_get_protocol_version </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the protocol version of the library. </p>
</div>
</div>
<a id="af5708e81def9f3d08610f7b40815288b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5708e81def9f3d08610f7b40815288b">◆ </a></span>pa_context_get_server()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* pa_context_get_server </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the server name this context is connected to. </p>
</div>
</div>
<a id="a012b6b7fcef6fc05676ee7f57c4b5a54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a012b6b7fcef6fc05676ee7f57c4b5a54">◆ </a></span>pa_context_get_server_protocol_version()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t pa_context_get_server_protocol_version </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the protocol version of the connected server. </p>
</div>
</div>
<a id="a439b9a712321194390584737a0a7003f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a439b9a712321194390584737a0a7003f">◆ </a></span>pa_context_get_state()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="def_8h.html#a696774cc2f758448c5ab10c2dd786c9d">pa_context_state_t</a> pa_context_get_state </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the current context status. </p>
</div>
</div>
<a id="a2792dda234b6cff98dac37aea1866dd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2792dda234b6cff98dac37aea1866dd3">◆ </a></span>pa_context_get_tile_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t pa_context_get_tile_size </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> * </td>
<td class="paramname"><em>ss</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the optimal block size for passing around audio buffers. </p>
<p>It is recommended to allocate buffers of the size returned here when writing audio data to playback streams, if the latency constraints permit this. It is not recommended writing larger blocks than this because usually they will then be split up internally into chunks of this size. It is not recommended writing smaller blocks than this (unless required due to latency demands) because this increases CPU usage. If ss is NULL you will be returned the byte-exact tile size. If you pass a valid ss, then the tile size will be rounded down to multiple of the frame size. This is supposed to be used in a construct such as pa_context_get_tile_size(pa_stream_get_context(s), pa_stream_get_sample_spec(ss)); </p><dl class="section since"><dt>Since</dt><dd>0.9.20 </dd></dl>
</div>
</div>
<a id="ae5cb66d55f916f30b5ea13bd5d5c755a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5cb66d55f916f30b5ea13bd5d5c755a">◆ </a></span>pa_context_is_local()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_context_is_local </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns 1 when the connection is to a local daemon. </p>
<p>Returns negative when no connection has been made yet. </p>
</div>
</div>
<a id="ad33a71b4d3b61e678b14091bdcfe98aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad33a71b4d3b61e678b14091bdcfe98aa">◆ </a></span>pa_context_is_pending()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_context_is_pending </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return non-zero if some data is pending to be written to the connection. </p>
</div>
</div>
<a id="a5d3b9520e206d724c1e0c031879a3aa5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d3b9520e206d724c1e0c031879a3aa5">◆ </a></span>pa_context_load_cookie_from_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_context_load_cookie_from_file </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>cookie_file_path</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load the authentication cookie from a file. </p>
<p>This function is primarily meant for PulseAudio's own tunnel modules, which need to load the cookie from a custom location. Applications don't usually need to care about the cookie at all, but if it happens that you know what the authentication cookie is and your application needs to load it from a non-standard location, feel free to use this function. </p><dl class="section since"><dt>Since</dt><dd>5.0 </dd></dl>
</div>
</div>
<a id="a2784c754947a97f02c78b73d7b1c2d5f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2784c754947a97f02c78b73d7b1c2d5f">◆ </a></span>pa_context_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a>* pa_context_new </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> * </td>
<td class="paramname"><em>mainloop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Instantiate a new connection context with an abstract mainloop API and an application name. </p>
<p>It is recommended to use <a class="el" href="context_8h.html#a38182a2cd9439cd29d3cade7eb724405" title="Instantiate a new connection context with an abstract mainloop API and an application name...">pa_context_new_with_proplist()</a> instead and specify some initial properties. </p>
</div>
</div>
<a id="a38182a2cd9439cd29d3cade7eb724405"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38182a2cd9439cd29d3cade7eb724405">◆ </a></span>pa_context_new_with_proplist()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a>* pa_context_new_with_proplist </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structpa__mainloop__api.html">pa_mainloop_api</a> * </td>
<td class="paramname"><em>mainloop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="proplist_8h.html#acdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"><em>proplist</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Instantiate a new connection context with an abstract mainloop API and an application name, and specify the initial client property list. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.11 </dd></dl>
</div>
</div>
<a id="ae81552ae12b6609cd086e2c17b96299c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae81552ae12b6609cd086e2c17b96299c">◆ </a></span>pa_context_proplist_remove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a>* pa_context_proplist_remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *const </td>
<td class="paramname"><em>keys</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="context_8h.html#a086b985c499c50efc628c267e8923fb1">pa_context_success_cb_t</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userdata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Update the property list of the client, remove entries. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.11 </dd></dl>
</div>
</div>
<a id="ac119e0902d7c3bf0a89f11ff10f9dc37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac119e0902d7c3bf0a89f11ff10f9dc37">◆ </a></span>pa_context_proplist_update()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a>* pa_context_proplist_update </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="proplist_8h.html#a4b73cd513add16a26378a7941a9f1fd9">pa_update_mode_t</a> </td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="proplist_8h.html#acdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="context_8h.html#a086b985c499c50efc628c267e8923fb1">pa_context_success_cb_t</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userdata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Update the property list of the client, adding new entries. </p>
<p>Please note that it is highly recommended to set as much properties initially via <a class="el" href="context_8h.html#a38182a2cd9439cd29d3cade7eb724405" title="Instantiate a new connection context with an abstract mainloop API and an application name...">pa_context_new_with_proplist()</a> as possible instead a posteriori with this function, since that information may then be used to route streams of the client to the right device. </p><dl class="section since"><dt>Since</dt><dd>0.9.11 </dd></dl>
</div>
</div>
<a id="a4ba151a2c3b6b469d0b8bb1f905d6589"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ba151a2c3b6b469d0b8bb1f905d6589">◆ </a></span>pa_context_ref()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a>* pa_context_ref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Increase the reference counter of the context by one. </p>
</div>
</div>
<a id="a421e64ffc1a7851bd90558ccf8940e4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a421e64ffc1a7851bd90558ccf8940e4e">◆ </a></span>pa_context_rttime_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mainloop-api_8h.html#a45b1a5f366caddb669789d5e69338f06">pa_time_event</a>* pa_context_rttime_new </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> </td>
<td class="paramname"><em>usec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="mainloop-api_8h.html#adbf3f332c476d00937c54d48ae1a0195">pa_time_event_cb_t</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userdata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new timer event source for the specified time (wrapper for mainloop->time_new). </p>
<dl class="section since"><dt>Since</dt><dd>0.9.16 </dd></dl>
</div>
</div>
<a id="a9f1f002135f0f1ff0f4059d1d37ce4b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f1f002135f0f1ff0f4059d1d37ce4b3">◆ </a></span>pa_context_rttime_restart()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_context_rttime_restart </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="mainloop-api_8h.html#a45b1a5f366caddb669789d5e69338f06">pa_time_event</a> * </td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> </td>
<td class="paramname"><em>usec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Restart a running or expired timer event source (wrapper for mainloop->time_restart). </p>
<dl class="section since"><dt>Since</dt><dd>0.9.16 </dd></dl>
</div>
</div>
<a id="a0710abf20bd14d140c77daded9b99dd1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0710abf20bd14d140c77daded9b99dd1">◆ </a></span>pa_context_set_default_sink()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a>* pa_context_set_default_sink </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="context_8h.html#a086b985c499c50efc628c267e8923fb1">pa_context_success_cb_t</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userdata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the name of the default sink. </p>
</div>
</div>
<a id="ac70ec892113745dc85d4045234fd0a33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac70ec892113745dc85d4045234fd0a33">◆ </a></span>pa_context_set_default_source()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a>* pa_context_set_default_source </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="context_8h.html#a086b985c499c50efc628c267e8923fb1">pa_context_success_cb_t</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userdata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the name of the default source. </p>
</div>
</div>
<a id="ac4b3e8eaac460fb1b8109b0e3689c510"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4b3e8eaac460fb1b8109b0e3689c510">◆ </a></span>pa_context_set_event_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_context_set_event_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="context_8h.html#a039e0805d8276906397d4f55c78f13f4">pa_context_event_cb_t</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userdata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a callback function that is called whenever a meta/policy control event is received. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.15 </dd></dl>
</div>
</div>
<a id="ae50c0e777b009d2bdcd32a07a91b735a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae50c0e777b009d2bdcd32a07a91b735a">◆ </a></span>pa_context_set_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="operation_8h.html#a5614a07f2e7a129e4cb16596ed452a0c">pa_operation</a>* pa_context_set_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="context_8h.html#a086b985c499c50efc628c267e8923fb1">pa_context_success_cb_t</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userdata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a different application name for context on the server. </p>
</div>
</div>
<a id="aeb7b395fd3a345fc181d6bfcdbe5f3d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb7b395fd3a345fc181d6bfcdbe5f3d8">◆ </a></span>pa_context_set_state_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_context_set_state_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="context_8h.html#a19074e289d91ccae8dd58d15e912fc13">pa_context_notify_cb_t</a> </td>
<td class="paramname"><em>cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userdata</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a callback function that is called whenever the context status changes. </p>
</div>
</div>
<a id="a344c4ccf14d6a8842e83154a0aa99311"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a344c4ccf14d6a8842e83154a0aa99311">◆ </a></span>pa_context_unref()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_context_unref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="context_8h.html#aff56e9b3dd442a88227da084bb5c380a">pa_context</a> * </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decrease the reference counter of the context by one. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ec5b0a79aff2db41fe5d1b9326f09c28.html">pulse</a></li><li class="navelem"><a class="el" href="context_8h.html">context.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
a41e5ac5fb332416cb8019ae392f1f99
>
files
>
57
