/usr/share/gtk-doc/html/libdmapsharing-3.0/libdmapsharing-3.0-dacp-share.html is in libdmapsharing-3.0-dev 2.9.14-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>dacp-share</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libdmapsharing Reference Manual">
<link rel="up" href="ch04.html" title="Libdmapsharing Objects and Interfaces">
<link rel="prev" href="libdmapsharing-3.0-dpap-share.html" title="dpap-share">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libdmapsharing-3.0-dpap-share.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libdmapsharing Reference Manual</th>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libdmapsharing-3.0-dacp-share.synopsis" class="shortcut">Top</a>
|
<a href="#libdmapsharing-3.0-dacp-share.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libdmapsharing-3.0-dacp-share"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libdmapsharing-3.0-dacp-share.top_of_page"></a>dacp-share</span></h2>
<p>dacp-share</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libdmapsharing-3.0-dacp-share.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="libdmapsharing-3.0-dacp-share.html#DACP-TYPE-SHARE:CAPS" title="DACP_TYPE_SHARE">DACP_TYPE_SHARE</a>
#define <a class="link" href="libdmapsharing-3.0-dacp-share.html#DACP-SHARE:CAPS" title="DACP_SHARE()">DACP_SHARE</a> (o)
#define <a class="link" href="libdmapsharing-3.0-dacp-share.html#DACP-SHARE-CLASS:CAPS" title="DACP_SHARE_CLASS()">DACP_SHARE_CLASS</a> (k)
#define <a class="link" href="libdmapsharing-3.0-dacp-share.html#IS-DACP-SHARE:CAPS" title="IS_DACP_SHARE()">IS_DACP_SHARE</a> (o)
#define <a class="link" href="libdmapsharing-3.0-dacp-share.html#IS-DACP-SHARE-CLASS:CAPS" title="IS_DACP_SHARE_CLASS()">IS_DACP_SHARE_CLASS</a> (k)
#define <a class="link" href="libdmapsharing-3.0-dacp-share.html#DACP-SHARE-GET-CLASS:CAPS" title="DACP_SHARE_GET_CLASS()">DACP_SHARE_GET_CLASS</a> (o)
typedef <a class="link" href="libdmapsharing-3.0-dacp-share.html#DACPSharePrivate" title="DACPSharePrivate">DACPSharePrivate</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (<a class="link" href="libdmapsharing-3.0-dacp-share.html#lookup-guid" title="lookup_guid ()">*lookup_guid</a>) (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *guid</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="libdmapsharing-3.0-dacp-share.html#add-guid" title="add_guid ()">*add_guid</a>) (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *guid</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="libdmapsharing-3.0-dacp-share.html#remote-found" title="remote_found ()">*remote_found</a>) (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *service_name</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *remote_name</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="libdmapsharing-3.0-dacp-share.html#remote-lost" title="remote_lost ()">*remote_lost</a>) (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *service_name</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="libdmapsharing-3.0-dacp-share.html#remote-paired" title="remote_paired ()">*remote_paired</a>) (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *service_name</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> connected</code></em>);
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="libdmapsharing-3.0-dacp-share.html#dacp-share-get-type" title="dacp_share_get_type ()">dacp_share_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">DACPShare</span> * <a class="link" href="libdmapsharing-3.0-dacp-share.html#dacp-share-new" title="dacp_share_new ()">dacp_share_new</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *library_name</code></em>,
<em class="parameter"><code><span class="type">DACPPlayer</span> *player</code></em>,
<em class="parameter"><code><a class="link" href="DMAPDb.html" title="DMAPDb"><span class="type">DMAPDb</span></a> *db</code></em>,
<em class="parameter"><code><a class="link" href="DMAPContainerDb.html" title="DMAPContainerDb"><span class="type">DMAPContainerDb</span></a> *container_db</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libdmapsharing-3.0-dacp-share.html#dacp-share-pair" title="dacp_share_pair ()">dacp_share_pair</a> (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *service_name</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> passcode[4]</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libdmapsharing-3.0-dacp-share.html#dacp-share-start-lookup" title="dacp_share_start_lookup ()">dacp_share_start_lookup</a> (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libdmapsharing-3.0-dacp-share.html#dacp-share-stop-lookup" title="dacp_share_stop_lookup ()">dacp_share_stop_lookup</a> (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libdmapsharing-3.0-dacp-share.html#dacp-share-player-updated" title="dacp_share_player_updated ()">dacp_share_player_updated</a> (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libdmapsharing-3.0-dacp-share.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libdmapsharing-3.0-dacp-share.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="DACP-TYPE-SHARE:CAPS"></a><h3>DACP_TYPE_SHARE</h3>
<pre class="programlisting">#define DACP_TYPE_SHARE (dacp_share_get_type ())
</pre>
<p>
The type for <span class="type">DACPShare</span>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="DACP-SHARE:CAPS"></a><h3>DACP_SHARE()</h3>
<pre class="programlisting">#define DACP_SHARE(o)</pre>
<p>
Casts a <span class="type">DACPShare</span> or derived pointer into a (DACPShare*) pointer.
Depending on the current debugging level, this function may invoke
certain runtime checks to identify invalid casts.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>o</code></em> :</span></p></td>
<td>Object which is subject to casting.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="DACP-SHARE-CLASS:CAPS"></a><h3>DACP_SHARE_CLASS()</h3>
<pre class="programlisting">#define DACP_SHARE_CLASS(k)</pre>
<p>
Casts a derived <span class="type">DACPShareClass</span> structure into a <span class="type">DACPShareClass</span> structure.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>k</code></em> :</span></p></td>
<td>a valid <span class="type">DACPShareClass</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="IS-DACP-SHARE:CAPS"></a><h3>IS_DACP_SHARE()</h3>
<pre class="programlisting">#define IS_DACP_SHARE(o)</pre>
<p>
Checks whether a valid <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInstance"><span class="type">GTypeInstance</span></a> pointer is of type <a class="link" href="libdmapsharing-3.0-dacp-share.html#DACP-TYPE-SHARE:CAPS" title="DACP_TYPE_SHARE"><code class="literal">DACP_TYPE_SHARE</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>o</code></em> :</span></p></td>
<td>Instance to check for being a <a class="link" href="libdmapsharing-3.0-dacp-share.html#DACP-TYPE-SHARE:CAPS" title="DACP_TYPE_SHARE"><code class="literal">DACP_TYPE_SHARE</code></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="IS-DACP-SHARE-CLASS:CAPS"></a><h3>IS_DACP_SHARE_CLASS()</h3>
<pre class="programlisting">#define IS_DACP_SHARE_CLASS(k)</pre>
<p>
Checks whether <em class="parameter"><code>k</code></em> "is a" valid <span class="type">DACPShareClass</span> structure of type
<a class="link" href="libdmapsharing-3.0-dacp-share.html#DACP-SHARE:CAPS" title="DACP_SHARE()"><code class="literal">DACP_SHARE</code></a> or derived.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>k</code></em> :</span></p></td>
<td>a <span class="type">DACPShareClass</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="DACP-SHARE-GET-CLASS:CAPS"></a><h3>DACP_SHARE_GET_CLASS()</h3>
<pre class="programlisting">#define DACP_SHARE_GET_CLASS(o)</pre>
<p>
Get the class structure associated to a <span class="type">DACPShare</span> instance.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>o</code></em> :</span></p></td>
<td>a <span class="type">DACPShare</span> instance.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>pointer to object class structure.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="DACPSharePrivate"></a><h3>DACPSharePrivate</h3>
<pre class="programlisting">typedef struct DACPSharePrivate DACPSharePrivate;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="lookup-guid"></a><h3>lookup_guid ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (*lookup_guid) (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *guid</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="add-guid"></a><h3>add_guid ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*add_guid) (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *guid</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="remote-found"></a><h3>remote_found ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*remote_found) (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *service_name</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *remote_name</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="remote-lost"></a><h3>remote_lost ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*remote_lost) (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *service_name</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="remote-paired"></a><h3>remote_paired ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*remote_paired) (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *service_name</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> connected</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="dacp-share-get-type"></a><h3>dacp_share_get_type ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> dacp_share_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="dacp-share-new"></a><h3>dacp_share_new ()</h3>
<pre class="programlisting"><span class="returnvalue">DACPShare</span> * dacp_share_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *library_name</code></em>,
<em class="parameter"><code><span class="type">DACPPlayer</span> *player</code></em>,
<em class="parameter"><code><a class="link" href="DMAPDb.html" title="DMAPDb"><span class="type">DMAPDb</span></a> *db</code></em>,
<em class="parameter"><code><a class="link" href="DMAPContainerDb.html" title="DMAPContainerDb"><span class="type">DMAPContainerDb</span></a> *container_db</code></em>);</pre>
<p>
Creates a new DACP share and publishes it using mDNS.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>library_name</code></em> :</span></p></td>
<td>The library name that will be shown in the remote.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>player</code></em> :</span></p></td>
<td>A <span class="type">DACPPlayer</span> instance, used to retrieve information from a player
implementation.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>db</code></em> :</span></p></td>
<td>a media database represented by a <a class="link" href="DMAPDb.html" title="DMAPDb"><span class="type">DMAPDb</span></a> instance.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>container_db</code></em> :</span></p></td>
<td>a container (album) database represented by a <a class="link" href="DMAPContainerDb.html" title="DMAPContainerDb"><span class="type">DMAPContainerDb</span></a>
instance.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to a <span class="type">DACPShare</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="dacp-share-pair"></a><h3>dacp_share_pair ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> dacp_share_pair (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *service_name</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> passcode[4]</code></em>);</pre>
<p>
Pairs a DACP client (Remote) with this server. If the passcode is
correct (the same as shown on the remote), the remote will start connecting
to this server.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>share</code></em> :</span></p></td>
<td>a <span class="type">DACPShare</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>service_name</code></em> :</span></p></td>
<td>DACP client (remote) service identifier.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>passcode</code></em> :</span></p></td>
<td>4-Digit PIN code entered by the user.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="dacp-share-start-lookup"></a><h3>dacp_share_start_lookup ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> dacp_share_start_lookup (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>);</pre>
<p>
Start looking up for DACP remotes. Connect to <span class="type">"remote-found"</span> signal
to detect new remotes. Be aware that when a <span class="type">DACPShare</span> is created, only
after calling this function is that it starts looking up for Remotes on the
network.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>share</code></em> :</span></p></td>
<td>A <span class="type">DACPShare</span>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="dacp-share-stop-lookup"></a><h3>dacp_share_stop_lookup ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> dacp_share_stop_lookup (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>);</pre>
<p>
Stop looking up for DACP remotes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>share</code></em> :</span></p></td>
<td>A <span class="type">DACPShare</span>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="dacp-share-player-updated"></a><h3>dacp_share_player_updated ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> dacp_share_player_updated (<em class="parameter"><code><span class="type">DACPShare</span> *share</code></em>);</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|