/usr/share/doc/libtelepathy-glib-doc/telepathy-glib/TpBaseMediaCallContent.html is in libtelepathy-glib-doc 0.18.0-1ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TpBaseMediaCallContent</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="telepathy-glib API Reference Manual">
<link rel="up" href="ch-service-base.html" title="Service-side implementation">
<link rel="prev" href="TpBaseCallContent.html" title="TpBaseCallContent">
<link rel="next" href="TpCallContentMediaDescription.html" title="TpCallContentMediaDescription">
<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="TpBaseCallContent.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch-service-base.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">telepathy-glib API Reference Manual</th>
<td><a accesskey="n" href="TpCallContentMediaDescription.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#TpBaseMediaCallContent.synopsis" class="shortcut">Top</a>
|
<a href="#TpBaseMediaCallContent.description" class="shortcut">Description</a>
|
<a href="#TpBaseMediaCallContent.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#TpBaseMediaCallContent.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#TpBaseMediaCallContent.properties" class="shortcut">Properties</a>
|
<a href="#TpBaseMediaCallContent.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="TpBaseMediaCallContent"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="TpBaseMediaCallContent.top_of_page"></a>TpBaseMediaCallContent</span></h2>
<p>TpBaseMediaCallContent — base class for <a class="link" href="telepathy-glib-svc-channel-call.html#TpSvcCallContentInterfaceMedia"><span class="type">TpSvcCallContentInterfaceMedia</span></a>
implementations</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="TpBaseMediaCallContent.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <telepathy-glib/telepathy-glib.h>
<a class="link" href="TpBaseMediaCallContent.html#TpBaseMediaCallContent-struct" title="TpBaseMediaCallContent">TpBaseMediaCallContent</a>;
struct <a class="link" href="TpBaseMediaCallContent.html#TpBaseMediaCallContentClass" title="struct TpBaseMediaCallContentClass">TpBaseMediaCallContentClass</a>;
<span class="returnvalue">GHashTable</span> * <a class="link" href="TpBaseMediaCallContent.html#tp-base-media-call-content-get-local-media-description" title="tp_base_media_call_content_get_local_media_description ()">tp_base_media_call_content_get_local_media_description</a>
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallContent.html" title="TpBaseMediaCallContent"><span class="type">TpBaseMediaCallContent</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> contact</code></em>);
<span class="returnvalue">void</span> <a class="link" href="TpBaseMediaCallContent.html#tp-base-media-call-content-offer-media-description-async" title="tp_base_media_call_content_offer_media_description_async ()">tp_base_media_call_content_offer_media_description_async</a>
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallContent.html" title="TpBaseMediaCallContent"><span class="type">TpBaseMediaCallContent</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="TpCallContentMediaDescription.html" title="TpCallContentMediaDescription"><span class="type">TpCallContentMediaDescription</span></a> *md</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="TpBaseMediaCallContent.html#tp-base-media-call-content-offer-media-description-finish" title="tp_base_media_call_content_offer_media_description_finish ()">tp_base_media_call_content_offer_media_description_finish</a>
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallContent.html" title="TpBaseMediaCallContent"><span class="type">TpBaseMediaCallContent</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="TpBaseMediaCallContent.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="TpBaseCallContent.html" title="TpBaseCallContent">TpBaseCallContent</a>
+----TpBaseMediaCallContent
</pre>
</div>
<div class="refsect1">
<a name="TpBaseMediaCallContent.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
TpBaseMediaCallContent implements
<a class="link" href="telepathy-glib-svc-generic.html#TpSvcDBusProperties">TpSvcDBusProperties</a>, <a class="link" href="telepathy-glib-svc-channel-call.html#TpSvcCallContent">TpSvcCallContent</a>, <a class="link" href="telepathy-glib-svc-channel-call.html#TpSvcCallContentInterfaceDTMF">TpSvcCallContentInterfaceDTMF</a> and <a class="link" href="telepathy-glib-svc-channel-call.html#TpSvcCallContentInterfaceMedia">TpSvcCallContentInterfaceMedia</a>.</p>
</div>
<div class="refsect1">
<a name="TpBaseMediaCallContent.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="TpBaseMediaCallContent.html#TpBaseMediaCallContent--current-dtmf-event" title='The "current-dtmf-event" property'>current-dtmf-event</a>" <span class="type">guchar</span> : Read
"<a class="link" href="TpBaseMediaCallContent.html#TpBaseMediaCallContent--current-dtmf-state" title='The "current-dtmf-state" property'>current-dtmf-state</a>" <span class="type">guint</span> : Read
"<a class="link" href="TpBaseMediaCallContent.html#TpBaseMediaCallContent--local-media-descriptions" title='The "local-media-descriptions" property'>local-media-descriptions</a>" <span class="type">GHashTable_guint+GHashTable_gchararray+GValue__*</span> : Read
"<a class="link" href="TpBaseMediaCallContent.html#TpBaseMediaCallContent--media-description-offer" title='The "media-description-offer" property'>media-description-offer</a>" <span class="type">GValueArray_DBusGObjectPath+GHashTable_gchararray+GValue__*</span> : Read
"<a class="link" href="TpBaseMediaCallContent.html#TpBaseMediaCallContent--packetization" title='The "packetization" property'>packetization</a>" <span class="type">guint</span> : Read / Write / Construct Only
"<a class="link" href="TpBaseMediaCallContent.html#TpBaseMediaCallContent--remote-media-descriptions" title='The "remote-media-descriptions" property'>remote-media-descriptions</a>" <span class="type">GHashTable_guint+GHashTable_gchararray+GValue__*</span> : Read
</pre>
</div>
<div class="refsect1">
<a name="TpBaseMediaCallContent.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="TpBaseMediaCallContent.html#TpBaseMediaCallContent-local-media-description-updated" title='The "local-media-description-updated" signal'>local-media-description-updated</a>" : <code class="literal">Run Last</code>
</pre>
</div>
<div class="refsect1">
<a name="TpBaseMediaCallContent.description"></a><h2>Description</h2>
<p>
This base class makes it easier to write <a class="link" href="telepathy-glib-svc-channel-call.html#TpSvcCallContentInterfaceMedia"><span class="type">TpSvcCallContentInterfaceMedia</span></a>
implementations by implementing its properties and methods.
</p>
<p>
Subclasses must still implement <a class="link" href="TpBaseCallContent.html" title="TpBaseCallContent"><span class="type">TpBaseCallContent</span></a>'s virtual methods.
</p>
</div>
<div class="refsect1">
<a name="TpBaseMediaCallContent.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="TpBaseMediaCallContent-struct"></a><h3>TpBaseMediaCallContent</h3>
<pre class="programlisting">typedef struct _TpBaseMediaCallContent TpBaseMediaCallContent;</pre>
<p>
A base class for media call content implementations
</p>
<p class="since">Since 0.17.5</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseMediaCallContentClass"></a><h3>struct TpBaseMediaCallContentClass</h3>
<pre class="programlisting">struct TpBaseMediaCallContentClass {
};
</pre>
<p>
The class structure for <a class="link" href="TpBaseMediaCallContent.html" title="TpBaseMediaCallContent"><span class="type">TpBaseMediaCallContent</span></a>
</p>
<p class="since">Since 0.17.5</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-base-media-call-content-get-local-media-description"></a><h3>tp_base_media_call_content_get_local_media_description ()</h3>
<pre class="programlisting"><span class="returnvalue">GHashTable</span> * tp_base_media_call_content_get_local_media_description
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallContent.html" title="TpBaseMediaCallContent"><span class="type">TpBaseMediaCallContent</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> contact</code></em>);</pre>
<p>
Get the media description used to stream to <em class="parameter"><code>contact</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="TpBaseMediaCallContent.html" title="TpBaseMediaCallContent"><span class="type">TpBaseMediaCallContent</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>contact</code></em> :</span></p></td>
<td>the contact</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>borrowed <span class="type">GHashTable</span> mapping iface propery string to <span class="type">GValue</span>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.5</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-base-media-call-content-offer-media-description-async"></a><h3>tp_base_media_call_content_offer_media_description_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> tp_base_media_call_content_offer_media_description_async
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallContent.html" title="TpBaseMediaCallContent"><span class="type">TpBaseMediaCallContent</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="TpCallContentMediaDescription.html" title="TpCallContentMediaDescription"><span class="type">TpCallContentMediaDescription</span></a> *md</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
Offer <em class="parameter"><code>md</code></em> for media description negociation.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="TpBaseMediaCallContent.html" title="TpBaseMediaCallContent"><span class="type">TpBaseMediaCallContent</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
<td>a <a class="link" href="TpCallContentMediaDescription.html" title="TpCallContentMediaDescription"><span class="type">TpCallContentMediaDescription</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>a callback to call when the operation finishes</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to <em class="parameter"><code>callback</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.5</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-base-media-call-content-offer-media-description-finish"></a><h3>tp_base_media_call_content_offer_media_description_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> tp_base_media_call_content_offer_media_description_finish
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallContent.html" title="TpBaseMediaCallContent"><span class="type">TpBaseMediaCallContent</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Finishes <a class="link" href="TpBaseMediaCallContent.html#tp-base-media-call-content-offer-media-description-async" title="tp_base_media_call_content_offer_media_description_async ()"><code class="function">tp_base_media_call_content_offer_media_description_async()</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>self</code></em> :</span></p></td>
<td>a <a class="link" href="TpBaseMediaCallContent.html" title="TpBaseMediaCallContent"><span class="type">TpBaseMediaCallContent</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>a <span class="type">GAsyncResult</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <span class="type">GError</span> to fill</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.5</p>
</div>
</div>
<div class="refsect1">
<a name="TpBaseMediaCallContent.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="TpBaseMediaCallContent--current-dtmf-event"></a><h3>The <code class="literal">"current-dtmf-event"</code> property</h3>
<pre class="programlisting"> "current-dtmf-event" <span class="type">guchar</span> : Read</pre>
<p>
The currently being played <a class="link" href="telepathy-glib-enums.html#TpDTMFEvent" title="enum TpDTMFEvent"><span class="type">TpDTMFEvent</span></a> if any
</p>
<p>Allowed values: <= 15</p>
<p>Default value: 0</p>
<p class="since">Since 0.17.5</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseMediaCallContent--current-dtmf-state"></a><h3>The <code class="literal">"current-dtmf-state"</code> property</h3>
<pre class="programlisting"> "current-dtmf-state" <span class="type">guint</span> : Read</pre>
<p>
The <a class="link" href="telepathy-glib-enums.html#TpSendingState" title="enum TpSendingState"><span class="type">TpSendingState</span></a> of the dtmf events
</p>
<p>Allowed values: <= 3</p>
<p>Default value: 0</p>
<p class="since">Since 0.17.5</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseMediaCallContent--local-media-descriptions"></a><h3>The <code class="literal">"local-media-descriptions"</code> property</h3>
<pre class="programlisting"> "local-media-descriptions" <span class="type">GHashTable_guint+GHashTable_gchararray+GValue__*</span> : Read</pre>
<p>
<span class="type">GHashTable</span>{contact <a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a>, properties <span class="type">GHashTable</span>}
The map of contacts to local media descriptions.
</p>
<p class="since">Since 0.17.5</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseMediaCallContent--media-description-offer"></a><h3>The <code class="literal">"media-description-offer"</code> property</h3>
<pre class="programlisting"> "media-description-offer" <span class="type">GValueArray_DBusGObjectPath+GHashTable_gchararray+GValue__*</span> : Read</pre>
<p>
<span class="type">GValueArray</span>{object-path, contact <a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a>, properties <span class="type">GHashTable</span>}.
The current media description offer if any.
</p>
<p class="since">Since 0.17.5</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseMediaCallContent--packetization"></a><h3>The <code class="literal">"packetization"</code> property</h3>
<pre class="programlisting"> "packetization" <span class="type">guint</span> : Read / Write / Construct Only</pre>
<p>
The <a class="link" href="telepathy-glib-enums.html#TpCallContentPacketizationType" title="enum TpCallContentPacketizationType"><span class="type">TpCallContentPacketizationType</span></a> of this content.
</p>
<p>Default value: 0</p>
<p class="since">Since 0.17.5</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseMediaCallContent--remote-media-descriptions"></a><h3>The <code class="literal">"remote-media-descriptions"</code> property</h3>
<pre class="programlisting"> "remote-media-descriptions" <span class="type">GHashTable_guint+GHashTable_gchararray+GValue__*</span> : Read</pre>
<p>
<span class="type">GHashTable</span>{contact <a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a>, properties <span class="type">GHashTable</span>}
The map of contacts to remote media descriptions.
</p>
<p class="since">Since 0.17.5</p>
</div>
</div>
<div class="refsect1">
<a name="TpBaseMediaCallContent.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="TpBaseMediaCallContent-local-media-description-updated"></a><h3>The <code class="literal">"local-media-description-updated"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="TpBaseMediaCallContent.html" title="TpBaseMediaCallContent"><span class="type">TpBaseMediaCallContent</span></a> *self,
<span class="type">guint</span> contact,
<span class="type">GHashTable</span> *properties,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
<p>
The ::local-media-description-changed signal is emitted whenever the local
media description changes for a remote contact.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the <a class="link" href="telepathy-glib-call-channel.html#TpCallChannel"><span class="type">TpCallChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>contact</code></em> :</span></p></td>
<td>the remote contact</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>properties</code></em> :</span></p></td>
<td>the new media description properties asv</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.5</p>
</div>
</div>
<div class="refsect1">
<a name="TpBaseMediaCallContent.see-also"></a><h2>See Also</h2>
<a class="link" href="telepathy-glib-svc-channel-call.html#TpSvcCallContentInterfaceMedia"><span class="type">TpSvcCallContentInterfaceMedia</span></a>, <a class="link" href="TpBaseCallChannel.html" title="TpBaseCallChannel"><span class="type">TpBaseCallChannel</span></a>,
<a class="link" href="TpBaseCallContent.html" title="TpBaseCallContent"><span class="type">TpBaseCallContent</span></a> and <a class="link" href="TpBaseCallStream.html" title="TpBaseCallStream"><span class="type">TpBaseCallStream</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|