1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>TpBaseMediaCallStream</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
<link rel="home" href="index.html" title="telepathy-glib API Reference Manual">
8
<link rel="up" href="ch-service-base.html" title="Service-side implementation">
9
<link rel="prev" href="TpBaseCallStream.html" title="TpBaseCallStream">
10
<link rel="next" href="TpCallStreamEndpoint.html" title="TpCallStreamEndpoint">
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
<td><a accesskey="p" href="TpBaseCallStream.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="ch-service-base.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">telepathy-glib API Reference Manual</th>
21
<td><a accesskey="n" href="TpCallStreamEndpoint.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#TpBaseMediaCallStream.synopsis" class="shortcut">Top</a>
26
<a href="#TpBaseMediaCallStream.description" class="shortcut">Description</a>
28
<a href="#TpBaseMediaCallStream.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#TpBaseMediaCallStream.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32
<a href="#TpBaseMediaCallStream.properties" class="shortcut">Properties</a>
35
<div class="refentry">
36
<a name="TpBaseMediaCallStream"></a><div class="titlepage"></div>
37
<div class="refnamediv"><table width="100%"><tr>
39
<h2><span class="refentrytitle"><a name="TpBaseMediaCallStream.top_of_page"></a>TpBaseMediaCallStream</span></h2>
40
<p>TpBaseMediaCallStream — base class for <a class="link" href="telepathy-glib-svc-channel-call.html#TpSvcCallStreamInterfaceMedia"><span class="type">TpSvcCallStreamInterfaceMedia</span></a>
43
<td valign="top" align="right"></td>
45
<div class="refsynopsisdiv">
46
<a name="TpBaseMediaCallStream.synopsis"></a><h2>Synopsis</h2>
47
<pre class="synopsis">
48
#include <telepathy-glib/telepathy-glib.h>
50
<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream-struct" title="TpBaseMediaCallStream">TpBaseMediaCallStream</a>;
51
struct <a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamClass" title="struct TpBaseMediaCallStreamClass">TpBaseMediaCallStreamClass</a>;
52
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamFinishInitialCandidatesFunc" title="TpBaseMediaCallStreamFinishInitialCandidatesFunc ()">*TpBaseMediaCallStreamFinishInitialCandidatesFunc</a>)
53
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
54
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
55
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * (<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamAddCandidatesFunc" title="TpBaseMediaCallStreamAddCandidatesFunc ()">*TpBaseMediaCallStreamAddCandidatesFunc</a>)
56
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
57
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *candidates</code></em>,
58
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
59
<span class="returnvalue">void</span> (<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamReportFailureFunc" title="TpBaseMediaCallStreamReportFailureFunc ()">*TpBaseMediaCallStreamReportFailureFunc</a>)
60
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
61
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpStreamFlowState" title="enum TpStreamFlowState"><span class="type">TpStreamFlowState</span></a> old_state</code></em>,
62
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpCallStateChangeReason" title="enum TpCallStateChangeReason"><span class="type">TpCallStateChangeReason</span></a> reason</code></em>,
63
<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> *dbus_reason</code></em>,
64
<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> *message</code></em>);
65
<span class="returnvalue">void</span> (<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamRequestReceivingFunc" title="TpBaseMediaCallStreamRequestReceivingFunc ()">*TpBaseMediaCallStreamRequestReceivingFunc</a>)
66
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
67
<em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> contact</code></em>,
68
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> receive</code></em>);
69
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamSetSendingFunc" title="TpBaseMediaCallStreamSetSendingFunc ()">*TpBaseMediaCallStreamSetSendingFunc</a>)
70
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
71
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> sending</code></em>,
72
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
73
<span class="returnvalue">void</span> <a class="link" href="TpBaseMediaCallStream.html#tp-base-media-call-stream-set-relay-info" title="tp_base_media_call_stream_set_relay_info ()">tp_base_media_call_stream_set_relay_info</a>
74
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
75
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *relays</code></em>);
76
<span class="returnvalue">void</span> <a class="link" href="TpBaseMediaCallStream.html#tp-base-media-call-stream-set-stun-servers" title="tp_base_media_call_stream_set_stun_servers ()">tp_base_media_call_stream_set_stun_servers</a>
77
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
78
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *stun_servers</code></em>);
79
<span class="returnvalue">void</span> <a class="link" href="TpBaseMediaCallStream.html#tp-base-media-call-stream-add-endpoint" title="tp_base_media_call_stream_add_endpoint ()">tp_base_media_call_stream_add_endpoint</a>
80
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
81
<em class="parameter"><code><a class="link" href="TpCallStreamEndpoint.html" title="TpCallStreamEndpoint"><span class="type">TpCallStreamEndpoint</span></a> *endpoint</code></em>);
82
<span class="returnvalue">void</span> <a class="link" href="TpBaseMediaCallStream.html#tp-base-media-call-stream-remove-endpoint" title="tp_base_media_call_stream_remove_endpoint ()">tp_base_media_call_stream_remove_endpoint</a>
83
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
84
<em class="parameter"><code><a class="link" href="TpCallStreamEndpoint.html" title="TpCallStreamEndpoint"><span class="type">TpCallStreamEndpoint</span></a> *endpoint</code></em>);
85
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="TpBaseMediaCallStream.html#tp-base-media-call-stream-get-endpoints" title="tp_base_media_call_stream_get_endpoints ()">tp_base_media_call_stream_get_endpoints</a>
86
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>);
87
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="TpBaseMediaCallStream.html#tp-base-media-call-stream-get-username" title="tp_base_media_call_stream_get_username ()">tp_base_media_call_stream_get_username</a>
88
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>);
89
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="TpBaseMediaCallStream.html#tp-base-media-call-stream-get-password" title="tp_base_media_call_stream_get_password ()">tp_base_media_call_stream_get_password</a>
90
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>);
91
<span class="returnvalue">void</span> <a class="link" href="TpBaseMediaCallStream.html#tp-base-media-call-stream-update-receiving-state" title="tp_base_media_call_stream_update_receiving_state ()">tp_base_media_call_stream_update_receiving_state</a>
92
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>);
93
<a class="link" href="telepathy-glib-enums.html#TpStreamFlowState" title="enum TpStreamFlowState"><span class="returnvalue">TpStreamFlowState</span></a> <a class="link" href="TpBaseMediaCallStream.html#tp-base-media-call-stream-get-receiving-state" title="tp_base_media_call_stream_get_receiving_state ()">tp_base_media_call_stream_get_receiving_state</a>
94
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>);
95
<span class="returnvalue">void</span> <a class="link" href="TpBaseMediaCallStream.html#tp-base-media-call-stream-update-sending-state" title="tp_base_media_call_stream_update_sending_state ()">tp_base_media_call_stream_update_sending_state</a>
96
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>);
97
<a class="link" href="telepathy-glib-enums.html#TpStreamFlowState" title="enum TpStreamFlowState"><span class="returnvalue">TpStreamFlowState</span></a> <a class="link" href="TpBaseMediaCallStream.html#tp-base-media-call-stream-get-sending-state" title="tp_base_media_call_stream_get_sending_state ()">tp_base_media_call_stream_get_sending_state</a>
98
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>);
99
<span class="returnvalue">void</span> <a class="link" href="TpBaseMediaCallStream.html#tp-base-media-call-stream-set-local-sending" title="tp_base_media_call_stream_set_local_sending ()">tp_base_media_call_stream_set_local_sending</a>
100
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
101
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> sending</code></em>);
102
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * <a class="link" href="TpBaseMediaCallStream.html#tp-base-media-call-stream-get-local-candidates" title="tp_base_media_call_stream_get_local_candidates ()">tp_base_media_call_stream_get_local_candidates</a>
103
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>);
106
<div class="refsect1">
107
<a name="TpBaseMediaCallStream.object-hierarchy"></a><h2>Object Hierarchy</h2>
108
<pre class="synopsis">
109
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
110
+----<a class="link" href="TpBaseCallStream.html" title="TpBaseCallStream">TpBaseCallStream</a>
111
+----TpBaseMediaCallStream
114
<div class="refsect1">
115
<a name="TpBaseMediaCallStream.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
117
TpBaseMediaCallStream implements
118
<a class="link" href="telepathy-glib-svc-generic.html#TpSvcDBusProperties">TpSvcDBusProperties</a>, <a class="link" href="telepathy-glib-svc-channel-call.html#TpSvcCallStream">TpSvcCallStream</a> and <a class="link" href="telepathy-glib-svc-channel-call.html#TpSvcCallStreamInterfaceMedia">TpSvcCallStreamInterfaceMedia</a>.</p>
120
<div class="refsect1">
121
<a name="TpBaseMediaCallStream.properties"></a><h2>Properties</h2>
122
<pre class="synopsis">
123
"<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--endpoints" title='The "endpoints" property'>endpoints</a>" <span class="type">GPtrArray_DBusGObjectPath_</span>* : Read
124
"<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--has-server-info" title='The "has-server-info" property'>has-server-info</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read
125
"<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--ice-restart-pending" title='The "ice-restart-pending" property'>ice-restart-pending</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read
126
"<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--local-candidates" title='The "local-candidates" property'>local-candidates</a>" <span class="type">GPtrArray_GValueArray_guint+gchararray+guint+GHashTable_gchararray+GValue___*</span> : Read
127
"<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--local-credentials" title='The "local-credentials" property'>local-credentials</a>" <span class="type">GValueArray_gchararray+gchararray_*</span> : Read
128
"<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--receiving-state" title='The "receiving-state" property'>receiving-state</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read
129
"<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--relay-info" title='The "relay-info" property'>relay-info</a>" <span class="type">GPtrArray_GHashTable_gchararray+GValue__*</span> : Read
130
"<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--sending-state" title='The "sending-state" property'>sending-state</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read
131
"<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--stun-servers" title='The "stun-servers" property'>stun-servers</a>" <span class="type">GPtrArray_GValueArray_gchararray+guint__*</span> : Read
132
"<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--transport" title='The "transport" property'>transport</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct Only
135
<div class="refsect1">
136
<a name="TpBaseMediaCallStream.description"></a><h2>Description</h2>
138
This base class makes it easier to write <a class="link" href="telepathy-glib-svc-channel-call.html#TpSvcCallStreamInterfaceMedia"><span class="type">TpSvcCallStreamInterfaceMedia</span></a>
139
implementations by implementing some of its properties and methods.
142
Subclasses must still implement <a class="link" href="TpBaseCallStream.html" title="TpBaseCallStream"><span class="type">TpBaseCallStream</span></a>'s virtual methods plus
143
<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamClass.add-local-candidates"><span class="type">TpBaseMediaCallStreamClass.add_local_candidates</span></a> and
144
<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamClass.finish-initial-candidates"><span class="type">TpBaseMediaCallStreamClass.finish_initial_candidates</span></a>.
147
<div class="refsect1">
148
<a name="TpBaseMediaCallStream.details"></a><h2>Details</h2>
149
<div class="refsect2">
150
<a name="TpBaseMediaCallStream-struct"></a><h3>TpBaseMediaCallStream</h3>
151
<pre class="programlisting">typedef struct _TpBaseMediaCallStream TpBaseMediaCallStream;</pre>
153
A base class for media call stream implementations
155
<p class="since">Since 0.17.5</p>
158
<div class="refsect2">
159
<a name="TpBaseMediaCallStreamClass"></a><h3>struct TpBaseMediaCallStreamClass</h3>
160
<pre class="programlisting">struct TpBaseMediaCallStreamClass {
161
TpBaseMediaCallStreamReportFailureFunc report_sending_failure;
162
TpBaseMediaCallStreamReportFailureFunc report_receiving_failure;
163
TpBaseMediaCallStreamAddCandidatesFunc add_local_candidates;
164
TpBaseMediaCallStreamFinishInitialCandidatesFunc finish_initial_candidates;
166
TpBaseMediaCallStreamRequestReceivingFunc request_receiving;
167
TpBaseMediaCallStreamSetSendingFunc set_sending;
171
The class structure for <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
173
<div class="variablelist"><table border="0">
174
<col align="left" valign="top">
177
<td><p><span class="term"><a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamReportFailureFunc" title="TpBaseMediaCallStreamReportFailureFunc ()"><span class="type">TpBaseMediaCallStreamReportFailureFunc</span></a> <em class="structfield"><code><a name="TpBaseMediaCallStreamClass.report-sending-failure"></a>report_sending_failure</code></em>;</span></p></td>
178
<td>optional; called to indicate a failure in the
179
outgoing portion of the stream</td>
182
<td><p><span class="term"><a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamReportFailureFunc" title="TpBaseMediaCallStreamReportFailureFunc ()"><span class="type">TpBaseMediaCallStreamReportFailureFunc</span></a> <em class="structfield"><code><a name="TpBaseMediaCallStreamClass.report-receiving-failure"></a>report_receiving_failure</code></em>;</span></p></td>
183
<td>optional; called to indicate a failure in the
184
incoming portion of the stream</td>
187
<td><p><span class="term"><a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamAddCandidatesFunc" title="TpBaseMediaCallStreamAddCandidatesFunc ()"><span class="type">TpBaseMediaCallStreamAddCandidatesFunc</span></a> <em class="structfield"><code><a name="TpBaseMediaCallStreamClass.add-local-candidates"></a>add_local_candidates</code></em>;</span></p></td>
188
<td>mandatory; called when new candidates are added</td>
191
<td><p><span class="term"><a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamFinishInitialCandidatesFunc" title="TpBaseMediaCallStreamFinishInitialCandidatesFunc ()"><span class="type">TpBaseMediaCallStreamFinishInitialCandidatesFunc</span></a> <em class="structfield"><code><a name="TpBaseMediaCallStreamClass.finish-initial-candidates"></a>finish_initial_candidates</code></em>;</span></p></td>
192
<td>optional; called when the initial batch of
193
candidates has been added, and should now be processed/sent to the remote
197
<td><p><span class="term"><a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamRequestReceivingFunc" title="TpBaseMediaCallStreamRequestReceivingFunc ()"><span class="type">TpBaseMediaCallStreamRequestReceivingFunc</span></a> <em class="structfield"><code><a name="TpBaseMediaCallStreamClass.request-receiving"></a>request_receiving</code></em>;</span></p></td>
198
<td>optional (see <a class="link" href="TpBaseCallStream.html#TpBaseCallStream--can-request-receiving" title='The "can-request-receiving" property'><span class="type">"can-request-receiving"</span></a>);
199
virtual method called when user requested receiving from the given remote
200
contact. This virtual method should be implemented instead of
201
<span class="type">TpBaseCallStream.request_receiving</span>
205
<td><p><span class="term"><a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamSetSendingFunc" title="TpBaseMediaCallStreamSetSendingFunc ()"><span class="type">TpBaseMediaCallStreamSetSendingFunc</span></a> <em class="structfield"><code><a name="TpBaseMediaCallStreamClass.set-sending"></a>set_sending</code></em>;</span></p></td>
206
<td>mandatory; virtual method called when user requested to
207
start/stop sending to remote contacts. This virtual method should be
208
implemented instead of <span class="type">TpBaseCallStream.set_sending</span>
213
<p class="since">Since 0.17.5</p>
216
<div class="refsect2">
217
<a name="TpBaseMediaCallStreamFinishInitialCandidatesFunc"></a><h3>TpBaseMediaCallStreamFinishInitialCandidatesFunc ()</h3>
218
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (*TpBaseMediaCallStreamFinishInitialCandidatesFunc)
219
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
220
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
222
Signature of an implementation of
223
<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamClass.finish-initial-candidates"><span class="type">TpBaseMediaCallStreamClass.finish_initial_candidates</span></a>.
225
<div class="variablelist"><table border="0">
226
<col align="left" valign="top">
229
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
230
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
234
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
235
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to fill</td>
239
<p class="since">Since 0.17.5</p>
242
<div class="refsect2">
243
<a name="TpBaseMediaCallStreamAddCandidatesFunc"></a><h3>TpBaseMediaCallStreamAddCandidatesFunc ()</h3>
244
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * (*TpBaseMediaCallStreamAddCandidatesFunc)
245
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
246
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *candidates</code></em>,
247
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
249
Signature of an implementation of
250
<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamClass.add-local-candidates"><span class="type">TpBaseMediaCallStreamClass.add_local_candidates</span></a>.
253
Implementation should validate the added <em class="parameter"><code>candidates</code></em> and return a subset
254
(or all) of them that are accepted. Implementation should return a new
255
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> build in a way that <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#g-ptr-array-unref"><code class="function">g_ptr_array_unref()</code></a> is enough to free all its
256
memory. It is fine to just add element pointers from <em class="parameter"><code>candidates</code></em> to the
257
returned <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> without deep-copy them.
259
<div class="variablelist"><table border="0">
260
<col align="left" valign="top">
263
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
264
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
268
<td><p><span class="term"><em class="parameter"><code>candidates</code></em> :</span></p></td>
269
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> of <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="type">GValueArray</span></a> containing candidates info</td>
272
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
273
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to fill</td>
277
<p class="since">Since 0.17.5</p>
280
<div class="refsect2">
281
<a name="TpBaseMediaCallStreamReportFailureFunc"></a><h3>TpBaseMediaCallStreamReportFailureFunc ()</h3>
282
<pre class="programlisting"><span class="returnvalue">void</span> (*TpBaseMediaCallStreamReportFailureFunc)
283
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
284
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpStreamFlowState" title="enum TpStreamFlowState"><span class="type">TpStreamFlowState</span></a> old_state</code></em>,
285
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpCallStateChangeReason" title="enum TpCallStateChangeReason"><span class="type">TpCallStateChangeReason</span></a> reason</code></em>,
286
<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> *dbus_reason</code></em>,
287
<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> *message</code></em>);</pre>
289
Signature of an implementation of
290
<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamClass.report-sending-failure"><span class="type">TpBaseMediaCallStreamClass.report_sending_failure</span></a> and
291
<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamClass.report-receiving-failure"><span class="type">TpBaseMediaCallStreamClass.report_receiving_failure</span></a>.
293
<div class="variablelist"><table border="0">
294
<col align="left" valign="top">
297
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
298
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
302
<td><p><span class="term"><em class="parameter"><code>old_state</code></em> :</span></p></td>
303
<td>the previous <a class="link" href="telepathy-glib-enums.html#TpStreamFlowState" title="enum TpStreamFlowState"><span class="type">TpStreamFlowState</span></a>
307
<td><p><span class="term"><em class="parameter"><code>reason</code></em> :</span></p></td>
308
<td>the <a class="link" href="telepathy-glib-enums.html#TpCallStateChangeReason" title="enum TpCallStateChangeReason"><span class="type">TpCallStateChangeReason</span></a> of the change</td>
311
<td><p><span class="term"><em class="parameter"><code>dbus_reason</code></em> :</span></p></td>
312
<td>a specific reason for the change, which may be a D-Bus error in
313
the Telepathy namespace, a D-Bus error in any other namespace (for
314
implementation-specific errors), or the empty string to indicate that the
315
state change was not an error.</td>
318
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
319
<td>an optional debug message, to expediate debugging the potentially
320
many processes involved in a call.</td>
324
<p class="since">Since 0.17.5</p>
327
<div class="refsect2">
328
<a name="TpBaseMediaCallStreamRequestReceivingFunc"></a><h3>TpBaseMediaCallStreamRequestReceivingFunc ()</h3>
329
<pre class="programlisting"><span class="returnvalue">void</span> (*TpBaseMediaCallStreamRequestReceivingFunc)
330
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
331
<em class="parameter"><code><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle"><span class="type">TpHandle</span></a> contact</code></em>,
332
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> receive</code></em>);</pre>
334
Signature of an implementation of
335
<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamClass.request-receiving"><span class="type">TpBaseMediaCallStreamClass.request_receiving</span></a>.
337
<div class="variablelist"><table border="0">
338
<col align="left" valign="top">
341
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
342
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
346
<td><p><span class="term"><em class="parameter"><code>contact</code></em> :</span></p></td>
347
<td>the contact from who user wants to start or stop receiving</td>
350
<td><p><span class="term"><em class="parameter"><code>receive</code></em> :</span></p></td>
351
<td>wheter or not user would like to be receiving</td>
355
<p class="since">Since 0.17.5</p>
358
<div class="refsect2">
359
<a name="TpBaseMediaCallStreamSetSendingFunc"></a><h3>TpBaseMediaCallStreamSetSendingFunc ()</h3>
360
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (*TpBaseMediaCallStreamSetSendingFunc)
361
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
362
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> sending</code></em>,
363
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
365
Signature of an implementation of <a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStreamClass.set-sending"><span class="type">TpBaseMediaCallStreamClass.set_sending</span></a>.
367
<div class="variablelist"><table border="0">
368
<col align="left" valign="top">
371
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
372
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
376
<td><p><span class="term"><em class="parameter"><code>sending</code></em> :</span></p></td>
377
<td>whether or not user would like to be sending</td>
380
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
381
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to fill</td>
384
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
386
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
390
<p class="since">Since 0.17.5</p>
393
<div class="refsect2">
394
<a name="tp-base-media-call-stream-set-relay-info"></a><h3>tp_base_media_call_stream_set_relay_info ()</h3>
395
<pre class="programlisting"><span class="returnvalue">void</span> tp_base_media_call_stream_set_relay_info
396
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
397
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *relays</code></em>);</pre>
399
Set the relays info. The <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> should have a free_func defined such as
400
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#g-ptr-array-ref"><code class="function">g_ptr_array_ref()</code></a> is enough to keep the data and <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#g-ptr-array-unref"><code class="function">g_ptr_array_unref()</code></a> is
401
enough to release it later.
404
Note that this replaces the previously set relays, it is not an addition.
406
<div class="variablelist"><table border="0">
407
<col align="left" valign="top">
410
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
411
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
415
<td><p><span class="term"><em class="parameter"><code>relays</code></em> :</span></p></td>
416
<td>the new relays info</td>
420
<p class="since">Since 0.17.5</p>
423
<div class="refsect2">
424
<a name="tp-base-media-call-stream-set-stun-servers"></a><h3>tp_base_media_call_stream_set_stun_servers ()</h3>
425
<pre class="programlisting"><span class="returnvalue">void</span> tp_base_media_call_stream_set_stun_servers
426
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
427
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *stun_servers</code></em>);</pre>
429
Set the STUN servers. The <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> should have a free_func defined such as
430
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#g-ptr-array-ref"><code class="function">g_ptr_array_ref()</code></a> is enough to keep the data and <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#g-ptr-array-unref"><code class="function">g_ptr_array_unref()</code></a> is
431
enough to release it later.
434
Note that this replaces the previously set STUN servers, it is not an
437
<div class="variablelist"><table border="0">
438
<col align="left" valign="top">
441
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
442
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
446
<td><p><span class="term"><em class="parameter"><code>stun_servers</code></em> :</span></p></td>
447
<td>the new stun servers</td>
451
<p class="since">Since 0.17.5</p>
454
<div class="refsect2">
455
<a name="tp-base-media-call-stream-add-endpoint"></a><h3>tp_base_media_call_stream_add_endpoint ()</h3>
456
<pre class="programlisting"><span class="returnvalue">void</span> tp_base_media_call_stream_add_endpoint
457
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
458
<em class="parameter"><code><a class="link" href="TpCallStreamEndpoint.html" title="TpCallStreamEndpoint"><span class="type">TpCallStreamEndpoint</span></a> *endpoint</code></em>);</pre>
460
Add <em class="parameter"><code>endpoint</code></em> to <a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--endpoints" title='The "endpoints" property'><span class="type">"endpoints"</span></a> list, and emits
461
EndpointsChanged DBus signal.
463
<div class="variablelist"><table border="0">
464
<col align="left" valign="top">
467
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
468
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
472
<td><p><span class="term"><em class="parameter"><code>endpoint</code></em> :</span></p></td>
473
<td>a <a class="link" href="TpCallStreamEndpoint.html" title="TpCallStreamEndpoint"><span class="type">TpCallStreamEndpoint</span></a>
478
<p class="since">Since 0.17.5</p>
481
<div class="refsect2">
482
<a name="tp-base-media-call-stream-remove-endpoint"></a><h3>tp_base_media_call_stream_remove_endpoint ()</h3>
483
<pre class="programlisting"><span class="returnvalue">void</span> tp_base_media_call_stream_remove_endpoint
484
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
485
<em class="parameter"><code><a class="link" href="TpCallStreamEndpoint.html" title="TpCallStreamEndpoint"><span class="type">TpCallStreamEndpoint</span></a> *endpoint</code></em>);</pre>
487
Remove <em class="parameter"><code>endpoint</code></em> from <a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--endpoints" title='The "endpoints" property'><span class="type">"endpoints"</span></a> list, and emits
488
EndpointsChanged DBus signal.
490
<div class="variablelist"><table border="0">
491
<col align="left" valign="top">
494
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
495
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
499
<td><p><span class="term"><em class="parameter"><code>endpoint</code></em> :</span></p></td>
500
<td>a <a class="link" href="TpCallStreamEndpoint.html" title="TpCallStreamEndpoint"><span class="type">TpCallStreamEndpoint</span></a>
505
<p class="since">Since 0.17.5</p>
508
<div class="refsect2">
509
<a name="tp-base-media-call-stream-get-endpoints"></a><h3>tp_base_media_call_stream_get_endpoints ()</h3>
510
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * tp_base_media_call_stream_get_endpoints
511
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>);</pre>
513
Same as <a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--endpoints" title='The "endpoints" property'><span class="type">"endpoints"</span></a> but as a <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of
514
<a class="link" href="TpCallStreamEndpoint.html" title="TpCallStreamEndpoint"><span class="type">TpCallStreamEndpoint</span></a>.
516
<div class="variablelist"><table border="0">
517
<col align="left" valign="top">
520
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
521
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
525
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
526
<td>Borrowed <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of <a class="link" href="TpCallStreamEndpoint.html" title="TpCallStreamEndpoint"><span class="type">TpCallStreamEndpoint</span></a>.</td>
530
<p class="since">Since 0.17.5</p>
533
<div class="refsect2">
534
<a name="tp-base-media-call-stream-get-username"></a><h3>tp_base_media_call_stream_get_username ()</h3>
535
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * tp_base_media_call_stream_get_username
536
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>);</pre>
540
<div class="variablelist"><table border="0">
541
<col align="left" valign="top">
544
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
545
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
549
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
550
<td>the username part of <a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--local-credentials" title='The "local-credentials" property'><span class="type">"local-credentials"</span></a>
555
<p class="since">Since 0.17.5</p>
558
<div class="refsect2">
559
<a name="tp-base-media-call-stream-get-password"></a><h3>tp_base_media_call_stream_get_password ()</h3>
560
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * tp_base_media_call_stream_get_password
561
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>);</pre>
565
<div class="variablelist"><table border="0">
566
<col align="left" valign="top">
569
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
570
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
574
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
575
<td>the password part of <a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--local-credentials" title='The "local-credentials" property'><span class="type">"local-credentials"</span></a>
580
<p class="since">Since 0.17.5</p>
583
<div class="refsect2">
584
<a name="tp-base-media-call-stream-update-receiving-state"></a><h3>tp_base_media_call_stream_update_receiving_state ()</h3>
585
<pre class="programlisting"><span class="returnvalue">void</span> tp_base_media_call_stream_update_receiving_state
586
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>);</pre>
588
Update the receiving state.
590
<div class="variablelist"><table border="0">
591
<col align="left" valign="top">
593
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
594
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
598
<p class="since">Since 0.17.5</p>
601
<div class="refsect2">
602
<a name="tp-base-media-call-stream-get-receiving-state"></a><h3>tp_base_media_call_stream_get_receiving_state ()</h3>
603
<pre class="programlisting"><a class="link" href="telepathy-glib-enums.html#TpStreamFlowState" title="enum TpStreamFlowState"><span class="returnvalue">TpStreamFlowState</span></a> tp_base_media_call_stream_get_receiving_state
604
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>);</pre>
608
<div class="variablelist"><table border="0">
609
<col align="left" valign="top">
612
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
613
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
617
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
618
<td>the value of <a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--receiving-state" title='The "receiving-state" property'><span class="type">"receiving-state"</span></a>.</td>
622
<p class="since">Since 0.17.5</p>
625
<div class="refsect2">
626
<a name="tp-base-media-call-stream-update-sending-state"></a><h3>tp_base_media_call_stream_update_sending_state ()</h3>
627
<pre class="programlisting"><span class="returnvalue">void</span> tp_base_media_call_stream_update_sending_state
628
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>);</pre>
630
Update the sending state.
632
<div class="variablelist"><table border="0">
633
<col align="left" valign="top">
635
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
636
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
640
<p class="since">Since 0.17.5</p>
643
<div class="refsect2">
644
<a name="tp-base-media-call-stream-get-sending-state"></a><h3>tp_base_media_call_stream_get_sending_state ()</h3>
645
<pre class="programlisting"><a class="link" href="telepathy-glib-enums.html#TpStreamFlowState" title="enum TpStreamFlowState"><span class="returnvalue">TpStreamFlowState</span></a> tp_base_media_call_stream_get_sending_state
646
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>);</pre>
650
<div class="variablelist"><table border="0">
651
<col align="left" valign="top">
654
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
655
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
659
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
660
<td>the value of <a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--sending-state" title='The "sending-state" property'><span class="type">"sending-state"</span></a>.</td>
664
<p class="since">Since 0.17.5</p>
667
<div class="refsect2">
668
<a name="tp-base-media-call-stream-set-local-sending"></a><h3>tp_base_media_call_stream_set_local_sending ()</h3>
669
<pre class="programlisting"><span class="returnvalue">void</span> tp_base_media_call_stream_set_local_sending
670
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>,
671
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> sending</code></em>);</pre>
673
Set local sending state.
675
<div class="variablelist"><table border="0">
676
<col align="left" valign="top">
679
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
680
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
684
<td><p><span class="term"><em class="parameter"><code>sending</code></em> :</span></p></td>
685
<td>whether or not we are sending</td>
689
<p class="since">Since 0.17.5</p>
692
<div class="refsect2">
693
<a name="tp-base-media-call-stream-get-local-candidates"></a><h3>tp_base_media_call_stream_get_local_candidates ()</h3>
694
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * tp_base_media_call_stream_get_local_candidates
695
(<em class="parameter"><code><a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a> *self</code></em>);</pre>
699
<div class="variablelist"><table border="0">
700
<col align="left" valign="top">
703
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
704
<td>a <a class="link" href="TpBaseMediaCallStream.html" title="TpBaseMediaCallStream"><span class="type">TpBaseMediaCallStream</span></a>
708
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
709
<td>the value of <a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--local-candidates" title='The "local-candidates" property'><span class="type">"local-candidates"</span></a> as a <span class="type">GtrArray</span>
714
<p class="since">Since 0.17.5</p>
717
<div class="refsect1">
718
<a name="TpBaseMediaCallStream.property-details"></a><h2>Property Details</h2>
719
<div class="refsect2">
720
<a name="TpBaseMediaCallStream--endpoints"></a><h3>The <code class="literal">"endpoints"</code> property</h3>
721
<pre class="programlisting"> "endpoints" <span class="type">GPtrArray_DBusGObjectPath_</span>* : Read</pre>
723
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a>{object-path string}
724
The endpoints of this content.
726
<p class="since">Since 0.17.5</p>
729
<div class="refsect2">
730
<a name="TpBaseMediaCallStream--has-server-info"></a><h3>The <code class="literal">"has-server-info"</code> property</h3>
731
<pre class="programlisting"> "has-server-info" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre>
733
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--relay-info" title='The "relay-info" property'><span class="type">"relay-info"</span></a> and
734
<a class="link" href="TpBaseMediaCallStream.html#TpBaseMediaCallStream--stun-servers" title='The "stun-servers" property'><span class="type">"stun-servers"</span></a> have been set.
736
<p>Default value: FALSE</p>
737
<p class="since">Since 0.17.5</p>
740
<div class="refsect2">
741
<a name="TpBaseMediaCallStream--ice-restart-pending"></a><h3>The <code class="literal">"ice-restart-pending"</code> property</h3>
742
<pre class="programlisting"> "ice-restart-pending" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre>
744
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> when ICERestartRequested signal is emitted, and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> when
745
SetCredentials is called. Useful for debugging.
747
<p>Default value: FALSE</p>
748
<p class="since">Since 0.17.5</p>
751
<div class="refsect2">
752
<a name="TpBaseMediaCallStream--local-candidates"></a><h3>The <code class="literal">"local-candidates"</code> property</h3>
753
<pre class="programlisting"> "local-candidates" <span class="type">GPtrArray_GValueArray_guint+gchararray+guint+GHashTable_gchararray+GValue___*</span> : Read</pre>
755
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a>{candidate <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="type">GValueArray</span></a>}
756
List of local candidates.
758
<p class="since">Since 0.17.5</p>
761
<div class="refsect2">
762
<a name="TpBaseMediaCallStream--local-credentials"></a><h3>The <code class="literal">"local-credentials"</code> property</h3>
763
<pre class="programlisting"> "local-credentials" <span class="type">GValueArray_gchararray+gchararray_*</span> : Read</pre>
765
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="type">GValueArray</span></a>{username string, password string}
766
ufrag and pwd as defined by ICE.
768
<p class="since">Since 0.17.5</p>
771
<div class="refsect2">
772
<a name="TpBaseMediaCallStream--receiving-state"></a><h3>The <code class="literal">"receiving-state"</code> property</h3>
773
<pre class="programlisting"> "receiving-state" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre>
775
The receiving <a class="link" href="telepathy-glib-enums.html#TpStreamFlowState" title="enum TpStreamFlowState"><span class="type">TpStreamFlowState</span></a>.
777
<p>Default value: 0</p>
778
<p class="since">Since 0.17.5</p>
781
<div class="refsect2">
782
<a name="TpBaseMediaCallStream--relay-info"></a><h3>The <code class="literal">"relay-info"</code> property</h3>
783
<pre class="programlisting"> "relay-info" <span class="type">GPtrArray_GHashTable_gchararray+GValue__*</span> : Read</pre>
785
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a>{relay-info asv}
786
List of relay information.
788
<p class="since">Since 0.17.5</p>
791
<div class="refsect2">
792
<a name="TpBaseMediaCallStream--sending-state"></a><h3>The <code class="literal">"sending-state"</code> property</h3>
793
<pre class="programlisting"> "sending-state" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre>
795
The sending <a class="link" href="telepathy-glib-enums.html#TpStreamFlowState" title="enum TpStreamFlowState"><span class="type">TpStreamFlowState</span></a>.
797
<p>Default value: 0</p>
798
<p class="since">Since 0.17.5</p>
801
<div class="refsect2">
802
<a name="TpBaseMediaCallStream--stun-servers"></a><h3>The <code class="literal">"stun-servers"</code> property</h3>
803
<pre class="programlisting"> "stun-servers" <span class="type">GPtrArray_GValueArray_gchararray+guint__*</span> : Read</pre>
805
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a>{stun-server <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Value-arrays.html#GValueArray"><span class="type">GValueArray</span></a>}
806
List of STUN servers.
808
<p class="since">Since 0.17.5</p>
811
<div class="refsect2">
812
<a name="TpBaseMediaCallStream--transport"></a><h3>The <code class="literal">"transport"</code> property</h3>
813
<pre class="programlisting"> "transport" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct Only</pre>
815
The <a class="link" href="telepathy-glib-enums.html#TpStreamTransportType" title="enum TpStreamTransportType"><span class="type">TpStreamTransportType</span></a> of this stream.
817
<p>Default value: 0</p>
818
<p class="since">Since 0.17.5</p>
821
<div class="refsect1">
822
<a name="TpBaseMediaCallStream.see-also"></a><h2>See Also</h2>
823
<a class="link" href="telepathy-glib-svc-channel-call.html#TpSvcCallStreamInterfaceMedia"><span class="type">TpSvcCallStreamInterfaceMedia</span></a>, <a class="link" href="TpBaseCallChannel.html" title="TpBaseCallChannel"><span class="type">TpBaseCallChannel</span></a>,
824
<a class="link" href="TpBaseCallStream.html" title="TpBaseCallStream"><span class="type">TpBaseCallStream</span></a> and <a class="link" href="TpBaseCallContent.html" title="TpBaseCallContent"><span class="type">TpBaseCallContent</span></a>
829
Generated by GTK-Doc V1.18</div>
b'\\ No newline at end of file'