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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TpBaseMediaCallChannel</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.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="TpBaseCallChannel.html" title="TpBaseCallChannel">
<link rel="next" href="TpBaseCallContent.html" title="TpBaseCallContent">
<meta name="generator" content="GTK-Doc V1.19 (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="TpBaseCallChannel.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="TpBaseCallContent.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#TpBaseMediaCallChannel.synopsis" class="shortcut">Top</a>
|
<a href="#TpBaseMediaCallChannel.description" class="shortcut">Description</a>
|
<a href="#TpBaseMediaCallChannel.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#TpBaseMediaCallChannel.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
</td></tr>
</table>
<div class="refentry">
<a name="TpBaseMediaCallChannel"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="TpBaseMediaCallChannel.top_of_page"></a>TpBaseMediaCallChannel</span></h2>
<p>TpBaseMediaCallChannel — base class for <a class="link" href="telepathy-glib-svc-channel-call.html#TpSvcChannelTypeCall"><span class="type">TpSvcChannelTypeCall</span></a> RTP media implementations</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="TpBaseMediaCallChannel.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <telepathy-glib/telepathy-glib.h>
<a class="link" href="TpBaseMediaCallChannel.html#TpBaseMediaCallChannel-struct" title="TpBaseMediaCallChannel">TpBaseMediaCallChannel</a>;
struct <a class="link" href="TpBaseMediaCallChannel.html#TpBaseMediaCallChannelClass" title="struct TpBaseMediaCallChannelClass">TpBaseMediaCallChannelClass</a>;
<span class="returnvalue">void</span> (<a class="link" href="TpBaseMediaCallChannel.html#TpBaseMediaCallChannelHoldStateChangedFunc" title="TpBaseMediaCallChannelHoldStateChangedFunc ()">*TpBaseMediaCallChannelHoldStateChangedFunc</a>)
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallChannel.html" title="TpBaseMediaCallChannel"><span class="type">TpBaseMediaCallChannel</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpLocalHoldState" title="enum TpLocalHoldState"><span class="type">TpLocalHoldState</span></a> hold_state</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpLocalHoldStateReason" title="enum TpLocalHoldStateReason"><span class="type">TpLocalHoldStateReason</span></a> hold_state_reason</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="TpBaseMediaCallChannel.html#TpBaseMediaCallChannelVoidFunc" title="TpBaseMediaCallChannelVoidFunc ()">*TpBaseMediaCallChannelVoidFunc</a>) (<em class="parameter"><code><a class="link" href="TpBaseMediaCallChannel.html" title="TpBaseMediaCallChannel"><span class="type">TpBaseMediaCallChannel</span></a> *self</code></em>);
<a class="link" href="telepathy-glib-enums.html#TpLocalHoldState" title="enum TpLocalHoldState"><span class="returnvalue">TpLocalHoldState</span></a> <a class="link" href="TpBaseMediaCallChannel.html#tp-base-media-call-channel-get-local-hold-state" title="tp_base_media_call_channel_get_local_hold_state ()">tp_base_media_call_channel_get_local_hold_state</a>
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallChannel.html" title="TpBaseMediaCallChannel"><span class="type">TpBaseMediaCallChannel</span></a> *channel</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpLocalHoldStateReason" title="enum TpLocalHoldStateReason"><span class="type">TpLocalHoldStateReason</span></a> *reason</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="TpBaseMediaCallChannel.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a class="link" href="TpBaseChannel.html" title="TpBaseChannel">TpBaseChannel</a>
+----<a class="link" href="TpBaseCallChannel.html" title="TpBaseCallChannel">TpBaseCallChannel</a>
+----TpBaseMediaCallChannel
</pre>
</div>
<div class="refsect1">
<a name="TpBaseMediaCallChannel.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
TpBaseMediaCallChannel implements
<a class="link" href="telepathy-glib-svc-generic.html#TpSvcDBusProperties">TpSvcDBusProperties</a>, <a class="link" href="telepathy-glib-svc-channel.html#TpSvcChannel">TpSvcChannel</a>, <a class="link" href="TpChannelIface.html" title="TpChannelIface">TpChannelIface</a>, <a class="link" href="TpExportableChannel.html" title="TpExportableChannel">TpExportableChannel</a>, <a class="link" href="telepathy-glib-svc-channel-call.html#TpSvcChannelTypeCall">TpSvcChannelTypeCall</a>, <a class="link" href="telepathy-glib-svc-channel-media.html#TpSvcChannelInterfaceDTMF">TpSvcChannelInterfaceDTMF</a> and <a class="link" href="telepathy-glib-svc-channel-media.html#TpSvcChannelInterfaceHold">TpSvcChannelInterfaceHold</a>.</p>
</div>
<div class="refsect1">
<a name="TpBaseMediaCallChannel.description"></a><h2>Description</h2>
<p>
This is a base class for connection managers that use standard RTP media.
</p>
</div>
<div class="refsect1">
<a name="TpBaseMediaCallChannel.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="TpBaseMediaCallChannel-struct"></a><h3>TpBaseMediaCallChannel</h3>
<pre class="programlisting">typedef struct _TpBaseMediaCallChannel TpBaseMediaCallChannel;</pre>
<p>
A base class for call channel implementations with standard RTP
</p>
<p class="since">Since 0.17.5</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseMediaCallChannelClass"></a><h3>struct TpBaseMediaCallChannelClass</h3>
<pre class="programlisting">struct TpBaseMediaCallChannelClass {
TpBaseMediaCallChannelHoldStateChangedFunc hold_state_changed;
TpBaseMediaCallChannelVoidFunc accept;
};
</pre>
<p>
The class structure for <a class="link" href="TpBaseMediaCallChannel.html" title="TpBaseMediaCallChannel"><span class="type">TpBaseMediaCallChannel</span></a>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="TpBaseMediaCallChannel.html#TpBaseMediaCallChannelHoldStateChangedFunc" title="TpBaseMediaCallChannelHoldStateChangedFunc ()"><span class="type">TpBaseMediaCallChannelHoldStateChangedFunc</span></a> <em class="structfield"><code><a name="TpBaseMediaCallChannelClass.hold-state-changed"></a>hold_state_changed</code></em>;</span></p></td>
<td>optional; virtual method called when the hold state
changed</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="TpBaseMediaCallChannel.html#TpBaseMediaCallChannelVoidFunc" title="TpBaseMediaCallChannelVoidFunc ()"><span class="type">TpBaseMediaCallChannelVoidFunc</span></a> <em class="structfield"><code><a name="TpBaseMediaCallChannelClass.accept"></a>accept</code></em>;</span></p></td>
<td>optional; virtual method called when the call is locally accepted
and contents are ready. This replaces <a class="link" href="TpBaseCallChannel.html#TpBaseCallChannelClass.accept"><span class="type">TpBaseCallChannelClass.accept</span></a>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.5</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseMediaCallChannelHoldStateChangedFunc"></a><h3>TpBaseMediaCallChannelHoldStateChangedFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*TpBaseMediaCallChannelHoldStateChangedFunc)
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallChannel.html" title="TpBaseMediaCallChannel"><span class="type">TpBaseMediaCallChannel</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpLocalHoldState" title="enum TpLocalHoldState"><span class="type">TpLocalHoldState</span></a> hold_state</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpLocalHoldStateReason" title="enum TpLocalHoldStateReason"><span class="type">TpLocalHoldStateReason</span></a> hold_state_reason</code></em>);</pre>
<p>
Signature of an implementation of
<a class="link" href="TpBaseMediaCallChannel.html#TpBaseMediaCallChannelClass.hold-state-changed"><span class="type">TpBaseMediaCallChannelClass.hold_state_changed</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="TpBaseMediaCallChannel.html" title="TpBaseMediaCallChannel"><span class="type">TpBaseMediaCallChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>hold_state</code></em> :</span></p></td>
<td>the new <a class="link" href="telepathy-glib-enums.html#TpLocalHoldState" title="enum TpLocalHoldState"><span class="type">TpLocalHoldState</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>hold_state_reason</code></em> :</span></p></td>
<td>the <a class="link" href="telepathy-glib-enums.html#TpLocalHoldStateReason" title="enum TpLocalHoldStateReason"><span class="type">TpLocalHoldStateReason</span></a> for this change</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.5</p>
</div>
<hr>
<div class="refsect2">
<a name="TpBaseMediaCallChannelVoidFunc"></a><h3>TpBaseMediaCallChannelVoidFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*TpBaseMediaCallChannelVoidFunc) (<em class="parameter"><code><a class="link" href="TpBaseMediaCallChannel.html" title="TpBaseMediaCallChannel"><span class="type">TpBaseMediaCallChannel</span></a> *self</code></em>);</pre>
<p>
Signature of an implementation of <a class="link" href="TpBaseMediaCallChannel.html#TpBaseMediaCallChannelClass.accept"><span class="type">TpBaseMediaCallChannelClass.accept</span></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="TpBaseMediaCallChannel.html" title="TpBaseMediaCallChannel"><span class="type">TpBaseMediaCallChannel</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.17.5</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-base-media-call-channel-get-local-hold-state"></a><h3>tp_base_media_call_channel_get_local_hold_state ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-enums.html#TpLocalHoldState" title="enum TpLocalHoldState"><span class="returnvalue">TpLocalHoldState</span></a> tp_base_media_call_channel_get_local_hold_state
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallChannel.html" title="TpBaseMediaCallChannel"><span class="type">TpBaseMediaCallChannel</span></a> *channel</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpLocalHoldStateReason" title="enum TpLocalHoldStateReason"><span class="type">TpLocalHoldStateReason</span></a> *reason</code></em>);</pre>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
<td>a <a class="link" href="TpBaseMediaCallChannel.html" title="TpBaseMediaCallChannel"><span class="type">TpBaseMediaCallChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>reason</code></em> :</span></p></td>
<td>pointer to a location where to store the <em class="parameter"><code>reason</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The current hold state</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.6</p>
</div>
</div>
<div class="refsect1">
<a name="TpBaseMediaCallChannel.see-also"></a><h2>See Also</h2>
<a class="link" href="TpBaseCallChannel.html" title="TpBaseCallChannel"><span class="type">TpBaseCallChannel</span></a>, <a class="link" href="TpBaseMediaCallContent.html" title="TpBaseMediaCallContent"><span class="type">TpBaseMediaCallContent</span></a>, <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|