~ubuntu-branches/ubuntu/wily/telepathy-glib/wily

« back to all changes in this revision

Viewing changes to docs/reference/xml/channel-media.xml

  • Committer: Bazaar Package Importer
  • Author(s): Simon McVittie
  • Date: 2009-03-24 22:06:52 UTC
  • mfrom: (1.3.1 upstream) (17.1.10 sid)
  • Revision ID: james.westby@ubuntu.com-20090324220652-c8dvom0nsqomp23d
Tags: 0.7.28-1
* New upstream version (ABI, API added)
* Put the -dbg package in section debug, as per recent archive changes
* Remove obsolete Conflicts/Replaces with libtelepathy-glib-static-dev, which
  was never in a stable release (and probably never in Debian at all)

Show diffs side-by-side

added added

removed removed

Lines of Context:
12
12
<refname>Media channels</refname>
13
13
<refpurpose>client-side wrappers for the Streamed Media channel
14
14
 type, and the Call State, DTMF and Media Signalling interfaces</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="telepathy-glib-channel-media.synopsis" role="synopsis">
22
21
 
23
22
#include &lt;telepathy-glib/channel.h&gt;
24
23
 
25
 
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* <link linkend="tp-cli-channel-type-streamed-media-call-list-streams">tp_cli_channel_type_streamed_media_call_list_streams</link>
 
24
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * <link linkend="tp-cli-channel-type-streamed-media-call-list-streams">tp_cli_channel_type_streamed_media_call_list_streams</link>
26
25
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
27
26
                                                         <link linkend="gint">gint</link> timeout_ms,
28
27
                                                         <link linkend="tp-cli-channel-type-streamed-media-callback-for-list-streams">tp_cli_channel_type_streamed_media_callback_for_list_streams</link> callback,
29
28
                                                         <link linkend="gpointer">gpointer</link> user_data,
30
29
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy,
31
30
                                                         <link linkend="GObject">GObject</link> *weak_object);
32
 
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* <link linkend="tp-cli-channel-type-streamed-media-call-remove-streams">tp_cli_channel_type_streamed_media_call_remove_streams</link>
 
31
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * <link linkend="tp-cli-channel-type-streamed-media-call-remove-streams">tp_cli_channel_type_streamed_media_call_remove_streams</link>
33
32
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
34
33
                                                         <link linkend="gint">gint</link> timeout_ms,
35
 
                                                         const <link linkend="GArray">GArray</link> *in_streams,
 
34
                                                         const <link linkend="GArray">GArray</link> *in_Streams,
36
35
                                                         <link linkend="tp-cli-channel-type-streamed-media-callback-for-remove-streams">tp_cli_channel_type_streamed_media_callback_for_remove_streams</link> callback,
37
36
                                                         <link linkend="gpointer">gpointer</link> user_data,
38
37
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy,
39
38
                                                         <link linkend="GObject">GObject</link> *weak_object);
40
 
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* <link linkend="tp-cli-channel-type-streamed-media-call-request-stream-direction">tp_cli_channel_type_streamed_media_call_request_stream_direction</link>
 
39
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * <link linkend="tp-cli-channel-type-streamed-media-call-request-stream-direction">tp_cli_channel_type_streamed_media_call_request_stream_direction</link>
41
40
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
42
41
                                                         <link linkend="gint">gint</link> timeout_ms,
43
 
                                                         <link linkend="guint">guint</link> in_stream_id,
44
 
                                                         <link linkend="guint">guint</link> in_stream_direction,
 
42
                                                         <link linkend="guint">guint</link> in_Stream_ID,
 
43
                                                         <link linkend="guint">guint</link> in_Stream_Direction,
45
44
                                                         <link linkend="tp-cli-channel-type-streamed-media-callback-for-request-stream-direction">tp_cli_channel_type_streamed_media_callback_for_request_stream_direction</link> callback,
46
45
                                                         <link linkend="gpointer">gpointer</link> user_data,
47
46
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy,
48
47
                                                         <link linkend="GObject">GObject</link> *weak_object);
49
 
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* <link linkend="tp-cli-channel-type-streamed-media-call-request-streams">tp_cli_channel_type_streamed_media_call_request_streams</link>
 
48
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * <link linkend="tp-cli-channel-type-streamed-media-call-request-streams">tp_cli_channel_type_streamed_media_call_request_streams</link>
50
49
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
51
50
                                                         <link linkend="gint">gint</link> timeout_ms,
52
 
                                                         <link linkend="guint">guint</link> in_contact_handle,
53
 
                                                         const <link linkend="GArray">GArray</link> *in_types,
 
51
                                                         <link linkend="guint">guint</link> in_Contact_Handle,
 
52
                                                         const <link linkend="GArray">GArray</link> *in_Types,
54
53
                                                         <link linkend="tp-cli-channel-type-streamed-media-callback-for-request-streams">tp_cli_channel_type_streamed_media_callback_for_request_streams</link> callback,
55
54
                                                         <link linkend="gpointer">gpointer</link> user_data,
56
55
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy,
57
56
                                                         <link linkend="GObject">GObject</link> *weak_object);
58
57
<link linkend="void">void</link>                (<link linkend="tp-cli-channel-type-streamed-media-callback-for-list-streams">*tp_cli_channel_type_streamed_media_callback_for_list_streams</link>)
59
58
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
60
 
                                                         const <link linkend="GPtrArray">GPtrArray</link> *out0,
 
59
                                                         const <link linkend="GPtrArray">GPtrArray</link> *out_Streams,
61
60
                                                         const <link linkend="GError">GError</link> *error,
62
61
                                                         <link linkend="gpointer">gpointer</link> user_data,
63
62
                                                         <link linkend="GObject">GObject</link> *weak_object);
73
72
                                                         <link linkend="GObject">GObject</link> *weak_object);
74
73
<link linkend="void">void</link>                (<link linkend="tp-cli-channel-type-streamed-media-callback-for-request-streams">*tp_cli_channel_type_streamed_media_callback_for_request_streams</link>)
75
74
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
76
 
                                                         const <link linkend="GPtrArray">GPtrArray</link> *out0,
 
75
                                                         const <link linkend="GPtrArray">GPtrArray</link> *out_Streams,
77
76
                                                         const <link linkend="GError">GError</link> *error,
78
77
                                                         <link linkend="gpointer">gpointer</link> user_data,
79
78
                                                         <link linkend="GObject">GObject</link> *weak_object);
80
79
<link linkend="gboolean">gboolean</link>            <link linkend="tp-cli-channel-type-streamed-media-run-list-streams">tp_cli_channel_type_streamed_media_run_list_streams</link>
81
80
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
82
81
                                                         <link linkend="gint">gint</link> timeout_ms,
83
 
                                                         <link linkend="GPtrArray">GPtrArray</link> **out0,
 
82
                                                         <link linkend="GPtrArray">GPtrArray</link> **out_Streams,
84
83
                                                         <link linkend="GError">GError</link> **error,
85
84
                                                         <link linkend="GMainLoop">GMainLoop</link> **loop);
86
85
<link linkend="gboolean">gboolean</link>            <link linkend="tp-cli-channel-type-streamed-media-run-remove-streams">tp_cli_channel_type_streamed_media_run_remove_streams</link>
87
86
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
88
87
                                                         <link linkend="gint">gint</link> timeout_ms,
89
 
                                                         const <link linkend="GArray">GArray</link> *in_streams,
 
88
                                                         const <link linkend="GArray">GArray</link> *in_Streams,
90
89
                                                         <link linkend="GError">GError</link> **error,
91
90
                                                         <link linkend="GMainLoop">GMainLoop</link> **loop);
92
91
<link linkend="gboolean">gboolean</link>            <link linkend="tp-cli-channel-type-streamed-media-run-request-stream-direction">tp_cli_channel_type_streamed_media_run_request_stream_direction</link>
93
92
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
94
93
                                                         <link linkend="gint">gint</link> timeout_ms,
95
 
                                                         <link linkend="guint">guint</link> in_stream_id,
96
 
                                                         <link linkend="guint">guint</link> in_stream_direction,
 
94
                                                         <link linkend="guint">guint</link> in_Stream_ID,
 
95
                                                         <link linkend="guint">guint</link> in_Stream_Direction,
97
96
                                                         <link linkend="GError">GError</link> **error,
98
97
                                                         <link linkend="GMainLoop">GMainLoop</link> **loop);
99
98
<link linkend="gboolean">gboolean</link>            <link linkend="tp-cli-channel-type-streamed-media-run-request-streams">tp_cli_channel_type_streamed_media_run_request_streams</link>
100
99
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
101
100
                                                         <link linkend="gint">gint</link> timeout_ms,
102
 
                                                         <link linkend="guint">guint</link> in_contact_handle,
103
 
                                                         const <link linkend="GArray">GArray</link> *in_types,
104
 
                                                         <link linkend="GPtrArray">GPtrArray</link> **out0,
 
101
                                                         <link linkend="guint">guint</link> in_Contact_Handle,
 
102
                                                         const <link linkend="GArray">GArray</link> *in_Types,
 
103
                                                         <link linkend="GPtrArray">GPtrArray</link> **out_Streams,
105
104
                                                         <link linkend="GError">GError</link> **error,
106
105
                                                         <link linkend="GMainLoop">GMainLoop</link> **loop);
107
 
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* <link linkend="tp-cli-channel-type-streamed-media-connect-to-stream-added">tp_cli_channel_type_streamed_media_connect_to_stream_added</link>
 
106
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * <link linkend="tp-cli-channel-type-streamed-media-connect-to-stream-added">tp_cli_channel_type_streamed_media_connect_to_stream_added</link>
108
107
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
109
108
                                                         <link linkend="tp-cli-channel-type-streamed-media-signal-callback-stream-added">tp_cli_channel_type_streamed_media_signal_callback_stream_added</link> callback,
110
109
                                                         <link linkend="gpointer">gpointer</link> user_data,
111
110
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy,
112
111
                                                         <link linkend="GObject">GObject</link> *weak_object,
113
112
                                                         <link linkend="GError">GError</link> **error);
114
 
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* <link linkend="tp-cli-channel-type-streamed-media-connect-to-stream-direction-changed">tp_cli_channel_type_streamed_media_connect_to_stream_direction_changed</link>
 
113
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * <link linkend="tp-cli-channel-type-streamed-media-connect-to-stream-direction-changed">tp_cli_channel_type_streamed_media_connect_to_stream_direction_changed</link>
115
114
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
116
115
                                                         <link linkend="tp-cli-channel-type-streamed-media-signal-callback-stream-direction-changed">tp_cli_channel_type_streamed_media_signal_callback_stream_direction_changed</link> callback,
117
116
                                                         <link linkend="gpointer">gpointer</link> user_data,
118
117
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy,
119
118
                                                         <link linkend="GObject">GObject</link> *weak_object,
120
119
                                                         <link linkend="GError">GError</link> **error);
121
 
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* <link linkend="tp-cli-channel-type-streamed-media-connect-to-stream-error">tp_cli_channel_type_streamed_media_connect_to_stream_error</link>
 
120
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * <link linkend="tp-cli-channel-type-streamed-media-connect-to-stream-error">tp_cli_channel_type_streamed_media_connect_to_stream_error</link>
122
121
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
123
122
                                                         <link linkend="tp-cli-channel-type-streamed-media-signal-callback-stream-error">tp_cli_channel_type_streamed_media_signal_callback_stream_error</link> callback,
124
123
                                                         <link linkend="gpointer">gpointer</link> user_data,
125
124
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy,
126
125
                                                         <link linkend="GObject">GObject</link> *weak_object,
127
126
                                                         <link linkend="GError">GError</link> **error);
128
 
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* <link linkend="tp-cli-channel-type-streamed-media-connect-to-stream-removed">tp_cli_channel_type_streamed_media_connect_to_stream_removed</link>
 
127
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * <link linkend="tp-cli-channel-type-streamed-media-connect-to-stream-removed">tp_cli_channel_type_streamed_media_connect_to_stream_removed</link>
129
128
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
130
129
                                                         <link linkend="tp-cli-channel-type-streamed-media-signal-callback-stream-removed">tp_cli_channel_type_streamed_media_signal_callback_stream_removed</link> callback,
131
130
                                                         <link linkend="gpointer">gpointer</link> user_data,
132
131
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy,
133
132
                                                         <link linkend="GObject">GObject</link> *weak_object,
134
133
                                                         <link linkend="GError">GError</link> **error);
135
 
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* <link linkend="tp-cli-channel-type-streamed-media-connect-to-stream-state-changed">tp_cli_channel_type_streamed_media_connect_to_stream_state_changed</link>
 
134
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * <link linkend="tp-cli-channel-type-streamed-media-connect-to-stream-state-changed">tp_cli_channel_type_streamed_media_connect_to_stream_state_changed</link>
136
135
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
137
136
                                                         <link linkend="tp-cli-channel-type-streamed-media-signal-callback-stream-state-changed">tp_cli_channel_type_streamed_media_signal_callback_stream_state_changed</link> callback,
138
137
                                                         <link linkend="gpointer">gpointer</link> user_data,
141
140
                                                         <link linkend="GError">GError</link> **error);
142
141
<link linkend="void">void</link>                (<link linkend="tp-cli-channel-type-streamed-media-signal-callback-stream-added">*tp_cli_channel_type_streamed_media_signal_callback_stream_added</link>)
143
142
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
144
 
                                                         <link linkend="guint">guint</link> arg_stream_id,
145
 
                                                         <link linkend="guint">guint</link> arg_contact_handle,
146
 
                                                         <link linkend="guint">guint</link> arg_stream_type,
 
143
                                                         <link linkend="guint">guint</link> arg_Stream_ID,
 
144
                                                         <link linkend="guint">guint</link> arg_Contact_Handle,
 
145
                                                         <link linkend="guint">guint</link> arg_Stream_Type,
147
146
                                                         <link linkend="gpointer">gpointer</link> user_data,
148
147
                                                         <link linkend="GObject">GObject</link> *weak_object);
149
148
<link linkend="void">void</link>                (<link linkend="tp-cli-channel-type-streamed-media-signal-callback-stream-direction-changed">*tp_cli_channel_type_streamed_media_signal_callback_stream_direction_changed</link>)
150
149
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
151
 
                                                         <link linkend="guint">guint</link> arg_stream_id,
152
 
                                                         <link linkend="guint">guint</link> arg_stream_direction,
153
 
                                                         <link linkend="guint">guint</link> arg_pending_flags,
 
150
                                                         <link linkend="guint">guint</link> arg_Stream_ID,
 
151
                                                         <link linkend="guint">guint</link> arg_Stream_Direction,
 
152
                                                         <link linkend="guint">guint</link> arg_Pending_Flags,
154
153
                                                         <link linkend="gpointer">gpointer</link> user_data,
155
154
                                                         <link linkend="GObject">GObject</link> *weak_object);
156
155
<link linkend="void">void</link>                (<link linkend="tp-cli-channel-type-streamed-media-signal-callback-stream-error">*tp_cli_channel_type_streamed_media_signal_callback_stream_error</link>)
157
156
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
158
 
                                                         <link linkend="guint">guint</link> arg_stream_id,
159
 
                                                         <link linkend="guint">guint</link> arg_errno,
160
 
                                                         const <link linkend="gchar">gchar</link> *arg_message,
 
157
                                                         <link linkend="guint">guint</link> arg_Stream_ID,
 
158
                                                         <link linkend="guint">guint</link> arg_Error_Code,
 
159
                                                         const <link linkend="gchar">gchar</link> *arg_Message,
161
160
                                                         <link linkend="gpointer">gpointer</link> user_data,
162
161
                                                         <link linkend="GObject">GObject</link> *weak_object);
163
162
<link linkend="void">void</link>                (<link linkend="tp-cli-channel-type-streamed-media-signal-callback-stream-removed">*tp_cli_channel_type_streamed_media_signal_callback_stream_removed</link>)
164
163
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
165
 
                                                         <link linkend="guint">guint</link> arg_stream_id,
 
164
                                                         <link linkend="guint">guint</link> arg_Stream_ID,
166
165
                                                         <link linkend="gpointer">gpointer</link> user_data,
167
166
                                                         <link linkend="GObject">GObject</link> *weak_object);
168
167
<link linkend="void">void</link>                (<link linkend="tp-cli-channel-type-streamed-media-signal-callback-stream-state-changed">*tp_cli_channel_type_streamed_media_signal_callback_stream_state_changed</link>)
169
168
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
170
 
                                                         <link linkend="guint">guint</link> arg_stream_id,
171
 
                                                         <link linkend="guint">guint</link> arg_stream_state,
 
169
                                                         <link linkend="guint">guint</link> arg_Stream_ID,
 
170
                                                         <link linkend="guint">guint</link> arg_Stream_State,
172
171
                                                         <link linkend="gpointer">gpointer</link> user_data,
173
172
                                                         <link linkend="GObject">GObject</link> *weak_object);
174
173
 
175
 
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* <link linkend="tp-cli-channel-interface-call-state-call-get-call-states">tp_cli_channel_interface_call_state_call_get_call_states</link>
 
174
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * <link linkend="tp-cli-channel-interface-call-state-call-get-call-states">tp_cli_channel_interface_call_state_call_get_call_states</link>
176
175
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
177
176
                                                         <link linkend="gint">gint</link> timeout_ms,
178
177
                                                         <link linkend="tp-cli-channel-interface-call-state-callback-for-get-call-states">tp_cli_channel_interface_call_state_callback_for_get_call_states</link> callback,
185
184
                                                         const <link linkend="GError">GError</link> *error,
186
185
                                                         <link linkend="gpointer">gpointer</link> user_data,
187
186
                                                         <link linkend="GObject">GObject</link> *weak_object);
188
 
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* <link linkend="tp-cli-channel-interface-call-state-connect-to-call-state-changed">tp_cli_channel_interface_call_state_connect_to_call_state_changed</link>
 
187
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * <link linkend="tp-cli-channel-interface-call-state-connect-to-call-state-changed">tp_cli_channel_interface_call_state_connect_to_call_state_changed</link>
189
188
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
190
189
                                                         <link linkend="tp-cli-channel-interface-call-state-signal-callback-call-state-changed">tp_cli_channel_interface_call_state_signal_callback_call_state_changed</link> callback,
191
190
                                                         <link linkend="gpointer">gpointer</link> user_data,
200
199
                                                         <link linkend="GMainLoop">GMainLoop</link> **loop);
201
200
<link linkend="void">void</link>                (<link linkend="tp-cli-channel-interface-call-state-signal-callback-call-state-changed">*tp_cli_channel_interface_call_state_signal_callback_call_state_changed</link>)
202
201
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
203
 
                                                         <link linkend="guint">guint</link> arg_contact,
204
 
                                                         <link linkend="guint">guint</link> arg_state,
 
202
                                                         <link linkend="guint">guint</link> arg_Contact,
 
203
                                                         <link linkend="guint">guint</link> arg_State,
205
204
                                                         <link linkend="gpointer">gpointer</link> user_data,
206
205
                                                         <link linkend="GObject">GObject</link> *weak_object);
207
206
 
208
207
<link linkend="gboolean">gboolean</link>            <link linkend="tp-cli-channel-interface-dtmf-run-start-tone">tp_cli_channel_interface_dtmf_run_start_tone</link>
209
208
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
210
209
                                                         <link linkend="gint">gint</link> timeout_ms,
211
 
                                                         <link linkend="guint">guint</link> in_stream_id,
212
 
                                                         <link linkend="guchar">guchar</link> in_event,
 
210
                                                         <link linkend="guint">guint</link> in_Stream_ID,
 
211
                                                         <link linkend="guchar">guchar</link> in_Event,
213
212
                                                         <link linkend="GError">GError</link> **error,
214
213
                                                         <link linkend="GMainLoop">GMainLoop</link> **loop);
215
214
<link linkend="gboolean">gboolean</link>            <link linkend="tp-cli-channel-interface-dtmf-run-stop-tone">tp_cli_channel_interface_dtmf_run_stop_tone</link>
216
215
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
217
216
                                                         <link linkend="gint">gint</link> timeout_ms,
218
 
                                                         <link linkend="guint">guint</link> in_stream_id,
 
217
                                                         <link linkend="guint">guint</link> in_Stream_ID,
219
218
                                                         <link linkend="GError">GError</link> **error,
220
219
                                                         <link linkend="GMainLoop">GMainLoop</link> **loop);
221
 
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* <link linkend="tp-cli-channel-interface-dtmf-call-start-tone">tp_cli_channel_interface_dtmf_call_start_tone</link>
 
220
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * <link linkend="tp-cli-channel-interface-dtmf-call-start-tone">tp_cli_channel_interface_dtmf_call_start_tone</link>
222
221
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
223
222
                                                         <link linkend="gint">gint</link> timeout_ms,
224
 
                                                         <link linkend="guint">guint</link> in_stream_id,
225
 
                                                         <link linkend="guchar">guchar</link> in_event,
 
223
                                                         <link linkend="guint">guint</link> in_Stream_ID,
 
224
                                                         <link linkend="guchar">guchar</link> in_Event,
226
225
                                                         <link linkend="tp-cli-channel-interface-dtmf-callback-for-start-tone">tp_cli_channel_interface_dtmf_callback_for_start_tone</link> callback,
227
226
                                                         <link linkend="gpointer">gpointer</link> user_data,
228
227
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy,
229
228
                                                         <link linkend="GObject">GObject</link> *weak_object);
230
 
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* <link linkend="tp-cli-channel-interface-dtmf-call-stop-tone">tp_cli_channel_interface_dtmf_call_stop_tone</link>
 
229
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * <link linkend="tp-cli-channel-interface-dtmf-call-stop-tone">tp_cli_channel_interface_dtmf_call_stop_tone</link>
231
230
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
232
231
                                                         <link linkend="gint">gint</link> timeout_ms,
233
 
                                                         <link linkend="guint">guint</link> in_stream_id,
 
232
                                                         <link linkend="guint">guint</link> in_Stream_ID,
234
233
                                                         <link linkend="tp-cli-channel-interface-dtmf-callback-for-stop-tone">tp_cli_channel_interface_dtmf_callback_for_stop_tone</link> callback,
235
234
                                                         <link linkend="gpointer">gpointer</link> user_data,
236
235
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy,
253
252
                                                         const <link linkend="GError">GError</link> *error,
254
253
                                                         <link linkend="gpointer">gpointer</link> user_data,
255
254
                                                         <link linkend="GObject">GObject</link> *weak_object);
256
 
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* <link linkend="tp-cli-channel-interface-hold-call-get-hold-state">tp_cli_channel_interface_hold_call_get_hold_state</link>
 
255
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * <link linkend="tp-cli-channel-interface-hold-call-get-hold-state">tp_cli_channel_interface_hold_call_get_hold_state</link>
257
256
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
258
257
                                                         <link linkend="gint">gint</link> timeout_ms,
259
258
                                                         <link linkend="tp-cli-channel-interface-hold-callback-for-get-hold-state">tp_cli_channel_interface_hold_callback_for_get_hold_state</link> callback,
272
271
                                                         const <link linkend="GError">GError</link> *error,
273
272
                                                         <link linkend="gpointer">gpointer</link> user_data,
274
273
                                                         <link linkend="GObject">GObject</link> *weak_object);
275
 
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* <link linkend="tp-cli-channel-interface-hold-call-request-hold">tp_cli_channel_interface_hold_call_request_hold</link>
 
274
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * <link linkend="tp-cli-channel-interface-hold-call-request-hold">tp_cli_channel_interface_hold_call_request_hold</link>
276
275
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
277
276
                                                         <link linkend="gint">gint</link> timeout_ms,
278
277
                                                         <link linkend="gboolean">gboolean</link> in_Hold,
292
291
                                                         <link linkend="guint">guint</link> arg_Reason,
293
292
                                                         <link linkend="gpointer">gpointer</link> user_data,
294
293
                                                         <link linkend="GObject">GObject</link> *weak_object);
295
 
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* <link linkend="tp-cli-channel-interface-hold-connect-to-hold-state-changed">tp_cli_channel_interface_hold_connect_to_hold_state_changed</link>
 
294
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * <link linkend="tp-cli-channel-interface-hold-connect-to-hold-state-changed">tp_cli_channel_interface_hold_connect_to_hold_state_changed</link>
296
295
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
297
296
                                                         <link linkend="tp-cli-channel-interface-hold-signal-callback-hold-state-changed">tp_cli_channel_interface_hold_signal_callback_hold_state_changed</link> callback,
298
297
                                                         <link linkend="gpointer">gpointer</link> user_data,
303
302
<link linkend="gboolean">gboolean</link>            <link linkend="tp-cli-channel-interface-media-signalling-run-get-session-handlers">tp_cli_channel_interface_media_signalling_run_get_session_handlers</link>
304
303
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
305
304
                                                         <link linkend="gint">gint</link> timeout_ms,
306
 
                                                         <link linkend="GPtrArray">GPtrArray</link> **out0,
 
305
                                                         <link linkend="GPtrArray">GPtrArray</link> **out_Session_Handlers,
307
306
                                                         <link linkend="GError">GError</link> **error,
308
307
                                                         <link linkend="GMainLoop">GMainLoop</link> **loop);
309
 
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* <link linkend="tp-cli-channel-interface-media-signalling-call-get-session-handlers">tp_cli_channel_interface_media_signalling_call_get_session_handlers</link>
 
308
<link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * <link linkend="tp-cli-channel-interface-media-signalling-call-get-session-handlers">tp_cli_channel_interface_media_signalling_call_get_session_handlers</link>
310
309
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
311
310
                                                         <link linkend="gint">gint</link> timeout_ms,
312
311
                                                         <link linkend="tp-cli-channel-interface-media-signalling-callback-for-get-session-handlers">tp_cli_channel_interface_media_signalling_callback_for_get_session_handlers</link> callback,
315
314
                                                         <link linkend="GObject">GObject</link> *weak_object);
316
315
<link linkend="void">void</link>                (<link linkend="tp-cli-channel-interface-media-signalling-callback-for-get-session-handlers">*tp_cli_channel_interface_media_signalling_callback_for_get_session_handlers</link>)
317
316
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
318
 
                                                         const <link linkend="GPtrArray">GPtrArray</link> *out0,
 
317
                                                         const <link linkend="GPtrArray">GPtrArray</link> *out_Session_Handlers,
319
318
                                                         const <link linkend="GError">GError</link> *error,
320
319
                                                         <link linkend="gpointer">gpointer</link> user_data,
321
320
                                                         <link linkend="GObject">GObject</link> *weak_object);
322
 
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* <link linkend="tp-cli-channel-interface-media-signalling-connect-to-new-session-handler">tp_cli_channel_interface_media_signalling_connect_to_new_session_handler</link>
 
321
<link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * <link linkend="tp-cli-channel-interface-media-signalling-connect-to-new-session-handler">tp_cli_channel_interface_media_signalling_connect_to_new_session_handler</link>
323
322
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
324
323
                                                         <link linkend="tp-cli-channel-interface-media-signalling-signal-callback-new-session-handler">tp_cli_channel_interface_media_signalling_signal_callback_new_session_handler</link> callback,
325
324
                                                         <link linkend="gpointer">gpointer</link> user_data,
375
374
Channels of type Streamed Media may also support the DTMF and
376
375
CallState interfaces.</para>
377
376
<para>
378
 
 
379
377
</para>
380
378
</refsect1>
381
379
 
383
381
<title role="details.title">Details</title>
384
382
<refsect2 id="tp-cli-channel-type-streamed-media-call-list-streams" role="function">
385
383
<title>tp_cli_channel_type_streamed_media_call_list_streams ()</title>
386
 
<indexterm zone="tp-cli-channel-type-streamed-media-call-list-streams"><primary>tp_cli_channel_type_streamed_media_call_list_streams</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* tp_cli_channel_type_streamed_media_call_list_streams
 
384
<indexterm zone="tp-cli-channel-type-streamed-media-call-list-streams"><primary sortas="tp_cli_channel_type_streamed_media_call_list_streams">tp_cli_channel_type_streamed_media_call_list_streams</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * tp_cli_channel_type_streamed_media_call_list_streams
387
385
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
388
386
                                                         <link linkend="gint">gint</link> timeout_ms,
389
387
                                                         <link linkend="tp-cli-channel-type-streamed-media-callback-for-list-streams">tp_cli_channel_type_streamed_media_callback_for_list_streams</link> callback,
396
394
<para>
397
395
Returns an array of structs representing the streams currently active         within this channel. Each stream is identified by an unsigned integer         which is unique for each stream within the channel.</para>
398
396
<para>
399
 
 
400
397
</para><variablelist role="params">
401
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
398
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
402
399
<listitem><simpara> the <link linkend="TpProxy"><type>TpProxy</type></link>
403
400
</simpara></listitem></varlistentry>
404
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
401
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
405
402
<listitem><simpara> the timeout in milliseconds, or -1 to use the
406
403
  default
407
404
</simpara></listitem></varlistentry>
408
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
405
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
409
406
<listitem><simpara> called when the method call succeeds or fails;
410
 
  may be <link linkend="NULL:CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
 
407
  may be <link linkend="NULL--CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
411
408
  reply tracking
412
409
</simpara></listitem></varlistentry>
413
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
410
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
414
411
<listitem><simpara> user-supplied data passed to the callback;
415
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
412
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
416
413
</simpara></listitem></varlistentry>
417
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
414
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
418
415
<listitem><simpara> called with the user_data as argument, after the
419
416
  call has succeeded, failed or been cancelled;
420
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
417
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
421
418
</simpara></listitem></varlistentry>
422
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
423
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
 
419
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
 
420
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
424
421
  weakly referenced; if it is destroyed, this call 
425
 
  will automatically be cancelled. Must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if 
426
 
  <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
422
  will automatically be cancelled. Must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if 
 
423
  <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
427
424
</simpara></listitem></varlistentry>
428
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
 
425
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
429
426
 progress. It is borrowed from the object, and will become
430
427
 invalid when the callback is called, the call is
431
428
 cancelled or the <link linkend="TpProxy"><type>TpProxy</type></link> becomes invalid.
433
430
</variablelist></refsect2>
434
431
<refsect2 id="tp-cli-channel-type-streamed-media-call-remove-streams" role="function">
435
432
<title>tp_cli_channel_type_streamed_media_call_remove_streams ()</title>
436
 
<indexterm zone="tp-cli-channel-type-streamed-media-call-remove-streams"><primary>tp_cli_channel_type_streamed_media_call_remove_streams</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* tp_cli_channel_type_streamed_media_call_remove_streams
 
433
<indexterm zone="tp-cli-channel-type-streamed-media-call-remove-streams"><primary sortas="tp_cli_channel_type_streamed_media_call_remove_streams">tp_cli_channel_type_streamed_media_call_remove_streams</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * tp_cli_channel_type_streamed_media_call_remove_streams
437
434
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
438
435
                                                         <link linkend="gint">gint</link> timeout_ms,
439
 
                                                         const <link linkend="GArray">GArray</link> *in_streams,
 
436
                                                         const <link linkend="GArray">GArray</link> *in_Streams,
440
437
                                                         <link linkend="tp-cli-channel-type-streamed-media-callback-for-remove-streams">tp_cli_channel_type_streamed_media_callback_for_remove_streams</link> callback,
441
438
                                                         <link linkend="gpointer">gpointer</link> user_data,
442
439
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy,
445
442
Start a RemoveStreams method call.
446
443
</para>
447
444
<para>
448
 
Request that the given streams are removed.</para>
 
445
&lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;         &lt;p&gt;Request that the given streams are removed. If all streams are           removed, the channel MAY close.&lt;/p&gt;          &lt;p&gt;Clients SHOULD NOT attempt to terminate calls by removing all the           streams; instead, clients SHOULD terminate calls by removing the           &lt;tp:dbus-ref namespace=&quot;org.freedesktop.Telepathy.Channel.Interface&quot;&gt;Group.SelfHandle&lt;/tp:dbus-ref&gt;           from the channel, using either           &lt;tp:dbus-ref namespace=&quot;org.freedesktop.Telepathy.Channel.Interface.Group&quot;&gt;RemoveMembers&lt;/tp:dbus-ref&gt;           or           &lt;tp:dbus-ref namespace=&quot;org.freedesktop.Telepathy.Channel.Interface.Group&quot;&gt;RemoveMembersWithReason&lt;/tp:dbus-ref&gt;.           &lt;/p&gt;</para>
449
446
<para>
450
 
 
451
447
</para><variablelist role="params">
452
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
448
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
453
449
<listitem><simpara> the <link linkend="TpProxy"><type>TpProxy</type></link>
454
450
</simpara></listitem></varlistentry>
455
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
451
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
456
452
<listitem><simpara> the timeout in milliseconds, or -1 to use the
457
453
  default
458
454
</simpara></listitem></varlistentry>
459
 
<varlistentry><term><parameter>in_streams</parameter>&nbsp;:</term>
460
 
<listitem><simpara> Used to pass an 'in' argument: An array of stream identifiers (as defined in ListStreams)
 
455
<varlistentry><term><parameter>in_Streams</parameter>&#160;:</term>
 
456
<listitem><simpara> Used to pass an 'in' argument: An array of stream identifiers (as defined in           &lt;tp:member-ref&gt;ListStreams&lt;/tp:member-ref&gt;)
461
457
</simpara></listitem></varlistentry>
462
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
458
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
463
459
<listitem><simpara> called when the method call succeeds or fails;
464
 
  may be <link linkend="NULL:CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
 
460
  may be <link linkend="NULL--CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
465
461
  reply tracking
466
462
</simpara></listitem></varlistentry>
467
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
463
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
468
464
<listitem><simpara> user-supplied data passed to the callback;
469
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
465
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
470
466
</simpara></listitem></varlistentry>
471
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
467
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
472
468
<listitem><simpara> called with the user_data as argument, after the
473
469
  call has succeeded, failed or been cancelled;
474
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
470
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
475
471
</simpara></listitem></varlistentry>
476
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
477
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
 
472
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
 
473
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
478
474
  weakly referenced; if it is destroyed, this call 
479
 
  will automatically be cancelled. Must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if 
480
 
  <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
475
  will automatically be cancelled. Must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if 
 
476
  <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
481
477
</simpara></listitem></varlistentry>
482
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
 
478
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
483
479
 progress. It is borrowed from the object, and will become
484
480
 invalid when the callback is called, the call is
485
481
 cancelled or the <link linkend="TpProxy"><type>TpProxy</type></link> becomes invalid.
487
483
</variablelist></refsect2>
488
484
<refsect2 id="tp-cli-channel-type-streamed-media-call-request-stream-direction" role="function">
489
485
<title>tp_cli_channel_type_streamed_media_call_request_stream_direction ()</title>
490
 
<indexterm zone="tp-cli-channel-type-streamed-media-call-request-stream-direction"><primary>tp_cli_channel_type_streamed_media_call_request_stream_direction</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* tp_cli_channel_type_streamed_media_call_request_stream_direction
 
486
<indexterm zone="tp-cli-channel-type-streamed-media-call-request-stream-direction"><primary sortas="tp_cli_channel_type_streamed_media_call_request_stream_direction">tp_cli_channel_type_streamed_media_call_request_stream_direction</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * tp_cli_channel_type_streamed_media_call_request_stream_direction
491
487
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
492
488
                                                         <link linkend="gint">gint</link> timeout_ms,
493
 
                                                         <link linkend="guint">guint</link> in_stream_id,
494
 
                                                         <link linkend="guint">guint</link> in_stream_direction,
 
489
                                                         <link linkend="guint">guint</link> in_Stream_ID,
 
490
                                                         <link linkend="guint">guint</link> in_Stream_Direction,
495
491
                                                         <link linkend="tp-cli-channel-type-streamed-media-callback-for-request-stream-direction">tp_cli_channel_type_streamed_media_callback_for_request_stream_direction</link> callback,
496
492
                                                         <link linkend="gpointer">gpointer</link> user_data,
497
493
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy,
500
496
Start a RequestStreamDirection method call.
501
497
</para>
502
498
<para>
503
 
&lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;         &lt;p&gt;Request a change in the direction of an existing stream. In particular,         this might be useful to stop sending media of a particular type,         or inform the peer that you are no longer using media that is being         sent to you.&lt;/p&gt;          &lt;p&gt;Depending on the protocol, streams which are no longer sending in         either direction should be removed and a StreamRemoved signal emitted.         Some direction changes can be enforced locally (for example,         BIDIRECTIONAL -&amp;gt; RECEIVE can be achieved by merely stopping sending),         others may not be possible on some protocols, and some need agreement         from the remote end. In this case, the MEDIA_STREAM_PENDING_REMOTE_SEND         flag will be set in the StreamDirectionChanged signal, and the signal         emitted again without the flag to indicate the resulting direction when         the remote end has accepted or rejected the change.&lt;/p&gt;</para>
 
499
&lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;         &lt;p&gt;Request a change in the direction of an existing stream. In particular,         this might be useful to stop sending media of a particular type,         or inform the peer that you are no longer using media that is being         sent to you.&lt;/p&gt;          &lt;p&gt;Depending on the protocol, streams which are no longer sending in         either direction should be removed and a         &lt;tp:member-ref&gt;StreamRemoved&lt;/tp:member-ref&gt; signal emitted.         Some direction changes can be enforced locally (for example,         BIDIRECTIONAL -&amp;gt; RECEIVE can be achieved by merely stopping sending),         others may not be possible on some protocols, and some need agreement         from the remote end. In this case, the MEDIA_STREAM_PENDING_REMOTE_SEND         flag will be set in the         &lt;tp:member-ref&gt;StreamDirectionChanged&lt;/tp:member-ref&gt; signal, and the         signal         emitted again without the flag to indicate the resulting direction when         the remote end has accepted or rejected the change.&lt;/p&gt;</para>
504
500
<para>
505
 
 
506
501
</para><variablelist role="params">
507
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
502
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
508
503
<listitem><simpara> the <link linkend="TpProxy"><type>TpProxy</type></link>
509
504
</simpara></listitem></varlistentry>
510
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
505
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
511
506
<listitem><simpara> the timeout in milliseconds, or -1 to use the
512
507
  default
513
508
</simpara></listitem></varlistentry>
514
 
<varlistentry><term><parameter>in_stream_id</parameter>&nbsp;:</term>
515
 
<listitem><simpara> Used to pass an 'in' argument: The stream identifier (as defined in ListStreams)
 
509
<varlistentry><term><parameter>in_Stream_ID</parameter>&#160;:</term>
 
510
<listitem><simpara> Used to pass an 'in' argument: The stream identifier (as defined in           &lt;tp:member-ref&gt;ListStreams&lt;/tp:member-ref&gt;)
516
511
</simpara></listitem></varlistentry>
517
 
<varlistentry><term><parameter>in_stream_direction</parameter>&nbsp;:</term>
 
512
<varlistentry><term><parameter>in_Stream_Direction</parameter>&#160;:</term>
518
513
<listitem><simpara> Used to pass an 'in' argument: The desired stream direction (a value of MediaStreamDirection)
519
514
</simpara></listitem></varlistentry>
520
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
515
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
521
516
<listitem><simpara> called when the method call succeeds or fails;
522
 
  may be <link linkend="NULL:CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
 
517
  may be <link linkend="NULL--CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
523
518
  reply tracking
524
519
</simpara></listitem></varlistentry>
525
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
520
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
526
521
<listitem><simpara> user-supplied data passed to the callback;
527
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
522
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
528
523
</simpara></listitem></varlistentry>
529
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
524
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
530
525
<listitem><simpara> called with the user_data as argument, after the
531
526
  call has succeeded, failed or been cancelled;
532
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
527
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
533
528
</simpara></listitem></varlistentry>
534
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
535
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
 
529
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
 
530
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
536
531
  weakly referenced; if it is destroyed, this call 
537
 
  will automatically be cancelled. Must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if 
538
 
  <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
532
  will automatically be cancelled. Must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if 
 
533
  <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
539
534
</simpara></listitem></varlistentry>
540
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
 
535
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
541
536
 progress. It is borrowed from the object, and will become
542
537
 invalid when the callback is called, the call is
543
538
 cancelled or the <link linkend="TpProxy"><type>TpProxy</type></link> becomes invalid.
545
540
</variablelist></refsect2>
546
541
<refsect2 id="tp-cli-channel-type-streamed-media-call-request-streams" role="function">
547
542
<title>tp_cli_channel_type_streamed_media_call_request_streams ()</title>
548
 
<indexterm zone="tp-cli-channel-type-streamed-media-call-request-streams"><primary>tp_cli_channel_type_streamed_media_call_request_streams</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* tp_cli_channel_type_streamed_media_call_request_streams
 
543
<indexterm zone="tp-cli-channel-type-streamed-media-call-request-streams"><primary sortas="tp_cli_channel_type_streamed_media_call_request_streams">tp_cli_channel_type_streamed_media_call_request_streams</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * tp_cli_channel_type_streamed_media_call_request_streams
549
544
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
550
545
                                                         <link linkend="gint">gint</link> timeout_ms,
551
 
                                                         <link linkend="guint">guint</link> in_contact_handle,
552
 
                                                         const <link linkend="GArray">GArray</link> *in_types,
 
546
                                                         <link linkend="guint">guint</link> in_Contact_Handle,
 
547
                                                         const <link linkend="GArray">GArray</link> *in_Types,
553
548
                                                         <link linkend="tp-cli-channel-type-streamed-media-callback-for-request-streams">tp_cli_channel_type_streamed_media_callback_for_request_streams</link> callback,
554
549
                                                         <link linkend="gpointer">gpointer</link> user_data,
555
550
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy,
558
553
Start a RequestStreams method call.
559
554
</para>
560
555
<para>
561
 
&lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;         &lt;p&gt;Request that streams be established to exchange the given types of         media with the given member. In general this will try and establish a         bidirectional stream, but on some protocols it may not be possible to         indicate to the peer that you would like to receive media, so a         send-only stream will be created initially. In the cases where the         stream requires remote agreement (eg you wish to receive media from         them), the StreamDirectionChanged signal will be emitted with the         MEDIA_STREAM_PENDING_REMOTE_SEND flag set, and the signal emitted again         with the flag cleared when the remote end has replied.&lt;/p&gt;</para>
 
556
&lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;         &lt;p&gt;Request that streams be established to exchange the given types of         media with the given member. In general this will try and establish a         bidirectional stream, but on some protocols it may not be possible to         indicate to the peer that you would like to receive media, so a         send-only stream will be created initially. In the cases where the         stream requires remote agreement (eg you wish to receive media from         them), the &lt;tp:member-ref&gt;StreamDirectionChanged&lt;/tp:member-ref&gt; signal         will be emitted with the         MEDIA_STREAM_PENDING_REMOTE_SEND flag set, and the signal emitted again         with the flag cleared when the remote end has replied.&lt;/p&gt;          &lt;p&gt;If streams of the requested types already exist, calling this           method results in the creation of additional streams. Accordingly,           clients wishing to have exactly one audio stream or exactly one           video stream SHOULD check for the current streams using           &lt;tp:member-ref&gt;ListStreams&lt;/tp:member-ref&gt; before calling this           method.&lt;/p&gt;</para>
562
557
<para>
563
 
 
564
558
</para><variablelist role="params">
565
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
559
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
566
560
<listitem><simpara> the <link linkend="TpProxy"><type>TpProxy</type></link>
567
561
</simpara></listitem></varlistentry>
568
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
562
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
569
563
<listitem><simpara> the timeout in milliseconds, or -1 to use the
570
564
  default
571
565
</simpara></listitem></varlistentry>
572
 
<varlistentry><term><parameter>in_contact_handle</parameter>&nbsp;:</term>
 
566
<varlistentry><term><parameter>in_Contact_Handle</parameter>&#160;:</term>
573
567
<listitem><simpara> Used to pass an 'in' argument: A contact handle with whom to establish the streams
574
568
</simpara></listitem></varlistentry>
575
 
<varlistentry><term><parameter>in_types</parameter>&nbsp;:</term>
 
569
<varlistentry><term><parameter>in_Types</parameter>&#160;:</term>
576
570
<listitem><simpara> Used to pass an 'in' argument: An array of stream types (values of MediaStreamType)
577
571
</simpara></listitem></varlistentry>
578
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
572
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
579
573
<listitem><simpara> called when the method call succeeds or fails;
580
 
  may be <link linkend="NULL:CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
 
574
  may be <link linkend="NULL--CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
581
575
  reply tracking
582
576
</simpara></listitem></varlistentry>
583
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
577
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
584
578
<listitem><simpara> user-supplied data passed to the callback;
585
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
579
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
586
580
</simpara></listitem></varlistentry>
587
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
581
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
588
582
<listitem><simpara> called with the user_data as argument, after the
589
583
  call has succeeded, failed or been cancelled;
590
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
584
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
591
585
</simpara></listitem></varlistentry>
592
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
593
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
 
586
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
 
587
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
594
588
  weakly referenced; if it is destroyed, this call 
595
 
  will automatically be cancelled. Must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if 
596
 
  <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
589
  will automatically be cancelled. Must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if 
 
590
  <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
597
591
</simpara></listitem></varlistentry>
598
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
 
592
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
599
593
 progress. It is borrowed from the object, and will become
600
594
 invalid when the callback is called, the call is
601
595
 cancelled or the <link linkend="TpProxy"><type>TpProxy</type></link> becomes invalid.
603
597
</variablelist></refsect2>
604
598
<refsect2 id="tp-cli-channel-type-streamed-media-callback-for-list-streams" role="function">
605
599
<title>tp_cli_channel_type_streamed_media_callback_for_list_streams ()</title>
606
 
<indexterm zone="tp-cli-channel-type-streamed-media-callback-for-list-streams"><primary>tp_cli_channel_type_streamed_media_callback_for_list_streams</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_callback_for_list_streams)
 
600
<indexterm zone="tp-cli-channel-type-streamed-media-callback-for-list-streams"><primary sortas="tp_cli_channel_type_streamed_media_callback_for_list_streams">tp_cli_channel_type_streamed_media_callback_for_list_streams</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_callback_for_list_streams)
607
601
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
608
 
                                                         const <link linkend="GPtrArray">GPtrArray</link> *out0,
 
602
                                                         const <link linkend="GPtrArray">GPtrArray</link> *out_Streams,
609
603
                                                         const <link linkend="GError">GError</link> *error,
610
604
                                                         <link linkend="gpointer">gpointer</link> user_data,
611
605
                                                         <link linkend="GObject">GObject</link> *weak_object);</programlisting>
613
607
Signature of the callback called when a ListStreams method call
614
608
succeeds or fails.</para>
615
609
<para>
616
 
 
617
610
</para><variablelist role="params">
618
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
611
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
619
612
<listitem><simpara> the proxy on which the call was made
620
613
</simpara></listitem></varlistentry>
621
 
<varlistentry><term><parameter>out0</parameter>&nbsp;:</term>
622
 
<listitem><simpara> Used to return an 'out' argument if <parameter>error</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>: &lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;           An array of structs containing:           &lt;ul&gt;           &lt;li&gt;the stream identifier&lt;/li&gt;           &lt;li&gt;the contact handle who the stream is with (or 0 if the stream             represents more than a single member)&lt;/li&gt;           &lt;li&gt;the type of the stream&lt;/li&gt;           &lt;li&gt;the current stream state&lt;/li&gt;           &lt;li&gt;the current direction of the stream&lt;/li&gt;           &lt;li&gt;the current pending send flags&lt;/li&gt;           &lt;/ul&gt;
623
 
</simpara></listitem></varlistentry>
624
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
625
 
<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link> on success, or an error on failure
626
 
</simpara></listitem></varlistentry>
627
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
614
<varlistentry><term><parameter>out_Streams</parameter>&#160;:</term>
 
615
<listitem><simpara> Used to return an 'out' argument if <parameter>error</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>: &lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;           An array of structs containing:           &lt;ul&gt;           &lt;li&gt;the stream identifier&lt;/li&gt;           &lt;li&gt;the contact handle who the stream is with (or 0 if the stream             represents more than a single member)&lt;/li&gt;           &lt;li&gt;the type of the stream&lt;/li&gt;           &lt;li&gt;the current stream state&lt;/li&gt;           &lt;li&gt;the current direction of the stream&lt;/li&gt;           &lt;li&gt;the current pending send flags&lt;/li&gt;           &lt;/ul&gt;
 
616
</simpara></listitem></varlistentry>
 
617
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
618
<listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link> on success, or an error on failure
 
619
</simpara></listitem></varlistentry>
 
620
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
628
621
<listitem><simpara> user-supplied data
629
622
</simpara></listitem></varlistentry>
630
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
623
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
631
624
<listitem><simpara> user-supplied object
632
625
</simpara></listitem></varlistentry>
633
626
</variablelist></refsect2>
634
627
<refsect2 id="tp-cli-channel-type-streamed-media-callback-for-remove-streams" role="function">
635
628
<title>tp_cli_channel_type_streamed_media_callback_for_remove_streams ()</title>
636
 
<indexterm zone="tp-cli-channel-type-streamed-media-callback-for-remove-streams"><primary>tp_cli_channel_type_streamed_media_callback_for_remove_streams</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_callback_for_remove_streams)
 
629
<indexterm zone="tp-cli-channel-type-streamed-media-callback-for-remove-streams"><primary sortas="tp_cli_channel_type_streamed_media_callback_for_remove_streams">tp_cli_channel_type_streamed_media_callback_for_remove_streams</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_callback_for_remove_streams)
637
630
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
638
631
                                                         const <link linkend="GError">GError</link> *error,
639
632
                                                         <link linkend="gpointer">gpointer</link> user_data,
642
635
Signature of the callback called when a RemoveStreams method call
643
636
succeeds or fails.</para>
644
637
<para>
645
 
 
646
638
</para><variablelist role="params">
647
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
639
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
648
640
<listitem><simpara> the proxy on which the call was made
649
641
</simpara></listitem></varlistentry>
650
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
651
 
<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link> on success, or an error on failure
 
642
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
643
<listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link> on success, or an error on failure
652
644
</simpara></listitem></varlistentry>
653
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
645
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
654
646
<listitem><simpara> user-supplied data
655
647
</simpara></listitem></varlistentry>
656
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
648
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
657
649
<listitem><simpara> user-supplied object
658
650
</simpara></listitem></varlistentry>
659
651
</variablelist></refsect2>
660
652
<refsect2 id="tp-cli-channel-type-streamed-media-callback-for-request-stream-direction" role="function">
661
653
<title>tp_cli_channel_type_streamed_media_callback_for_request_stream_direction ()</title>
662
 
<indexterm zone="tp-cli-channel-type-streamed-media-callback-for-request-stream-direction"><primary>tp_cli_channel_type_streamed_media_callback_for_request_stream_direction</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_callback_for_request_stream_direction)
 
654
<indexterm zone="tp-cli-channel-type-streamed-media-callback-for-request-stream-direction"><primary sortas="tp_cli_channel_type_streamed_media_callback_for_request_stream_direction">tp_cli_channel_type_streamed_media_callback_for_request_stream_direction</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_callback_for_request_stream_direction)
663
655
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
664
656
                                                         const <link linkend="GError">GError</link> *error,
665
657
                                                         <link linkend="gpointer">gpointer</link> user_data,
668
660
Signature of the callback called when a RequestStreamDirection method call
669
661
succeeds or fails.</para>
670
662
<para>
671
 
 
672
663
</para><variablelist role="params">
673
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
664
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
674
665
<listitem><simpara> the proxy on which the call was made
675
666
</simpara></listitem></varlistentry>
676
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
677
 
<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link> on success, or an error on failure
 
667
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
668
<listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link> on success, or an error on failure
678
669
</simpara></listitem></varlistentry>
679
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
670
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
680
671
<listitem><simpara> user-supplied data
681
672
</simpara></listitem></varlistentry>
682
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
673
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
683
674
<listitem><simpara> user-supplied object
684
675
</simpara></listitem></varlistentry>
685
676
</variablelist></refsect2>
686
677
<refsect2 id="tp-cli-channel-type-streamed-media-callback-for-request-streams" role="function">
687
678
<title>tp_cli_channel_type_streamed_media_callback_for_request_streams ()</title>
688
 
<indexterm zone="tp-cli-channel-type-streamed-media-callback-for-request-streams"><primary>tp_cli_channel_type_streamed_media_callback_for_request_streams</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_callback_for_request_streams)
 
679
<indexterm zone="tp-cli-channel-type-streamed-media-callback-for-request-streams"><primary sortas="tp_cli_channel_type_streamed_media_callback_for_request_streams">tp_cli_channel_type_streamed_media_callback_for_request_streams</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_callback_for_request_streams)
689
680
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
690
 
                                                         const <link linkend="GPtrArray">GPtrArray</link> *out0,
 
681
                                                         const <link linkend="GPtrArray">GPtrArray</link> *out_Streams,
691
682
                                                         const <link linkend="GError">GError</link> *error,
692
683
                                                         <link linkend="gpointer">gpointer</link> user_data,
693
684
                                                         <link linkend="GObject">GObject</link> *weak_object);</programlisting>
695
686
Signature of the callback called when a RequestStreams method call
696
687
succeeds or fails.</para>
697
688
<para>
698
 
 
699
689
</para><variablelist role="params">
700
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
690
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
701
691
<listitem><simpara> the proxy on which the call was made
702
692
</simpara></listitem></varlistentry>
703
 
<varlistentry><term><parameter>out0</parameter>&nbsp;:</term>
704
 
<listitem><simpara> Used to return an 'out' argument if <parameter>error</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>: &lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;           An array of structs (in the same order as the given stream types)           containing:           &lt;ul&gt;             &lt;li&gt;the stream identifier&lt;/li&gt;             &lt;li&gt;the contact handle who the stream is with (or 0 if the stream               represents more than a single member)&lt;/li&gt;             &lt;li&gt;the type of the stream&lt;/li&gt;             &lt;li&gt;the current stream state&lt;/li&gt;             &lt;li&gt;the current direction of the stream&lt;/li&gt;             &lt;li&gt;the current pending send flags&lt;/li&gt;           &lt;/ul&gt;
705
 
</simpara></listitem></varlistentry>
706
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
707
 
<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link> on success, or an error on failure
708
 
</simpara></listitem></varlistentry>
709
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
693
<varlistentry><term><parameter>out_Streams</parameter>&#160;:</term>
 
694
<listitem><simpara> Used to return an 'out' argument if <parameter>error</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>: &lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;           An array of structs (in the same order as the given stream types)           containing:           &lt;ul&gt;             &lt;li&gt;the stream identifier&lt;/li&gt;             &lt;li&gt;the contact handle who the stream is with (or 0 if the stream               represents more than a single member)&lt;/li&gt;             &lt;li&gt;the type of the stream&lt;/li&gt;             &lt;li&gt;the current stream state&lt;/li&gt;             &lt;li&gt;the current direction of the stream&lt;/li&gt;             &lt;li&gt;the current pending send flags&lt;/li&gt;           &lt;/ul&gt;
 
695
</simpara></listitem></varlistentry>
 
696
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
697
<listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link> on success, or an error on failure
 
698
</simpara></listitem></varlistentry>
 
699
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
710
700
<listitem><simpara> user-supplied data
711
701
</simpara></listitem></varlistentry>
712
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
702
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
713
703
<listitem><simpara> user-supplied object
714
704
</simpara></listitem></varlistentry>
715
705
</variablelist></refsect2>
716
706
<refsect2 id="tp-cli-channel-type-streamed-media-run-list-streams" role="function">
717
707
<title>tp_cli_channel_type_streamed_media_run_list_streams ()</title>
718
 
<indexterm zone="tp-cli-channel-type-streamed-media-run-list-streams"><primary>tp_cli_channel_type_streamed_media_run_list_streams</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_type_streamed_media_run_list_streams
 
708
<indexterm zone="tp-cli-channel-type-streamed-media-run-list-streams"><primary sortas="tp_cli_channel_type_streamed_media_run_list_streams">tp_cli_channel_type_streamed_media_run_list_streams</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_type_streamed_media_run_list_streams
719
709
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
720
710
                                                         <link linkend="gint">gint</link> timeout_ms,
721
 
                                                         <link linkend="GPtrArray">GPtrArray</link> **out0,
 
711
                                                         <link linkend="GPtrArray">GPtrArray</link> **out_Streams,
722
712
                                                         <link linkend="GError">GError</link> **error,
723
713
                                                         <link linkend="GMainLoop">GMainLoop</link> **loop);</programlisting>
724
714
<para>
731
721
<para>
732
722
Returns an array of structs representing the streams currently active         within this channel. Each stream is identified by an unsigned integer         which is unique for each stream within the channel.</para>
733
723
<para>
734
 
 
735
724
</para><variablelist role="params">
736
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
725
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
737
726
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
738
727
</simpara></listitem></varlistentry>
739
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
728
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
740
729
<listitem><simpara> Timeout in milliseconds, or -1 for default
741
730
</simpara></listitem></varlistentry>
742
 
<varlistentry><term><parameter>out0</parameter>&nbsp;:</term>
743
 
<listitem><simpara> Used to return an 'out' argument if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> is returned: &lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;           An array of structs containing:           &lt;ul&gt;           &lt;li&gt;the stream identifier&lt;/li&gt;           &lt;li&gt;the contact handle who the stream is with (or 0 if the stream             represents more than a single member)&lt;/li&gt;           &lt;li&gt;the type of the stream&lt;/li&gt;           &lt;li&gt;the current stream state&lt;/li&gt;           &lt;li&gt;the current direction of the stream&lt;/li&gt;           &lt;li&gt;the current pending send flags&lt;/li&gt;           &lt;/ul&gt;
 
731
<varlistentry><term><parameter>out_Streams</parameter>&#160;:</term>
 
732
<listitem><simpara> Used to return an 'out' argument if <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> is returned: &lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;           An array of structs containing:           &lt;ul&gt;           &lt;li&gt;the stream identifier&lt;/li&gt;           &lt;li&gt;the contact handle who the stream is with (or 0 if the stream             represents more than a single member)&lt;/li&gt;           &lt;li&gt;the type of the stream&lt;/li&gt;           &lt;li&gt;the current stream state&lt;/li&gt;           &lt;li&gt;the current direction of the stream&lt;/li&gt;           &lt;li&gt;the current pending send flags&lt;/li&gt;           &lt;/ul&gt;
744
733
</simpara></listitem></varlistentry>
745
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
746
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> 
 
734
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
735
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> 
747
736
 is returned
748
737
</simpara></listitem></varlistentry>
749
 
<varlistentry><term><parameter>loop</parameter>&nbsp;:</term>
750
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, set before re-entering 
 
738
<varlistentry><term><parameter>loop</parameter>&#160;:</term>
 
739
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, set before re-entering 
751
740
 the main loop, to point to a <link linkend="GMainLoop"><type>GMainLoop</type></link> 
752
741
 which can be used to cancel this call with 
753
742
 <link linkend="g-main-loop-quit"><function>g_main_loop_quit()</function></link>, causing a return of 
754
 
 <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED:CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
 
743
 <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED--CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
755
744
</simpara></listitem></varlistentry>
756
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
 
745
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
757
746
</simpara></listitem></varlistentry>
758
747
</variablelist></refsect2>
759
748
<refsect2 id="tp-cli-channel-type-streamed-media-run-remove-streams" role="function">
760
749
<title>tp_cli_channel_type_streamed_media_run_remove_streams ()</title>
761
 
<indexterm zone="tp-cli-channel-type-streamed-media-run-remove-streams"><primary>tp_cli_channel_type_streamed_media_run_remove_streams</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_type_streamed_media_run_remove_streams
 
750
<indexterm zone="tp-cli-channel-type-streamed-media-run-remove-streams"><primary sortas="tp_cli_channel_type_streamed_media_run_remove_streams">tp_cli_channel_type_streamed_media_run_remove_streams</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_type_streamed_media_run_remove_streams
762
751
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
763
752
                                                         <link linkend="gint">gint</link> timeout_ms,
764
 
                                                         const <link linkend="GArray">GArray</link> *in_streams,
 
753
                                                         const <link linkend="GArray">GArray</link> *in_Streams,
765
754
                                                         <link linkend="GError">GError</link> **error,
766
755
                                                         <link linkend="GMainLoop">GMainLoop</link> **loop);</programlisting>
767
756
<para>
772
761
state.
773
762
</para>
774
763
<para>
775
 
Request that the given streams are removed.</para>
 
764
&lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;         &lt;p&gt;Request that the given streams are removed. If all streams are           removed, the channel MAY close.&lt;/p&gt;          &lt;p&gt;Clients SHOULD NOT attempt to terminate calls by removing all the           streams; instead, clients SHOULD terminate calls by removing the           &lt;tp:dbus-ref namespace=&quot;org.freedesktop.Telepathy.Channel.Interface&quot;&gt;Group.SelfHandle&lt;/tp:dbus-ref&gt;           from the channel, using either           &lt;tp:dbus-ref namespace=&quot;org.freedesktop.Telepathy.Channel.Interface.Group&quot;&gt;RemoveMembers&lt;/tp:dbus-ref&gt;           or           &lt;tp:dbus-ref namespace=&quot;org.freedesktop.Telepathy.Channel.Interface.Group&quot;&gt;RemoveMembersWithReason&lt;/tp:dbus-ref&gt;.           &lt;/p&gt;</para>
776
765
<para>
777
 
 
778
766
</para><variablelist role="params">
779
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
767
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
780
768
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
781
769
</simpara></listitem></varlistentry>
782
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
770
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
783
771
<listitem><simpara> Timeout in milliseconds, or -1 for default
784
772
</simpara></listitem></varlistentry>
785
 
<varlistentry><term><parameter>in_streams</parameter>&nbsp;:</term>
786
 
<listitem><simpara> Used to pass an 'in' argument: An array of stream identifiers (as defined in ListStreams)
 
773
<varlistentry><term><parameter>in_Streams</parameter>&#160;:</term>
 
774
<listitem><simpara> Used to pass an 'in' argument: An array of stream identifiers (as defined in           &lt;tp:member-ref&gt;ListStreams&lt;/tp:member-ref&gt;)
787
775
</simpara></listitem></varlistentry>
788
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
789
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> 
 
776
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
777
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> 
790
778
 is returned
791
779
</simpara></listitem></varlistentry>
792
 
<varlistentry><term><parameter>loop</parameter>&nbsp;:</term>
793
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, set before re-entering 
 
780
<varlistentry><term><parameter>loop</parameter>&#160;:</term>
 
781
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, set before re-entering 
794
782
 the main loop, to point to a <link linkend="GMainLoop"><type>GMainLoop</type></link> 
795
783
 which can be used to cancel this call with 
796
784
 <link linkend="g-main-loop-quit"><function>g_main_loop_quit()</function></link>, causing a return of 
797
 
 <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED:CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
 
785
 <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED--CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
798
786
</simpara></listitem></varlistentry>
799
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
 
787
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
800
788
</simpara></listitem></varlistentry>
801
789
</variablelist></refsect2>
802
790
<refsect2 id="tp-cli-channel-type-streamed-media-run-request-stream-direction" role="function">
803
791
<title>tp_cli_channel_type_streamed_media_run_request_stream_direction ()</title>
804
 
<indexterm zone="tp-cli-channel-type-streamed-media-run-request-stream-direction"><primary>tp_cli_channel_type_streamed_media_run_request_stream_direction</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_type_streamed_media_run_request_stream_direction
 
792
<indexterm zone="tp-cli-channel-type-streamed-media-run-request-stream-direction"><primary sortas="tp_cli_channel_type_streamed_media_run_request_stream_direction">tp_cli_channel_type_streamed_media_run_request_stream_direction</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_type_streamed_media_run_request_stream_direction
805
793
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
806
794
                                                         <link linkend="gint">gint</link> timeout_ms,
807
 
                                                         <link linkend="guint">guint</link> in_stream_id,
808
 
                                                         <link linkend="guint">guint</link> in_stream_direction,
 
795
                                                         <link linkend="guint">guint</link> in_Stream_ID,
 
796
                                                         <link linkend="guint">guint</link> in_Stream_Direction,
809
797
                                                         <link linkend="GError">GError</link> **error,
810
798
                                                         <link linkend="GMainLoop">GMainLoop</link> **loop);</programlisting>
811
799
<para>
816
804
state.
817
805
</para>
818
806
<para>
819
 
&lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;         &lt;p&gt;Request a change in the direction of an existing stream. In particular,         this might be useful to stop sending media of a particular type,         or inform the peer that you are no longer using media that is being         sent to you.&lt;/p&gt;          &lt;p&gt;Depending on the protocol, streams which are no longer sending in         either direction should be removed and a StreamRemoved signal emitted.         Some direction changes can be enforced locally (for example,         BIDIRECTIONAL -&amp;gt; RECEIVE can be achieved by merely stopping sending),         others may not be possible on some protocols, and some need agreement         from the remote end. In this case, the MEDIA_STREAM_PENDING_REMOTE_SEND         flag will be set in the StreamDirectionChanged signal, and the signal         emitted again without the flag to indicate the resulting direction when         the remote end has accepted or rejected the change.&lt;/p&gt;</para>
 
807
&lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;         &lt;p&gt;Request a change in the direction of an existing stream. In particular,         this might be useful to stop sending media of a particular type,         or inform the peer that you are no longer using media that is being         sent to you.&lt;/p&gt;          &lt;p&gt;Depending on the protocol, streams which are no longer sending in         either direction should be removed and a         &lt;tp:member-ref&gt;StreamRemoved&lt;/tp:member-ref&gt; signal emitted.         Some direction changes can be enforced locally (for example,         BIDIRECTIONAL -&amp;gt; RECEIVE can be achieved by merely stopping sending),         others may not be possible on some protocols, and some need agreement         from the remote end. In this case, the MEDIA_STREAM_PENDING_REMOTE_SEND         flag will be set in the         &lt;tp:member-ref&gt;StreamDirectionChanged&lt;/tp:member-ref&gt; signal, and the         signal         emitted again without the flag to indicate the resulting direction when         the remote end has accepted or rejected the change.&lt;/p&gt;</para>
820
808
<para>
821
 
 
822
809
</para><variablelist role="params">
823
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
810
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
824
811
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
825
812
</simpara></listitem></varlistentry>
826
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
813
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
827
814
<listitem><simpara> Timeout in milliseconds, or -1 for default
828
815
</simpara></listitem></varlistentry>
829
 
<varlistentry><term><parameter>in_stream_id</parameter>&nbsp;:</term>
830
 
<listitem><simpara> Used to pass an 'in' argument: The stream identifier (as defined in ListStreams)
 
816
<varlistentry><term><parameter>in_Stream_ID</parameter>&#160;:</term>
 
817
<listitem><simpara> Used to pass an 'in' argument: The stream identifier (as defined in           &lt;tp:member-ref&gt;ListStreams&lt;/tp:member-ref&gt;)
831
818
</simpara></listitem></varlistentry>
832
 
<varlistentry><term><parameter>in_stream_direction</parameter>&nbsp;:</term>
 
819
<varlistentry><term><parameter>in_Stream_Direction</parameter>&#160;:</term>
833
820
<listitem><simpara> Used to pass an 'in' argument: The desired stream direction (a value of MediaStreamDirection)
834
821
</simpara></listitem></varlistentry>
835
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
836
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> 
 
822
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
823
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> 
837
824
 is returned
838
825
</simpara></listitem></varlistentry>
839
 
<varlistentry><term><parameter>loop</parameter>&nbsp;:</term>
840
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, set before re-entering 
 
826
<varlistentry><term><parameter>loop</parameter>&#160;:</term>
 
827
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, set before re-entering 
841
828
 the main loop, to point to a <link linkend="GMainLoop"><type>GMainLoop</type></link> 
842
829
 which can be used to cancel this call with 
843
830
 <link linkend="g-main-loop-quit"><function>g_main_loop_quit()</function></link>, causing a return of 
844
 
 <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED:CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
 
831
 <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED--CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
845
832
</simpara></listitem></varlistentry>
846
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
 
833
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
847
834
</simpara></listitem></varlistentry>
848
835
</variablelist></refsect2>
849
836
<refsect2 id="tp-cli-channel-type-streamed-media-run-request-streams" role="function">
850
837
<title>tp_cli_channel_type_streamed_media_run_request_streams ()</title>
851
 
<indexterm zone="tp-cli-channel-type-streamed-media-run-request-streams"><primary>tp_cli_channel_type_streamed_media_run_request_streams</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_type_streamed_media_run_request_streams
 
838
<indexterm zone="tp-cli-channel-type-streamed-media-run-request-streams"><primary sortas="tp_cli_channel_type_streamed_media_run_request_streams">tp_cli_channel_type_streamed_media_run_request_streams</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_type_streamed_media_run_request_streams
852
839
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
853
840
                                                         <link linkend="gint">gint</link> timeout_ms,
854
 
                                                         <link linkend="guint">guint</link> in_contact_handle,
855
 
                                                         const <link linkend="GArray">GArray</link> *in_types,
856
 
                                                         <link linkend="GPtrArray">GPtrArray</link> **out0,
 
841
                                                         <link linkend="guint">guint</link> in_Contact_Handle,
 
842
                                                         const <link linkend="GArray">GArray</link> *in_Types,
 
843
                                                         <link linkend="GPtrArray">GPtrArray</link> **out_Streams,
857
844
                                                         <link linkend="GError">GError</link> **error,
858
845
                                                         <link linkend="GMainLoop">GMainLoop</link> **loop);</programlisting>
859
846
<para>
864
851
state.
865
852
</para>
866
853
<para>
867
 
&lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;         &lt;p&gt;Request that streams be established to exchange the given types of         media with the given member. In general this will try and establish a         bidirectional stream, but on some protocols it may not be possible to         indicate to the peer that you would like to receive media, so a         send-only stream will be created initially. In the cases where the         stream requires remote agreement (eg you wish to receive media from         them), the StreamDirectionChanged signal will be emitted with the         MEDIA_STREAM_PENDING_REMOTE_SEND flag set, and the signal emitted again         with the flag cleared when the remote end has replied.&lt;/p&gt;</para>
 
854
&lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;         &lt;p&gt;Request that streams be established to exchange the given types of         media with the given member. In general this will try and establish a         bidirectional stream, but on some protocols it may not be possible to         indicate to the peer that you would like to receive media, so a         send-only stream will be created initially. In the cases where the         stream requires remote agreement (eg you wish to receive media from         them), the &lt;tp:member-ref&gt;StreamDirectionChanged&lt;/tp:member-ref&gt; signal         will be emitted with the         MEDIA_STREAM_PENDING_REMOTE_SEND flag set, and the signal emitted again         with the flag cleared when the remote end has replied.&lt;/p&gt;          &lt;p&gt;If streams of the requested types already exist, calling this           method results in the creation of additional streams. Accordingly,           clients wishing to have exactly one audio stream or exactly one           video stream SHOULD check for the current streams using           &lt;tp:member-ref&gt;ListStreams&lt;/tp:member-ref&gt; before calling this           method.&lt;/p&gt;</para>
868
855
<para>
869
 
 
870
856
</para><variablelist role="params">
871
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
857
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
872
858
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
873
859
</simpara></listitem></varlistentry>
874
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
860
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
875
861
<listitem><simpara> Timeout in milliseconds, or -1 for default
876
862
</simpara></listitem></varlistentry>
877
 
<varlistentry><term><parameter>in_contact_handle</parameter>&nbsp;:</term>
 
863
<varlistentry><term><parameter>in_Contact_Handle</parameter>&#160;:</term>
878
864
<listitem><simpara> Used to pass an 'in' argument: A contact handle with whom to establish the streams
879
865
</simpara></listitem></varlistentry>
880
 
<varlistentry><term><parameter>in_types</parameter>&nbsp;:</term>
 
866
<varlistentry><term><parameter>in_Types</parameter>&#160;:</term>
881
867
<listitem><simpara> Used to pass an 'in' argument: An array of stream types (values of MediaStreamType)
882
868
</simpara></listitem></varlistentry>
883
 
<varlistentry><term><parameter>out0</parameter>&nbsp;:</term>
884
 
<listitem><simpara> Used to return an 'out' argument if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> is returned: &lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;           An array of structs (in the same order as the given stream types)           containing:           &lt;ul&gt;             &lt;li&gt;the stream identifier&lt;/li&gt;             &lt;li&gt;the contact handle who the stream is with (or 0 if the stream               represents more than a single member)&lt;/li&gt;             &lt;li&gt;the type of the stream&lt;/li&gt;             &lt;li&gt;the current stream state&lt;/li&gt;             &lt;li&gt;the current direction of the stream&lt;/li&gt;             &lt;li&gt;the current pending send flags&lt;/li&gt;           &lt;/ul&gt;
 
869
<varlistentry><term><parameter>out_Streams</parameter>&#160;:</term>
 
870
<listitem><simpara> Used to return an 'out' argument if <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> is returned: &lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;           An array of structs (in the same order as the given stream types)           containing:           &lt;ul&gt;             &lt;li&gt;the stream identifier&lt;/li&gt;             &lt;li&gt;the contact handle who the stream is with (or 0 if the stream               represents more than a single member)&lt;/li&gt;             &lt;li&gt;the type of the stream&lt;/li&gt;             &lt;li&gt;the current stream state&lt;/li&gt;             &lt;li&gt;the current direction of the stream&lt;/li&gt;             &lt;li&gt;the current pending send flags&lt;/li&gt;           &lt;/ul&gt;
885
871
</simpara></listitem></varlistentry>
886
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
887
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> 
 
872
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
873
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> 
888
874
 is returned
889
875
</simpara></listitem></varlistentry>
890
 
<varlistentry><term><parameter>loop</parameter>&nbsp;:</term>
891
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, set before re-entering 
 
876
<varlistentry><term><parameter>loop</parameter>&#160;:</term>
 
877
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, set before re-entering 
892
878
 the main loop, to point to a <link linkend="GMainLoop"><type>GMainLoop</type></link> 
893
879
 which can be used to cancel this call with 
894
880
 <link linkend="g-main-loop-quit"><function>g_main_loop_quit()</function></link>, causing a return of 
895
 
 <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED:CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
 
881
 <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED--CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
896
882
</simpara></listitem></varlistentry>
897
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
 
883
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
898
884
</simpara></listitem></varlistentry>
899
885
</variablelist></refsect2>
900
886
<refsect2 id="tp-cli-channel-type-streamed-media-connect-to-stream-added" role="function">
901
887
<title>tp_cli_channel_type_streamed_media_connect_to_stream_added ()</title>
902
 
<indexterm zone="tp-cli-channel-type-streamed-media-connect-to-stream-added"><primary>tp_cli_channel_type_streamed_media_connect_to_stream_added</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* tp_cli_channel_type_streamed_media_connect_to_stream_added
 
888
<indexterm zone="tp-cli-channel-type-streamed-media-connect-to-stream-added"><primary sortas="tp_cli_channel_type_streamed_media_connect_to_stream_added">tp_cli_channel_type_streamed_media_connect_to_stream_added</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * tp_cli_channel_type_streamed_media_connect_to_stream_added
903
889
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
904
890
                                                         <link linkend="tp-cli-channel-type-streamed-media-signal-callback-stream-added">tp_cli_channel_type_streamed_media_signal_callback_stream_added</link> callback,
905
891
                                                         <link linkend="gpointer">gpointer</link> user_data,
910
896
Connect a handler to the signal StreamAdded.
911
897
</para>
912
898
<para>
913
 
Emitted when a new stream has been added to this channel.</para>
 
899
&lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;         &lt;p&gt;Emitted when a new stream has been added to this channel.           Clients SHOULD assume that the stream&apos;s           &lt;tp:type&gt;Media_Stream_State&lt;/tp:type&gt; is initially Disconnected.&lt;/p&gt;          &lt;p&gt;If a connection manager needs to represent the addition of a stream           whose state is already Connecting or Connected, it MUST do this           by emitting StreamAdded, closely followed by           &lt;tp:member-ref&gt;StreamStateChanged&lt;/tp:member-ref&gt; indicating a           change to the appropriate state.&lt;/p&gt;          &lt;tp:rationale&gt;           &lt;p&gt;Historically, it was not clear from the StreamAdded signal what             the state of the stream was. telepathy-spec 0.17.22             clarified this.&lt;/p&gt;         &lt;/tp:rationale&gt;          &lt;p&gt;Similarly, clients SHOULD assume that the initial           &lt;tp:type&gt;Media_Stream_Direction&lt;/tp:type&gt; of a newly added stream           is Receive, and that the initial           &lt;tp:type&gt;Media_Stream_Pending_Send&lt;/tp:type&gt; is           Pending_Local_Send.&lt;/p&gt;          &lt;p&gt;If a connection manager needs to represent the addition of a stream           whose direction or pending-send differs from those initial values,           it MUST do so by emitting StreamAdded, closely followed by           &lt;tp:member-ref&gt;StreamDirectionChanged&lt;/tp:member-ref&gt; indicating a           change to the appropriate direction and pending-send state.&lt;/p&gt;          &lt;tp:rationale&gt;           &lt;p&gt;StreamAdded doesn&apos;t itself indicate the stream&apos;s direction; this             is unfortunate, but is preserved for compatibility.&lt;/p&gt;            &lt;p&gt;This is the appropriate direction for streams added by a remote             contact on existing connection managers, and does not violate             user privacy by automatically sending audio or video (audio streams             start off muted, video streams start off not sending). For             streams added by the local user using the client receiving the             signal, the true direction can also be determined from the return             value of the &lt;tp:member-ref&gt;RequestStreams&lt;/tp:member-ref&gt;             method.&lt;/p&gt;            &lt;p&gt;Existing clients typically operate by maintaining a separate             idea of the directions that they would like the streams to have,             and enforcing these intended directions by calling             &lt;tp:member-ref&gt;RequestStreamDirection&lt;/tp:member-ref&gt; whenever             needed.&lt;/p&gt;         &lt;/tp:rationale&gt;</para>
914
900
<para>
915
 
 
916
901
</para><variablelist role="params">
917
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
902
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
918
903
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
919
904
</simpara></listitem></varlistentry>
920
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
905
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
921
906
<listitem><simpara> Callback to be called when the signal is
922
907
  received
923
908
</simpara></listitem></varlistentry>
924
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
909
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
925
910
<listitem><simpara> User-supplied data for the callback
926
911
</simpara></listitem></varlistentry>
927
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
912
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
928
913
<listitem><simpara> Destructor for the user-supplied data, which
929
914
  will be called when this signal is disconnected, or
930
 
  before this function returns <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
915
  before this function returns <link linkend="NULL--CAPS"><literal>NULL</literal></link>
931
916
</simpara></listitem></varlistentry>
932
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
917
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
933
918
<listitem><simpara> A <link linkend="GObject"><type>GObject</type></link> which will be weakly referenced; 
934
919
  if it is destroyed, this callback will automatically be
935
920
  disconnected
936
921
</simpara></listitem></varlistentry>
937
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
938
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL:CAPS"><literal>NULL</literal></link> is
 
922
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
923
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL--CAPS"><literal>NULL</literal></link> is
939
924
  returned
940
925
</simpara></listitem></varlistentry>
941
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxySignalConnection"><type>TpProxySignalConnection</type></link> containing all of the
 
926
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxySignalConnection"><type>TpProxySignalConnection</type></link> containing all of the
942
927
above, which can be used to disconnect the signal; or
943
 
<link linkend="NULL:CAPS"><literal>NULL</literal></link> if the proxy does not have the desired interface
 
928
<link linkend="NULL--CAPS"><literal>NULL</literal></link> if the proxy does not have the desired interface
944
929
or has become invalid.
945
930
</simpara></listitem></varlistentry>
946
931
</variablelist></refsect2>
947
932
<refsect2 id="tp-cli-channel-type-streamed-media-connect-to-stream-direction-changed" role="function">
948
933
<title>tp_cli_channel_type_streamed_media_connect_to_stream_direction_changed ()</title>
949
 
<indexterm zone="tp-cli-channel-type-streamed-media-connect-to-stream-direction-changed"><primary>tp_cli_channel_type_streamed_media_connect_to_stream_direction_changed</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* tp_cli_channel_type_streamed_media_connect_to_stream_direction_changed
 
934
<indexterm zone="tp-cli-channel-type-streamed-media-connect-to-stream-direction-changed"><primary sortas="tp_cli_channel_type_streamed_media_connect_to_stream_direction_changed">tp_cli_channel_type_streamed_media_connect_to_stream_direction_changed</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * tp_cli_channel_type_streamed_media_connect_to_stream_direction_changed
950
935
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
951
936
                                                         <link linkend="tp-cli-channel-type-streamed-media-signal-callback-stream-direction-changed">tp_cli_channel_type_streamed_media_signal_callback_stream_direction_changed</link> callback,
952
937
                                                         <link linkend="gpointer">gpointer</link> user_data,
957
942
Connect a handler to the signal StreamDirectionChanged.
958
943
</para>
959
944
<para>
960
 
Emitted when the direction or pending flags of a stream are changed. If         the MEDIA_STREAM_PENDING_LOCAL_SEND flag is set, the remote user has         requested that we begin sending on this stream. RequestStreamDirection         should be called to indicate whether or not this change is acceptable.</para>
 
945
&lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;         &lt;p&gt;Emitted when the direction or pending flags of a stream are           changed.&lt;/p&gt;          &lt;p&gt;If the MEDIA_STREAM_PENDING_LOCAL_SEND flag is set, the remote user           has requested that we begin sending on this stream.           &lt;tp:member-ref&gt;RequestStreamDirection&lt;/tp:member-ref&gt;           should be called to indicate whether or not this change is           acceptable.&lt;/p&gt;          &lt;tp:rationale&gt;           &lt;p&gt;This allows for a MSN-style user interface, &amp;quot;Fred has asked you             to enable your webcam. (Accept | Reject)&amp;quot;, if desired.&lt;/p&gt;         &lt;/tp:rationale&gt;</para>
961
946
<para>
962
 
 
963
947
</para><variablelist role="params">
964
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
948
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
965
949
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
966
950
</simpara></listitem></varlistentry>
967
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
951
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
968
952
<listitem><simpara> Callback to be called when the signal is
969
953
  received
970
954
</simpara></listitem></varlistentry>
971
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
955
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
972
956
<listitem><simpara> User-supplied data for the callback
973
957
</simpara></listitem></varlistentry>
974
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
958
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
975
959
<listitem><simpara> Destructor for the user-supplied data, which
976
960
  will be called when this signal is disconnected, or
977
 
  before this function returns <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
961
  before this function returns <link linkend="NULL--CAPS"><literal>NULL</literal></link>
978
962
</simpara></listitem></varlistentry>
979
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
963
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
980
964
<listitem><simpara> A <link linkend="GObject"><type>GObject</type></link> which will be weakly referenced; 
981
965
  if it is destroyed, this callback will automatically be
982
966
  disconnected
983
967
</simpara></listitem></varlistentry>
984
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
985
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL:CAPS"><literal>NULL</literal></link> is
 
968
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
969
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL--CAPS"><literal>NULL</literal></link> is
986
970
  returned
987
971
</simpara></listitem></varlistentry>
988
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxySignalConnection"><type>TpProxySignalConnection</type></link> containing all of the
 
972
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxySignalConnection"><type>TpProxySignalConnection</type></link> containing all of the
989
973
above, which can be used to disconnect the signal; or
990
 
<link linkend="NULL:CAPS"><literal>NULL</literal></link> if the proxy does not have the desired interface
 
974
<link linkend="NULL--CAPS"><literal>NULL</literal></link> if the proxy does not have the desired interface
991
975
or has become invalid.
992
976
</simpara></listitem></varlistentry>
993
977
</variablelist></refsect2>
994
978
<refsect2 id="tp-cli-channel-type-streamed-media-connect-to-stream-error" role="function">
995
979
<title>tp_cli_channel_type_streamed_media_connect_to_stream_error ()</title>
996
 
<indexterm zone="tp-cli-channel-type-streamed-media-connect-to-stream-error"><primary>tp_cli_channel_type_streamed_media_connect_to_stream_error</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* tp_cli_channel_type_streamed_media_connect_to_stream_error
 
980
<indexterm zone="tp-cli-channel-type-streamed-media-connect-to-stream-error"><primary sortas="tp_cli_channel_type_streamed_media_connect_to_stream_error">tp_cli_channel_type_streamed_media_connect_to_stream_error</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * tp_cli_channel_type_streamed_media_connect_to_stream_error
997
981
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
998
982
                                                         <link linkend="tp-cli-channel-type-streamed-media-signal-callback-stream-error">tp_cli_channel_type_streamed_media_signal_callback_stream_error</link> callback,
999
983
                                                         <link linkend="gpointer">gpointer</link> user_data,
1006
990
<para>
1007
991
Emitted when a stream encounters an error.</para>
1008
992
<para>
1009
 
 
1010
993
</para><variablelist role="params">
1011
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
994
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1012
995
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
1013
996
</simpara></listitem></varlistentry>
1014
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
997
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
1015
998
<listitem><simpara> Callback to be called when the signal is
1016
999
  received
1017
1000
</simpara></listitem></varlistentry>
1018
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1001
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1019
1002
<listitem><simpara> User-supplied data for the callback
1020
1003
</simpara></listitem></varlistentry>
1021
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
1004
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
1022
1005
<listitem><simpara> Destructor for the user-supplied data, which
1023
1006
  will be called when this signal is disconnected, or
1024
 
  before this function returns <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1007
  before this function returns <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1025
1008
</simpara></listitem></varlistentry>
1026
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
1009
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
1027
1010
<listitem><simpara> A <link linkend="GObject"><type>GObject</type></link> which will be weakly referenced; 
1028
1011
  if it is destroyed, this callback will automatically be
1029
1012
  disconnected
1030
1013
</simpara></listitem></varlistentry>
1031
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
1032
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL:CAPS"><literal>NULL</literal></link> is
 
1014
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
1015
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL--CAPS"><literal>NULL</literal></link> is
1033
1016
  returned
1034
1017
</simpara></listitem></varlistentry>
1035
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxySignalConnection"><type>TpProxySignalConnection</type></link> containing all of the
 
1018
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxySignalConnection"><type>TpProxySignalConnection</type></link> containing all of the
1036
1019
above, which can be used to disconnect the signal; or
1037
 
<link linkend="NULL:CAPS"><literal>NULL</literal></link> if the proxy does not have the desired interface
 
1020
<link linkend="NULL--CAPS"><literal>NULL</literal></link> if the proxy does not have the desired interface
1038
1021
or has become invalid.
1039
1022
</simpara></listitem></varlistentry>
1040
1023
</variablelist></refsect2>
1041
1024
<refsect2 id="tp-cli-channel-type-streamed-media-connect-to-stream-removed" role="function">
1042
1025
<title>tp_cli_channel_type_streamed_media_connect_to_stream_removed ()</title>
1043
 
<indexterm zone="tp-cli-channel-type-streamed-media-connect-to-stream-removed"><primary>tp_cli_channel_type_streamed_media_connect_to_stream_removed</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* tp_cli_channel_type_streamed_media_connect_to_stream_removed
 
1026
<indexterm zone="tp-cli-channel-type-streamed-media-connect-to-stream-removed"><primary sortas="tp_cli_channel_type_streamed_media_connect_to_stream_removed">tp_cli_channel_type_streamed_media_connect_to_stream_removed</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * tp_cli_channel_type_streamed_media_connect_to_stream_removed
1044
1027
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1045
1028
                                                         <link linkend="tp-cli-channel-type-streamed-media-signal-callback-stream-removed">tp_cli_channel_type_streamed_media_signal_callback_stream_removed</link> callback,
1046
1029
                                                         <link linkend="gpointer">gpointer</link> user_data,
1053
1036
<para>
1054
1037
Emitted when a stream has been removed from this channel.</para>
1055
1038
<para>
1056
 
 
1057
1039
</para><variablelist role="params">
1058
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1040
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1059
1041
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
1060
1042
</simpara></listitem></varlistentry>
1061
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
1043
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
1062
1044
<listitem><simpara> Callback to be called when the signal is
1063
1045
  received
1064
1046
</simpara></listitem></varlistentry>
1065
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1047
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1066
1048
<listitem><simpara> User-supplied data for the callback
1067
1049
</simpara></listitem></varlistentry>
1068
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
1050
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
1069
1051
<listitem><simpara> Destructor for the user-supplied data, which
1070
1052
  will be called when this signal is disconnected, or
1071
 
  before this function returns <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1053
  before this function returns <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1072
1054
</simpara></listitem></varlistentry>
1073
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
1055
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
1074
1056
<listitem><simpara> A <link linkend="GObject"><type>GObject</type></link> which will be weakly referenced; 
1075
1057
  if it is destroyed, this callback will automatically be
1076
1058
  disconnected
1077
1059
</simpara></listitem></varlistentry>
1078
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
1079
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL:CAPS"><literal>NULL</literal></link> is
 
1060
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
1061
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL--CAPS"><literal>NULL</literal></link> is
1080
1062
  returned
1081
1063
</simpara></listitem></varlistentry>
1082
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxySignalConnection"><type>TpProxySignalConnection</type></link> containing all of the
 
1064
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxySignalConnection"><type>TpProxySignalConnection</type></link> containing all of the
1083
1065
above, which can be used to disconnect the signal; or
1084
 
<link linkend="NULL:CAPS"><literal>NULL</literal></link> if the proxy does not have the desired interface
 
1066
<link linkend="NULL--CAPS"><literal>NULL</literal></link> if the proxy does not have the desired interface
1085
1067
or has become invalid.
1086
1068
</simpara></listitem></varlistentry>
1087
1069
</variablelist></refsect2>
1088
1070
<refsect2 id="tp-cli-channel-type-streamed-media-connect-to-stream-state-changed" role="function">
1089
1071
<title>tp_cli_channel_type_streamed_media_connect_to_stream_state_changed ()</title>
1090
 
<indexterm zone="tp-cli-channel-type-streamed-media-connect-to-stream-state-changed"><primary>tp_cli_channel_type_streamed_media_connect_to_stream_state_changed</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* tp_cli_channel_type_streamed_media_connect_to_stream_state_changed
 
1072
<indexterm zone="tp-cli-channel-type-streamed-media-connect-to-stream-state-changed"><primary sortas="tp_cli_channel_type_streamed_media_connect_to_stream_state_changed">tp_cli_channel_type_streamed_media_connect_to_stream_state_changed</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * tp_cli_channel_type_streamed_media_connect_to_stream_state_changed
1091
1073
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1092
1074
                                                         <link linkend="tp-cli-channel-type-streamed-media-signal-callback-stream-state-changed">tp_cli_channel_type_streamed_media_signal_callback_stream_state_changed</link> callback,
1093
1075
                                                         <link linkend="gpointer">gpointer</link> user_data,
1100
1082
<para>
1101
1083
Emitted when a member&apos;s stream&apos;s state changes.</para>
1102
1084
<para>
1103
 
 
1104
1085
</para><variablelist role="params">
1105
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1086
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1106
1087
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
1107
1088
</simpara></listitem></varlistentry>
1108
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
1089
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
1109
1090
<listitem><simpara> Callback to be called when the signal is
1110
1091
  received
1111
1092
</simpara></listitem></varlistentry>
1112
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1093
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1113
1094
<listitem><simpara> User-supplied data for the callback
1114
1095
</simpara></listitem></varlistentry>
1115
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
1096
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
1116
1097
<listitem><simpara> Destructor for the user-supplied data, which
1117
1098
  will be called when this signal is disconnected, or
1118
 
  before this function returns <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1099
  before this function returns <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1119
1100
</simpara></listitem></varlistentry>
1120
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
1101
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
1121
1102
<listitem><simpara> A <link linkend="GObject"><type>GObject</type></link> which will be weakly referenced; 
1122
1103
  if it is destroyed, this callback will automatically be
1123
1104
  disconnected
1124
1105
</simpara></listitem></varlistentry>
1125
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
1126
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL:CAPS"><literal>NULL</literal></link> is
 
1106
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
1107
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL--CAPS"><literal>NULL</literal></link> is
1127
1108
  returned
1128
1109
</simpara></listitem></varlistentry>
1129
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxySignalConnection"><type>TpProxySignalConnection</type></link> containing all of the
 
1110
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxySignalConnection"><type>TpProxySignalConnection</type></link> containing all of the
1130
1111
above, which can be used to disconnect the signal; or
1131
 
<link linkend="NULL:CAPS"><literal>NULL</literal></link> if the proxy does not have the desired interface
 
1112
<link linkend="NULL--CAPS"><literal>NULL</literal></link> if the proxy does not have the desired interface
1132
1113
or has become invalid.
1133
1114
</simpara></listitem></varlistentry>
1134
1115
</variablelist></refsect2>
1135
1116
<refsect2 id="tp-cli-channel-type-streamed-media-signal-callback-stream-added" role="function">
1136
1117
<title>tp_cli_channel_type_streamed_media_signal_callback_stream_added ()</title>
1137
 
<indexterm zone="tp-cli-channel-type-streamed-media-signal-callback-stream-added"><primary>tp_cli_channel_type_streamed_media_signal_callback_stream_added</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_signal_callback_stream_added)
 
1118
<indexterm zone="tp-cli-channel-type-streamed-media-signal-callback-stream-added"><primary sortas="tp_cli_channel_type_streamed_media_signal_callback_stream_added">tp_cli_channel_type_streamed_media_signal_callback_stream_added</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_signal_callback_stream_added)
1138
1119
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1139
 
                                                         <link linkend="guint">guint</link> arg_stream_id,
1140
 
                                                         <link linkend="guint">guint</link> arg_contact_handle,
1141
 
                                                         <link linkend="guint">guint</link> arg_stream_type,
 
1120
                                                         <link linkend="guint">guint</link> arg_Stream_ID,
 
1121
                                                         <link linkend="guint">guint</link> arg_Contact_Handle,
 
1122
                                                         <link linkend="guint">guint</link> arg_Stream_Type,
1142
1123
                                                         <link linkend="gpointer">gpointer</link> user_data,
1143
1124
                                                         <link linkend="GObject">GObject</link> *weak_object);</programlisting>
1144
1125
<para>
1145
1126
Represents the signature of a callback for the signal StreamAdded.</para>
1146
1127
<para>
1147
 
 
1148
1128
</para><variablelist role="params">
1149
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1129
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1150
1130
<listitem><simpara> The proxy on which <link linkend="tp-cli-channel-type-streamed-media-connect-to-stream-added"><function>tp_cli_channel_type_streamed_media_connect_to_stream_added()</function></link>
1151
1131
 was called
1152
1132
</simpara></listitem></varlistentry>
1153
 
<varlistentry><term><parameter>arg_stream_id</parameter>&nbsp;:</term>
1154
 
<listitem><simpara> The stream identifier (as defined in ListStreams)
 
1133
<varlistentry><term><parameter>arg_Stream_ID</parameter>&#160;:</term>
 
1134
<listitem><simpara> The stream identifier (as defined in           &lt;tp:member-ref&gt;ListStreams&lt;/tp:member-ref&gt;)
1155
1135
</simpara></listitem></varlistentry>
1156
 
<varlistentry><term><parameter>arg_contact_handle</parameter>&nbsp;:</term>
 
1136
<varlistentry><term><parameter>arg_Contact_Handle</parameter>&#160;:</term>
1157
1137
<listitem><simpara> The contact handle who the stream is with (or 0 if it           represents more than a single member)
1158
1138
</simpara></listitem></varlistentry>
1159
 
<varlistentry><term><parameter>arg_stream_type</parameter>&nbsp;:</term>
 
1139
<varlistentry><term><parameter>arg_Stream_Type</parameter>&#160;:</term>
1160
1140
<listitem><simpara> The stream type (a value from MediaStreamType)
1161
1141
</simpara></listitem></varlistentry>
1162
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1142
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1163
1143
<listitem><simpara> User-supplied data
1164
1144
</simpara></listitem></varlistentry>
1165
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
1145
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
1166
1146
<listitem><simpara> User-supplied weakly referenced object
1167
1147
</simpara></listitem></varlistentry>
1168
1148
</variablelist></refsect2>
1169
1149
<refsect2 id="tp-cli-channel-type-streamed-media-signal-callback-stream-direction-changed" role="function">
1170
1150
<title>tp_cli_channel_type_streamed_media_signal_callback_stream_direction_changed ()</title>
1171
 
<indexterm zone="tp-cli-channel-type-streamed-media-signal-callback-stream-direction-changed"><primary>tp_cli_channel_type_streamed_media_signal_callback_stream_direction_changed</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_signal_callback_stream_direction_changed)
 
1151
<indexterm zone="tp-cli-channel-type-streamed-media-signal-callback-stream-direction-changed"><primary sortas="tp_cli_channel_type_streamed_media_signal_callback_stream_direction_changed">tp_cli_channel_type_streamed_media_signal_callback_stream_direction_changed</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_signal_callback_stream_direction_changed)
1172
1152
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1173
 
                                                         <link linkend="guint">guint</link> arg_stream_id,
1174
 
                                                         <link linkend="guint">guint</link> arg_stream_direction,
1175
 
                                                         <link linkend="guint">guint</link> arg_pending_flags,
 
1153
                                                         <link linkend="guint">guint</link> arg_Stream_ID,
 
1154
                                                         <link linkend="guint">guint</link> arg_Stream_Direction,
 
1155
                                                         <link linkend="guint">guint</link> arg_Pending_Flags,
1176
1156
                                                         <link linkend="gpointer">gpointer</link> user_data,
1177
1157
                                                         <link linkend="GObject">GObject</link> *weak_object);</programlisting>
1178
1158
<para>
1179
1159
Represents the signature of a callback for the signal StreamDirectionChanged.</para>
1180
1160
<para>
1181
 
 
1182
1161
</para><variablelist role="params">
1183
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1162
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1184
1163
<listitem><simpara> The proxy on which <link linkend="tp-cli-channel-type-streamed-media-connect-to-stream-direction-changed"><function>tp_cli_channel_type_streamed_media_connect_to_stream_direction_changed()</function></link>
1185
1164
 was called
1186
1165
</simpara></listitem></varlistentry>
1187
 
<varlistentry><term><parameter>arg_stream_id</parameter>&nbsp;:</term>
1188
 
<listitem><simpara> The stream identifier (as defined in ListStreams)
 
1166
<varlistentry><term><parameter>arg_Stream_ID</parameter>&#160;:</term>
 
1167
<listitem><simpara> The stream identifier (as defined in &lt;tp:member-ref&gt;ListStreams&lt;/tp:member-ref&gt;)
1189
1168
</simpara></listitem></varlistentry>
1190
 
<varlistentry><term><parameter>arg_stream_direction</parameter>&nbsp;:</term>
 
1169
<varlistentry><term><parameter>arg_Stream_Direction</parameter>&#160;:</term>
1191
1170
<listitem><simpara> The new stream direction (as defined in ListStreams)
1192
1171
</simpara></listitem></varlistentry>
1193
 
<varlistentry><term><parameter>arg_pending_flags</parameter>&nbsp;:</term>
 
1172
<varlistentry><term><parameter>arg_Pending_Flags</parameter>&#160;:</term>
1194
1173
<listitem><simpara> The new pending send flags (as defined in ListStreams)
1195
1174
</simpara></listitem></varlistentry>
1196
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1175
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1197
1176
<listitem><simpara> User-supplied data
1198
1177
</simpara></listitem></varlistentry>
1199
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
1178
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
1200
1179
<listitem><simpara> User-supplied weakly referenced object
1201
1180
</simpara></listitem></varlistentry>
1202
1181
</variablelist></refsect2>
1203
1182
<refsect2 id="tp-cli-channel-type-streamed-media-signal-callback-stream-error" role="function">
1204
1183
<title>tp_cli_channel_type_streamed_media_signal_callback_stream_error ()</title>
1205
 
<indexterm zone="tp-cli-channel-type-streamed-media-signal-callback-stream-error"><primary>tp_cli_channel_type_streamed_media_signal_callback_stream_error</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_signal_callback_stream_error)
 
1184
<indexterm zone="tp-cli-channel-type-streamed-media-signal-callback-stream-error"><primary sortas="tp_cli_channel_type_streamed_media_signal_callback_stream_error">tp_cli_channel_type_streamed_media_signal_callback_stream_error</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_signal_callback_stream_error)
1206
1185
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1207
 
                                                         <link linkend="guint">guint</link> arg_stream_id,
1208
 
                                                         <link linkend="guint">guint</link> arg_errno,
1209
 
                                                         const <link linkend="gchar">gchar</link> *arg_message,
 
1186
                                                         <link linkend="guint">guint</link> arg_Stream_ID,
 
1187
                                                         <link linkend="guint">guint</link> arg_Error_Code,
 
1188
                                                         const <link linkend="gchar">gchar</link> *arg_Message,
1210
1189
                                                         <link linkend="gpointer">gpointer</link> user_data,
1211
1190
                                                         <link linkend="GObject">GObject</link> *weak_object);</programlisting>
1212
1191
<para>
1213
1192
Represents the signature of a callback for the signal StreamError.</para>
1214
1193
<para>
1215
 
 
1216
1194
</para><variablelist role="params">
1217
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1195
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1218
1196
<listitem><simpara> The proxy on which <link linkend="tp-cli-channel-type-streamed-media-connect-to-stream-error"><function>tp_cli_channel_type_streamed_media_connect_to_stream_error()</function></link>
1219
1197
 was called
1220
1198
</simpara></listitem></varlistentry>
1221
 
<varlistentry><term><parameter>arg_stream_id</parameter>&nbsp;:</term>
1222
 
<listitem><simpara> The stream identifier (as defined in ListStreams)
 
1199
<varlistentry><term><parameter>arg_Stream_ID</parameter>&#160;:</term>
 
1200
<listitem><simpara> The stream identifier (as defined in         &lt;tp:member-ref&gt;ListStreams&lt;/tp:member-ref&gt;)
1223
1201
</simpara></listitem></varlistentry>
1224
 
<varlistentry><term><parameter>arg_errno</parameter>&nbsp;:</term>
 
1202
<varlistentry><term><parameter>arg_Error_Code</parameter>&#160;:</term>
1225
1203
<listitem><simpara> A stream error number, one of the values of MediaStreamError
1226
1204
</simpara></listitem></varlistentry>
1227
 
<varlistentry><term><parameter>arg_message</parameter>&nbsp;:</term>
 
1205
<varlistentry><term><parameter>arg_Message</parameter>&#160;:</term>
1228
1206
<listitem><simpara> A string describing the error (for debugging purposes only)
1229
1207
</simpara></listitem></varlistentry>
1230
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1208
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1231
1209
<listitem><simpara> User-supplied data
1232
1210
</simpara></listitem></varlistentry>
1233
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
1211
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
1234
1212
<listitem><simpara> User-supplied weakly referenced object
1235
1213
</simpara></listitem></varlistentry>
1236
1214
</variablelist></refsect2>
1237
1215
<refsect2 id="tp-cli-channel-type-streamed-media-signal-callback-stream-removed" role="function">
1238
1216
<title>tp_cli_channel_type_streamed_media_signal_callback_stream_removed ()</title>
1239
 
<indexterm zone="tp-cli-channel-type-streamed-media-signal-callback-stream-removed"><primary>tp_cli_channel_type_streamed_media_signal_callback_stream_removed</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_signal_callback_stream_removed)
 
1217
<indexterm zone="tp-cli-channel-type-streamed-media-signal-callback-stream-removed"><primary sortas="tp_cli_channel_type_streamed_media_signal_callback_stream_removed">tp_cli_channel_type_streamed_media_signal_callback_stream_removed</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_signal_callback_stream_removed)
1240
1218
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1241
 
                                                         <link linkend="guint">guint</link> arg_stream_id,
 
1219
                                                         <link linkend="guint">guint</link> arg_Stream_ID,
1242
1220
                                                         <link linkend="gpointer">gpointer</link> user_data,
1243
1221
                                                         <link linkend="GObject">GObject</link> *weak_object);</programlisting>
1244
1222
<para>
1245
1223
Represents the signature of a callback for the signal StreamRemoved.</para>
1246
1224
<para>
1247
 
 
1248
1225
</para><variablelist role="params">
1249
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1226
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1250
1227
<listitem><simpara> The proxy on which <link linkend="tp-cli-channel-type-streamed-media-connect-to-stream-removed"><function>tp_cli_channel_type_streamed_media_connect_to_stream_removed()</function></link>
1251
1228
 was called
1252
1229
</simpara></listitem></varlistentry>
1253
 
<varlistentry><term><parameter>arg_stream_id</parameter>&nbsp;:</term>
1254
 
<listitem><simpara> stream_id - the stream identifier (as defined in ListStreams)
 
1230
<varlistentry><term><parameter>arg_Stream_ID</parameter>&#160;:</term>
 
1231
<listitem><simpara> stream_id - the stream identifier (as defined in         &lt;tp:member-ref&gt;ListStreams&lt;/tp:member-ref&gt;)
1255
1232
</simpara></listitem></varlistentry>
1256
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1233
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1257
1234
<listitem><simpara> User-supplied data
1258
1235
</simpara></listitem></varlistentry>
1259
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
1236
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
1260
1237
<listitem><simpara> User-supplied weakly referenced object
1261
1238
</simpara></listitem></varlistentry>
1262
1239
</variablelist></refsect2>
1263
1240
<refsect2 id="tp-cli-channel-type-streamed-media-signal-callback-stream-state-changed" role="function">
1264
1241
<title>tp_cli_channel_type_streamed_media_signal_callback_stream_state_changed ()</title>
1265
 
<indexterm zone="tp-cli-channel-type-streamed-media-signal-callback-stream-state-changed"><primary>tp_cli_channel_type_streamed_media_signal_callback_stream_state_changed</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_signal_callback_stream_state_changed)
 
1242
<indexterm zone="tp-cli-channel-type-streamed-media-signal-callback-stream-state-changed"><primary sortas="tp_cli_channel_type_streamed_media_signal_callback_stream_state_changed">tp_cli_channel_type_streamed_media_signal_callback_stream_state_changed</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_type_streamed_media_signal_callback_stream_state_changed)
1266
1243
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1267
 
                                                         <link linkend="guint">guint</link> arg_stream_id,
1268
 
                                                         <link linkend="guint">guint</link> arg_stream_state,
 
1244
                                                         <link linkend="guint">guint</link> arg_Stream_ID,
 
1245
                                                         <link linkend="guint">guint</link> arg_Stream_State,
1269
1246
                                                         <link linkend="gpointer">gpointer</link> user_data,
1270
1247
                                                         <link linkend="GObject">GObject</link> *weak_object);</programlisting>
1271
1248
<para>
1272
1249
Represents the signature of a callback for the signal StreamStateChanged.</para>
1273
1250
<para>
1274
 
 
1275
1251
</para><variablelist role="params">
1276
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1252
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1277
1253
<listitem><simpara> The proxy on which <link linkend="tp-cli-channel-type-streamed-media-connect-to-stream-state-changed"><function>tp_cli_channel_type_streamed_media_connect_to_stream_state_changed()</function></link>
1278
1254
 was called
1279
1255
</simpara></listitem></varlistentry>
1280
 
<varlistentry><term><parameter>arg_stream_id</parameter>&nbsp;:</term>
1281
 
<listitem><simpara> The stream identifier (as defined in ListStreams)
 
1256
<varlistentry><term><parameter>arg_Stream_ID</parameter>&#160;:</term>
 
1257
<listitem><simpara> The stream identifier (as defined in           &lt;tp:member-ref&gt;ListStreams&lt;/tp:member-ref&gt;)
1282
1258
</simpara></listitem></varlistentry>
1283
 
<varlistentry><term><parameter>arg_stream_state</parameter>&nbsp;:</term>
 
1259
<varlistentry><term><parameter>arg_Stream_State</parameter>&#160;:</term>
1284
1260
<listitem><simpara> The new stream state (as defined in ListStreams)
1285
1261
</simpara></listitem></varlistentry>
1286
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1262
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1287
1263
<listitem><simpara> User-supplied data
1288
1264
</simpara></listitem></varlistentry>
1289
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
1265
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
1290
1266
<listitem><simpara> User-supplied weakly referenced object
1291
1267
</simpara></listitem></varlistentry>
1292
1268
</variablelist></refsect2>
1293
1269
<refsect2 id="tp-cli-channel-interface-call-state-call-get-call-states" role="function">
1294
1270
<title>tp_cli_channel_interface_call_state_call_get_call_states ()</title>
1295
 
<indexterm zone="tp-cli-channel-interface-call-state-call-get-call-states"><primary>tp_cli_channel_interface_call_state_call_get_call_states</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* tp_cli_channel_interface_call_state_call_get_call_states
 
1271
<indexterm zone="tp-cli-channel-interface-call-state-call-get-call-states"><primary sortas="tp_cli_channel_interface_call_state_call_get_call_states">tp_cli_channel_interface_call_state_call_get_call_states</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * tp_cli_channel_interface_call_state_call_get_call_states
1296
1272
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1297
1273
                                                         <link linkend="gint">gint</link> timeout_ms,
1298
1274
                                                         <link linkend="tp-cli-channel-interface-call-state-callback-for-get-call-states">tp_cli_channel_interface_call_state_callback_for_get_call_states</link> callback,
1305
1281
<para>
1306
1282
Get the current call states for all contacts involved in this call.</para>
1307
1283
<para>
1308
 
 
1309
1284
</para><variablelist role="params">
1310
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1285
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1311
1286
<listitem><simpara> the <link linkend="TpProxy"><type>TpProxy</type></link>
1312
1287
</simpara></listitem></varlistentry>
1313
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
1288
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
1314
1289
<listitem><simpara> the timeout in milliseconds, or -1 to use the
1315
1290
  default
1316
1291
</simpara></listitem></varlistentry>
1317
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
1292
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
1318
1293
<listitem><simpara> called when the method call succeeds or fails;
1319
 
  may be <link linkend="NULL:CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
 
1294
  may be <link linkend="NULL--CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
1320
1295
  reply tracking
1321
1296
</simpara></listitem></varlistentry>
1322
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1297
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1323
1298
<listitem><simpara> user-supplied data passed to the callback;
1324
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1299
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1325
1300
</simpara></listitem></varlistentry>
1326
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
1301
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
1327
1302
<listitem><simpara> called with the user_data as argument, after the
1328
1303
  call has succeeded, failed or been cancelled;
1329
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1304
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1330
1305
</simpara></listitem></varlistentry>
1331
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
1332
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
 
1306
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
 
1307
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
1333
1308
  weakly referenced; if it is destroyed, this call 
1334
 
  will automatically be cancelled. Must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if 
1335
 
  <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1309
  will automatically be cancelled. Must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if 
 
1310
  <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1336
1311
</simpara></listitem></varlistentry>
1337
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
 
1312
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
1338
1313
 progress. It is borrowed from the object, and will become
1339
1314
 invalid when the callback is called, the call is
1340
1315
 cancelled or the <link linkend="TpProxy"><type>TpProxy</type></link> becomes invalid.
1342
1317
</variablelist></refsect2>
1343
1318
<refsect2 id="tp-cli-channel-interface-call-state-callback-for-get-call-states" role="function">
1344
1319
<title>tp_cli_channel_interface_call_state_callback_for_get_call_states ()</title>
1345
 
<indexterm zone="tp-cli-channel-interface-call-state-callback-for-get-call-states"><primary>tp_cli_channel_interface_call_state_callback_for_get_call_states</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_call_state_callback_for_get_call_states)
 
1320
<indexterm zone="tp-cli-channel-interface-call-state-callback-for-get-call-states"><primary sortas="tp_cli_channel_interface_call_state_callback_for_get_call_states">tp_cli_channel_interface_call_state_callback_for_get_call_states</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_call_state_callback_for_get_call_states)
1346
1321
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1347
1322
                                                         <link linkend="GHashTable">GHashTable</link> *out_States,
1348
1323
                                                         const <link linkend="GError">GError</link> *error,
1352
1327
Signature of the callback called when a GetCallStates method call
1353
1328
succeeds or fails.</para>
1354
1329
<para>
1355
 
 
1356
1330
</para><variablelist role="params">
1357
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1331
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1358
1332
<listitem><simpara> the proxy on which the call was made
1359
1333
</simpara></listitem></varlistentry>
1360
 
<varlistentry><term><parameter>out_States</parameter>&nbsp;:</term>
1361
 
<listitem><simpara> Used to return an 'out' argument if <parameter>error</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>: The current call states. Participants where the call state flags           would be 0 (all unset) may be omitted from this mapping.
1362
 
</simpara></listitem></varlistentry>
1363
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
1364
 
<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link> on success, or an error on failure
1365
 
</simpara></listitem></varlistentry>
1366
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1334
<varlistentry><term><parameter>out_States</parameter>&#160;:</term>
 
1335
<listitem><simpara> Used to return an 'out' argument if <parameter>error</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>: The current call states. Participants where the call state flags           would be 0 (all unset) may be omitted from this mapping.
 
1336
</simpara></listitem></varlistentry>
 
1337
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
1338
<listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link> on success, or an error on failure
 
1339
</simpara></listitem></varlistentry>
 
1340
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1367
1341
<listitem><simpara> user-supplied data
1368
1342
</simpara></listitem></varlistentry>
1369
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
1343
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
1370
1344
<listitem><simpara> user-supplied object
1371
1345
</simpara></listitem></varlistentry>
1372
1346
</variablelist></refsect2>
1373
1347
<refsect2 id="tp-cli-channel-interface-call-state-connect-to-call-state-changed" role="function">
1374
1348
<title>tp_cli_channel_interface_call_state_connect_to_call_state_changed ()</title>
1375
 
<indexterm zone="tp-cli-channel-interface-call-state-connect-to-call-state-changed"><primary>tp_cli_channel_interface_call_state_connect_to_call_state_changed</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* tp_cli_channel_interface_call_state_connect_to_call_state_changed
 
1349
<indexterm zone="tp-cli-channel-interface-call-state-connect-to-call-state-changed"><primary sortas="tp_cli_channel_interface_call_state_connect_to_call_state_changed">tp_cli_channel_interface_call_state_connect_to_call_state_changed</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * tp_cli_channel_interface_call_state_connect_to_call_state_changed
1376
1350
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1377
1351
                                                         <link linkend="tp-cli-channel-interface-call-state-signal-callback-call-state-changed">tp_cli_channel_interface_call_state_signal_callback_call_state_changed</link> callback,
1378
1352
                                                         <link linkend="gpointer">gpointer</link> user_data,
1385
1359
<para>
1386
1360
Emitted when the state of a member of the channel has changed.</para>
1387
1361
<para>
1388
 
 
1389
1362
</para><variablelist role="params">
1390
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1363
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1391
1364
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
1392
1365
</simpara></listitem></varlistentry>
1393
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
1366
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
1394
1367
<listitem><simpara> Callback to be called when the signal is
1395
1368
  received
1396
1369
</simpara></listitem></varlistentry>
1397
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1370
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1398
1371
<listitem><simpara> User-supplied data for the callback
1399
1372
</simpara></listitem></varlistentry>
1400
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
1373
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
1401
1374
<listitem><simpara> Destructor for the user-supplied data, which
1402
1375
  will be called when this signal is disconnected, or
1403
 
  before this function returns <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1376
  before this function returns <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1404
1377
</simpara></listitem></varlistentry>
1405
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
1378
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
1406
1379
<listitem><simpara> A <link linkend="GObject"><type>GObject</type></link> which will be weakly referenced; 
1407
1380
  if it is destroyed, this callback will automatically be
1408
1381
  disconnected
1409
1382
</simpara></listitem></varlistentry>
1410
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
1411
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL:CAPS"><literal>NULL</literal></link> is
 
1383
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
1384
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL--CAPS"><literal>NULL</literal></link> is
1412
1385
  returned
1413
1386
</simpara></listitem></varlistentry>
1414
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxySignalConnection"><type>TpProxySignalConnection</type></link> containing all of the
 
1387
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxySignalConnection"><type>TpProxySignalConnection</type></link> containing all of the
1415
1388
above, which can be used to disconnect the signal; or
1416
 
<link linkend="NULL:CAPS"><literal>NULL</literal></link> if the proxy does not have the desired interface
 
1389
<link linkend="NULL--CAPS"><literal>NULL</literal></link> if the proxy does not have the desired interface
1417
1390
or has become invalid.
1418
1391
</simpara></listitem></varlistentry>
1419
1392
</variablelist></refsect2>
1420
1393
<refsect2 id="tp-cli-channel-interface-call-state-run-get-call-states" role="function">
1421
1394
<title>tp_cli_channel_interface_call_state_run_get_call_states ()</title>
1422
 
<indexterm zone="tp-cli-channel-interface-call-state-run-get-call-states"><primary>tp_cli_channel_interface_call_state_run_get_call_states</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_interface_call_state_run_get_call_states
 
1395
<indexterm zone="tp-cli-channel-interface-call-state-run-get-call-states"><primary sortas="tp_cli_channel_interface_call_state_run_get_call_states">tp_cli_channel_interface_call_state_run_get_call_states</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_interface_call_state_run_get_call_states
1423
1396
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1424
1397
                                                         <link linkend="gint">gint</link> timeout_ms,
1425
1398
                                                         <link linkend="GHashTable">GHashTable</link> **out_States,
1435
1408
<para>
1436
1409
Get the current call states for all contacts involved in this call.</para>
1437
1410
<para>
1438
 
 
1439
1411
</para><variablelist role="params">
1440
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1412
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1441
1413
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
1442
1414
</simpara></listitem></varlistentry>
1443
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
1415
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
1444
1416
<listitem><simpara> Timeout in milliseconds, or -1 for default
1445
1417
</simpara></listitem></varlistentry>
1446
 
<varlistentry><term><parameter>out_States</parameter>&nbsp;:</term>
1447
 
<listitem><simpara> Used to return an 'out' argument if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> is returned: The current call states. Participants where the call state flags           would be 0 (all unset) may be omitted from this mapping.
 
1418
<varlistentry><term><parameter>out_States</parameter>&#160;:</term>
 
1419
<listitem><simpara> Used to return an 'out' argument if <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> is returned: The current call states. Participants where the call state flags           would be 0 (all unset) may be omitted from this mapping.
1448
1420
</simpara></listitem></varlistentry>
1449
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
1450
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> 
 
1421
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
1422
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> 
1451
1423
 is returned
1452
1424
</simpara></listitem></varlistentry>
1453
 
<varlistentry><term><parameter>loop</parameter>&nbsp;:</term>
1454
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, set before re-entering 
 
1425
<varlistentry><term><parameter>loop</parameter>&#160;:</term>
 
1426
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, set before re-entering 
1455
1427
 the main loop, to point to a <link linkend="GMainLoop"><type>GMainLoop</type></link> 
1456
1428
 which can be used to cancel this call with 
1457
1429
 <link linkend="g-main-loop-quit"><function>g_main_loop_quit()</function></link>, causing a return of 
1458
 
 <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED:CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
 
1430
 <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED--CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
1459
1431
</simpara></listitem></varlistentry>
1460
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
 
1432
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
1461
1433
</simpara></listitem></varlistentry>
1462
1434
</variablelist></refsect2>
1463
1435
<refsect2 id="tp-cli-channel-interface-call-state-signal-callback-call-state-changed" role="function">
1464
1436
<title>tp_cli_channel_interface_call_state_signal_callback_call_state_changed ()</title>
1465
 
<indexterm zone="tp-cli-channel-interface-call-state-signal-callback-call-state-changed"><primary>tp_cli_channel_interface_call_state_signal_callback_call_state_changed</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_call_state_signal_callback_call_state_changed)
 
1437
<indexterm zone="tp-cli-channel-interface-call-state-signal-callback-call-state-changed"><primary sortas="tp_cli_channel_interface_call_state_signal_callback_call_state_changed">tp_cli_channel_interface_call_state_signal_callback_call_state_changed</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_call_state_signal_callback_call_state_changed)
1466
1438
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1467
 
                                                         <link linkend="guint">guint</link> arg_contact,
1468
 
                                                         <link linkend="guint">guint</link> arg_state,
 
1439
                                                         <link linkend="guint">guint</link> arg_Contact,
 
1440
                                                         <link linkend="guint">guint</link> arg_State,
1469
1441
                                                         <link linkend="gpointer">gpointer</link> user_data,
1470
1442
                                                         <link linkend="GObject">GObject</link> *weak_object);</programlisting>
1471
1443
<para>
1472
1444
Represents the signature of a callback for the signal CallStateChanged.</para>
1473
1445
<para>
1474
 
 
1475
1446
</para><variablelist role="params">
1476
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1447
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1477
1448
<listitem><simpara> The proxy on which <link linkend="tp-cli-channel-interface-call-state-connect-to-call-state-changed"><function>tp_cli_channel_interface_call_state_connect_to_call_state_changed()</function></link>
1478
1449
 was called
1479
1450
</simpara></listitem></varlistentry>
1480
 
<varlistentry><term><parameter>arg_contact</parameter>&nbsp;:</term>
 
1451
<varlistentry><term><parameter>arg_Contact</parameter>&#160;:</term>
1481
1452
<listitem><simpara> An integer handle for the contact.
1482
1453
</simpara></listitem></varlistentry>
1483
 
<varlistentry><term><parameter>arg_state</parameter>&nbsp;:</term>
 
1454
<varlistentry><term><parameter>arg_State</parameter>&#160;:</term>
1484
1455
<listitem><simpara> The new state for this contact.
1485
1456
</simpara></listitem></varlistentry>
1486
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1457
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1487
1458
<listitem><simpara> User-supplied data
1488
1459
</simpara></listitem></varlistentry>
1489
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
1460
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
1490
1461
<listitem><simpara> User-supplied weakly referenced object
1491
1462
</simpara></listitem></varlistentry>
1492
1463
</variablelist></refsect2>
1493
1464
<refsect2 id="tp-cli-channel-interface-dtmf-run-start-tone" role="function">
1494
1465
<title>tp_cli_channel_interface_dtmf_run_start_tone ()</title>
1495
 
<indexterm zone="tp-cli-channel-interface-dtmf-run-start-tone"><primary>tp_cli_channel_interface_dtmf_run_start_tone</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_interface_dtmf_run_start_tone
 
1466
<indexterm zone="tp-cli-channel-interface-dtmf-run-start-tone"><primary sortas="tp_cli_channel_interface_dtmf_run_start_tone">tp_cli_channel_interface_dtmf_run_start_tone</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_interface_dtmf_run_start_tone
1496
1467
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1497
1468
                                                         <link linkend="gint">gint</link> timeout_ms,
1498
 
                                                         <link linkend="guint">guint</link> in_stream_id,
1499
 
                                                         <link linkend="guchar">guchar</link> in_event,
 
1469
                                                         <link linkend="guint">guint</link> in_Stream_ID,
 
1470
                                                         <link linkend="guchar">guchar</link> in_Event,
1500
1471
                                                         <link linkend="GError">GError</link> **error,
1501
1472
                                                         <link linkend="GMainLoop">GMainLoop</link> **loop);</programlisting>
1502
1473
<para>
1507
1478
state.
1508
1479
</para>
1509
1480
<para>
1510
 
Start sending a DTMF tone on this stream. Where possible, the tone         will continue until StopTone is called. On certain protocols, it may         only be possible to send events with a predetermined length. In this         case, the implementation may emit a fixed-length tone, and the StopTone         method call should return NotAvailable.</para>
 
1481
Start sending a DTMF tone on this stream. Where possible, the tone         will continue until &lt;tp:member-ref&gt;StopTone&lt;/tp:member-ref&gt; is called.         On certain protocols, it may         only be possible to send events with a predetermined length. In this         case, the implementation may emit a fixed-length tone, and the StopTone         method call should return NotAvailable.</para>
1511
1482
<para>
1512
 
 
1513
1483
</para><variablelist role="params">
1514
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1484
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1515
1485
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
1516
1486
</simpara></listitem></varlistentry>
1517
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
1487
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
1518
1488
<listitem><simpara> Timeout in milliseconds, or -1 for default
1519
1489
</simpara></listitem></varlistentry>
1520
 
<varlistentry><term><parameter>in_stream_id</parameter>&nbsp;:</term>
 
1490
<varlistentry><term><parameter>in_Stream_ID</parameter>&#160;:</term>
1521
1491
<listitem><simpara> Used to pass an 'in' argument: A stream ID as defined in the StreamedMedia channel type.
1522
1492
</simpara></listitem></varlistentry>
1523
 
<varlistentry><term><parameter>in_event</parameter>&nbsp;:</term>
 
1493
<varlistentry><term><parameter>in_Event</parameter>&#160;:</term>
1524
1494
<listitem><simpara> Used to pass an 'in' argument: A numeric event code from the DTMF_Event enum.
1525
1495
</simpara></listitem></varlistentry>
1526
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
1527
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> 
 
1496
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
1497
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> 
1528
1498
 is returned
1529
1499
</simpara></listitem></varlistentry>
1530
 
<varlistentry><term><parameter>loop</parameter>&nbsp;:</term>
1531
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, set before re-entering 
 
1500
<varlistentry><term><parameter>loop</parameter>&#160;:</term>
 
1501
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, set before re-entering 
1532
1502
 the main loop, to point to a <link linkend="GMainLoop"><type>GMainLoop</type></link> 
1533
1503
 which can be used to cancel this call with 
1534
1504
 <link linkend="g-main-loop-quit"><function>g_main_loop_quit()</function></link>, causing a return of 
1535
 
 <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED:CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
 
1505
 <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED--CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
1536
1506
</simpara></listitem></varlistentry>
1537
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
 
1507
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
1538
1508
</simpara></listitem></varlistentry>
1539
1509
</variablelist></refsect2>
1540
1510
<refsect2 id="tp-cli-channel-interface-dtmf-run-stop-tone" role="function">
1541
1511
<title>tp_cli_channel_interface_dtmf_run_stop_tone ()</title>
1542
 
<indexterm zone="tp-cli-channel-interface-dtmf-run-stop-tone"><primary>tp_cli_channel_interface_dtmf_run_stop_tone</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_interface_dtmf_run_stop_tone
 
1512
<indexterm zone="tp-cli-channel-interface-dtmf-run-stop-tone"><primary sortas="tp_cli_channel_interface_dtmf_run_stop_tone">tp_cli_channel_interface_dtmf_run_stop_tone</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_interface_dtmf_run_stop_tone
1543
1513
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1544
1514
                                                         <link linkend="gint">gint</link> timeout_ms,
1545
 
                                                         <link linkend="guint">guint</link> in_stream_id,
 
1515
                                                         <link linkend="guint">guint</link> in_Stream_ID,
1546
1516
                                                         <link linkend="GError">GError</link> **error,
1547
1517
                                                         <link linkend="GMainLoop">GMainLoop</link> **loop);</programlisting>
1548
1518
<para>
1553
1523
state.
1554
1524
</para>
1555
1525
<para>
1556
 
Stop sending any DTMF tone which has been started using the StartTone         method. If there is no current tone, this method will do nothing.</para>
 
1526
Stop sending any DTMF tone which has been started using the         &lt;tp:member-ref&gt;StartTone&lt;/tp:member-ref&gt;         method. If there is no current tone, this method will do nothing.</para>
1557
1527
<para>
1558
 
 
1559
1528
</para><variablelist role="params">
1560
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1529
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1561
1530
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
1562
1531
</simpara></listitem></varlistentry>
1563
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
1532
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
1564
1533
<listitem><simpara> Timeout in milliseconds, or -1 for default
1565
1534
</simpara></listitem></varlistentry>
1566
 
<varlistentry><term><parameter>in_stream_id</parameter>&nbsp;:</term>
 
1535
<varlistentry><term><parameter>in_Stream_ID</parameter>&#160;:</term>
1567
1536
<listitem><simpara> Used to pass an 'in' argument: A stream ID as defined in the StreamedMedia channel type.
1568
1537
</simpara></listitem></varlistentry>
1569
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
1570
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> 
 
1538
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
1539
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> 
1571
1540
 is returned
1572
1541
</simpara></listitem></varlistentry>
1573
 
<varlistentry><term><parameter>loop</parameter>&nbsp;:</term>
1574
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, set before re-entering 
 
1542
<varlistentry><term><parameter>loop</parameter>&#160;:</term>
 
1543
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, set before re-entering 
1575
1544
 the main loop, to point to a <link linkend="GMainLoop"><type>GMainLoop</type></link> 
1576
1545
 which can be used to cancel this call with 
1577
1546
 <link linkend="g-main-loop-quit"><function>g_main_loop_quit()</function></link>, causing a return of 
1578
 
 <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED:CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
 
1547
 <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED--CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
1579
1548
</simpara></listitem></varlistentry>
1580
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
 
1549
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
1581
1550
</simpara></listitem></varlistentry>
1582
1551
</variablelist></refsect2>
1583
1552
<refsect2 id="tp-cli-channel-interface-dtmf-call-start-tone" role="function">
1584
1553
<title>tp_cli_channel_interface_dtmf_call_start_tone ()</title>
1585
 
<indexterm zone="tp-cli-channel-interface-dtmf-call-start-tone"><primary>tp_cli_channel_interface_dtmf_call_start_tone</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* tp_cli_channel_interface_dtmf_call_start_tone
 
1554
<indexterm zone="tp-cli-channel-interface-dtmf-call-start-tone"><primary sortas="tp_cli_channel_interface_dtmf_call_start_tone">tp_cli_channel_interface_dtmf_call_start_tone</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * tp_cli_channel_interface_dtmf_call_start_tone
1586
1555
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1587
1556
                                                         <link linkend="gint">gint</link> timeout_ms,
1588
 
                                                         <link linkend="guint">guint</link> in_stream_id,
1589
 
                                                         <link linkend="guchar">guchar</link> in_event,
 
1557
                                                         <link linkend="guint">guint</link> in_Stream_ID,
 
1558
                                                         <link linkend="guchar">guchar</link> in_Event,
1590
1559
                                                         <link linkend="tp-cli-channel-interface-dtmf-callback-for-start-tone">tp_cli_channel_interface_dtmf_callback_for_start_tone</link> callback,
1591
1560
                                                         <link linkend="gpointer">gpointer</link> user_data,
1592
1561
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy,
1595
1564
Start a StartTone method call.
1596
1565
</para>
1597
1566
<para>
1598
 
Start sending a DTMF tone on this stream. Where possible, the tone         will continue until StopTone is called. On certain protocols, it may         only be possible to send events with a predetermined length. In this         case, the implementation may emit a fixed-length tone, and the StopTone         method call should return NotAvailable.</para>
 
1567
Start sending a DTMF tone on this stream. Where possible, the tone         will continue until &lt;tp:member-ref&gt;StopTone&lt;/tp:member-ref&gt; is called.         On certain protocols, it may         only be possible to send events with a predetermined length. In this         case, the implementation may emit a fixed-length tone, and the StopTone         method call should return NotAvailable.</para>
1599
1568
<para>
1600
 
 
1601
1569
</para><variablelist role="params">
1602
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1570
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1603
1571
<listitem><simpara> the <link linkend="TpProxy"><type>TpProxy</type></link>
1604
1572
</simpara></listitem></varlistentry>
1605
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
1573
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
1606
1574
<listitem><simpara> the timeout in milliseconds, or -1 to use the
1607
1575
  default
1608
1576
</simpara></listitem></varlistentry>
1609
 
<varlistentry><term><parameter>in_stream_id</parameter>&nbsp;:</term>
 
1577
<varlistentry><term><parameter>in_Stream_ID</parameter>&#160;:</term>
1610
1578
<listitem><simpara> Used to pass an 'in' argument: A stream ID as defined in the StreamedMedia channel type.
1611
1579
</simpara></listitem></varlistentry>
1612
 
<varlistentry><term><parameter>in_event</parameter>&nbsp;:</term>
 
1580
<varlistentry><term><parameter>in_Event</parameter>&#160;:</term>
1613
1581
<listitem><simpara> Used to pass an 'in' argument: A numeric event code from the DTMF_Event enum.
1614
1582
</simpara></listitem></varlistentry>
1615
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
1583
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
1616
1584
<listitem><simpara> called when the method call succeeds or fails;
1617
 
  may be <link linkend="NULL:CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
 
1585
  may be <link linkend="NULL--CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
1618
1586
  reply tracking
1619
1587
</simpara></listitem></varlistentry>
1620
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1588
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1621
1589
<listitem><simpara> user-supplied data passed to the callback;
1622
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1590
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1623
1591
</simpara></listitem></varlistentry>
1624
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
1592
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
1625
1593
<listitem><simpara> called with the user_data as argument, after the
1626
1594
  call has succeeded, failed or been cancelled;
1627
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1595
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1628
1596
</simpara></listitem></varlistentry>
1629
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
1630
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
 
1597
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
 
1598
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
1631
1599
  weakly referenced; if it is destroyed, this call 
1632
 
  will automatically be cancelled. Must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if 
1633
 
  <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1600
  will automatically be cancelled. Must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if 
 
1601
  <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1634
1602
</simpara></listitem></varlistentry>
1635
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
 
1603
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
1636
1604
 progress. It is borrowed from the object, and will become
1637
1605
 invalid when the callback is called, the call is
1638
1606
 cancelled or the <link linkend="TpProxy"><type>TpProxy</type></link> becomes invalid.
1640
1608
</variablelist></refsect2>
1641
1609
<refsect2 id="tp-cli-channel-interface-dtmf-call-stop-tone" role="function">
1642
1610
<title>tp_cli_channel_interface_dtmf_call_stop_tone ()</title>
1643
 
<indexterm zone="tp-cli-channel-interface-dtmf-call-stop-tone"><primary>tp_cli_channel_interface_dtmf_call_stop_tone</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* tp_cli_channel_interface_dtmf_call_stop_tone
 
1611
<indexterm zone="tp-cli-channel-interface-dtmf-call-stop-tone"><primary sortas="tp_cli_channel_interface_dtmf_call_stop_tone">tp_cli_channel_interface_dtmf_call_stop_tone</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * tp_cli_channel_interface_dtmf_call_stop_tone
1644
1612
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1645
1613
                                                         <link linkend="gint">gint</link> timeout_ms,
1646
 
                                                         <link linkend="guint">guint</link> in_stream_id,
 
1614
                                                         <link linkend="guint">guint</link> in_Stream_ID,
1647
1615
                                                         <link linkend="tp-cli-channel-interface-dtmf-callback-for-stop-tone">tp_cli_channel_interface_dtmf_callback_for_stop_tone</link> callback,
1648
1616
                                                         <link linkend="gpointer">gpointer</link> user_data,
1649
1617
                                                         <link linkend="GDestroyNotify">GDestroyNotify</link> destroy,
1652
1620
Start a StopTone method call.
1653
1621
</para>
1654
1622
<para>
1655
 
Stop sending any DTMF tone which has been started using the StartTone         method. If there is no current tone, this method will do nothing.</para>
 
1623
Stop sending any DTMF tone which has been started using the         &lt;tp:member-ref&gt;StartTone&lt;/tp:member-ref&gt;         method. If there is no current tone, this method will do nothing.</para>
1656
1624
<para>
1657
 
 
1658
1625
</para><variablelist role="params">
1659
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1626
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1660
1627
<listitem><simpara> the <link linkend="TpProxy"><type>TpProxy</type></link>
1661
1628
</simpara></listitem></varlistentry>
1662
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
1629
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
1663
1630
<listitem><simpara> the timeout in milliseconds, or -1 to use the
1664
1631
  default
1665
1632
</simpara></listitem></varlistentry>
1666
 
<varlistentry><term><parameter>in_stream_id</parameter>&nbsp;:</term>
 
1633
<varlistentry><term><parameter>in_Stream_ID</parameter>&#160;:</term>
1667
1634
<listitem><simpara> Used to pass an 'in' argument: A stream ID as defined in the StreamedMedia channel type.
1668
1635
</simpara></listitem></varlistentry>
1669
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
1636
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
1670
1637
<listitem><simpara> called when the method call succeeds or fails;
1671
 
  may be <link linkend="NULL:CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
 
1638
  may be <link linkend="NULL--CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
1672
1639
  reply tracking
1673
1640
</simpara></listitem></varlistentry>
1674
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1641
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1675
1642
<listitem><simpara> user-supplied data passed to the callback;
1676
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1643
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1677
1644
</simpara></listitem></varlistentry>
1678
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
1645
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
1679
1646
<listitem><simpara> called with the user_data as argument, after the
1680
1647
  call has succeeded, failed or been cancelled;
1681
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1648
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1682
1649
</simpara></listitem></varlistentry>
1683
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
1684
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
 
1650
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
 
1651
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
1685
1652
  weakly referenced; if it is destroyed, this call 
1686
 
  will automatically be cancelled. Must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if 
1687
 
  <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1653
  will automatically be cancelled. Must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if 
 
1654
  <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1688
1655
</simpara></listitem></varlistentry>
1689
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
 
1656
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
1690
1657
 progress. It is borrowed from the object, and will become
1691
1658
 invalid when the callback is called, the call is
1692
1659
 cancelled or the <link linkend="TpProxy"><type>TpProxy</type></link> becomes invalid.
1694
1661
</variablelist></refsect2>
1695
1662
<refsect2 id="tp-cli-channel-interface-dtmf-callback-for-start-tone" role="function">
1696
1663
<title>tp_cli_channel_interface_dtmf_callback_for_start_tone ()</title>
1697
 
<indexterm zone="tp-cli-channel-interface-dtmf-callback-for-start-tone"><primary>tp_cli_channel_interface_dtmf_callback_for_start_tone</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_dtmf_callback_for_start_tone)
 
1664
<indexterm zone="tp-cli-channel-interface-dtmf-callback-for-start-tone"><primary sortas="tp_cli_channel_interface_dtmf_callback_for_start_tone">tp_cli_channel_interface_dtmf_callback_for_start_tone</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_dtmf_callback_for_start_tone)
1698
1665
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1699
1666
                                                         const <link linkend="GError">GError</link> *error,
1700
1667
                                                         <link linkend="gpointer">gpointer</link> user_data,
1703
1670
Signature of the callback called when a StartTone method call
1704
1671
succeeds or fails.</para>
1705
1672
<para>
1706
 
 
1707
1673
</para><variablelist role="params">
1708
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1674
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1709
1675
<listitem><simpara> the proxy on which the call was made
1710
1676
</simpara></listitem></varlistentry>
1711
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
1712
 
<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link> on success, or an error on failure
 
1677
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
1678
<listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link> on success, or an error on failure
1713
1679
</simpara></listitem></varlistentry>
1714
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1680
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1715
1681
<listitem><simpara> user-supplied data
1716
1682
</simpara></listitem></varlistentry>
1717
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
1683
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
1718
1684
<listitem><simpara> user-supplied object
1719
1685
</simpara></listitem></varlistentry>
1720
1686
</variablelist></refsect2>
1721
1687
<refsect2 id="tp-cli-channel-interface-dtmf-callback-for-stop-tone" role="function">
1722
1688
<title>tp_cli_channel_interface_dtmf_callback_for_stop_tone ()</title>
1723
 
<indexterm zone="tp-cli-channel-interface-dtmf-callback-for-stop-tone"><primary>tp_cli_channel_interface_dtmf_callback_for_stop_tone</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_dtmf_callback_for_stop_tone)
 
1689
<indexterm zone="tp-cli-channel-interface-dtmf-callback-for-stop-tone"><primary sortas="tp_cli_channel_interface_dtmf_callback_for_stop_tone">tp_cli_channel_interface_dtmf_callback_for_stop_tone</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_dtmf_callback_for_stop_tone)
1724
1690
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1725
1691
                                                         const <link linkend="GError">GError</link> *error,
1726
1692
                                                         <link linkend="gpointer">gpointer</link> user_data,
1729
1695
Signature of the callback called when a StopTone method call
1730
1696
succeeds or fails.</para>
1731
1697
<para>
1732
 
 
1733
1698
</para><variablelist role="params">
1734
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1699
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1735
1700
<listitem><simpara> the proxy on which the call was made
1736
1701
</simpara></listitem></varlistentry>
1737
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
1738
 
<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link> on success, or an error on failure
 
1702
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
1703
<listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link> on success, or an error on failure
1739
1704
</simpara></listitem></varlistentry>
1740
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1705
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1741
1706
<listitem><simpara> user-supplied data
1742
1707
</simpara></listitem></varlistentry>
1743
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
1708
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
1744
1709
<listitem><simpara> user-supplied object
1745
1710
</simpara></listitem></varlistentry>
1746
1711
</variablelist></refsect2>
1747
1712
<refsect2 id="tp-cli-channel-interface-hold-callback-for-get-hold-state" role="function">
1748
1713
<title>tp_cli_channel_interface_hold_callback_for_get_hold_state ()</title>
1749
 
<indexterm zone="tp-cli-channel-interface-hold-callback-for-get-hold-state"><primary>tp_cli_channel_interface_hold_callback_for_get_hold_state</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_hold_callback_for_get_hold_state)
 
1714
<indexterm zone="tp-cli-channel-interface-hold-callback-for-get-hold-state"><primary sortas="tp_cli_channel_interface_hold_callback_for_get_hold_state">tp_cli_channel_interface_hold_callback_for_get_hold_state</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_hold_callback_for_get_hold_state)
1750
1715
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1751
1716
                                                         <link linkend="guint">guint</link> out_HoldState,
1752
1717
                                                         <link linkend="guint">guint</link> out_Reason,
1757
1722
Signature of the callback called when a GetHoldState method call
1758
1723
succeeds or fails.</para>
1759
1724
<para>
1760
 
 
1761
1725
</para><variablelist role="params">
1762
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1726
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1763
1727
<listitem><simpara> the proxy on which the call was made
1764
1728
</simpara></listitem></varlistentry>
1765
 
<varlistentry><term><parameter>out_HoldState</parameter>&nbsp;:</term>
1766
 
<listitem><simpara> Used to return an 'out' argument if <parameter>error</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>: The state of the channel
1767
 
</simpara></listitem></varlistentry>
1768
 
<varlistentry><term><parameter>out_Reason</parameter>&nbsp;:</term>
1769
 
<listitem><simpara> Used to return an 'out' argument if <parameter>error</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>: The reason why the channel is in that state
1770
 
</simpara></listitem></varlistentry>
1771
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
1772
 
<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link> on success, or an error on failure
1773
 
</simpara></listitem></varlistentry>
1774
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1729
<varlistentry><term><parameter>out_HoldState</parameter>&#160;:</term>
 
1730
<listitem><simpara> Used to return an 'out' argument if <parameter>error</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>: The state of the channel
 
1731
</simpara></listitem></varlistentry>
 
1732
<varlistentry><term><parameter>out_Reason</parameter>&#160;:</term>
 
1733
<listitem><simpara> Used to return an 'out' argument if <parameter>error</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>: The reason why the channel is in that state
 
1734
</simpara></listitem></varlistentry>
 
1735
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
1736
<listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link> on success, or an error on failure
 
1737
</simpara></listitem></varlistentry>
 
1738
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1775
1739
<listitem><simpara> user-supplied data
1776
1740
</simpara></listitem></varlistentry>
1777
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
1741
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
1778
1742
<listitem><simpara> user-supplied object
1779
1743
</simpara></listitem></varlistentry>
1780
1744
</variablelist></refsect2>
1781
1745
<refsect2 id="tp-cli-channel-interface-hold-call-get-hold-state" role="function">
1782
1746
<title>tp_cli_channel_interface_hold_call_get_hold_state ()</title>
1783
 
<indexterm zone="tp-cli-channel-interface-hold-call-get-hold-state"><primary>tp_cli_channel_interface_hold_call_get_hold_state</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* tp_cli_channel_interface_hold_call_get_hold_state
 
1747
<indexterm zone="tp-cli-channel-interface-hold-call-get-hold-state"><primary sortas="tp_cli_channel_interface_hold_call_get_hold_state">tp_cli_channel_interface_hold_call_get_hold_state</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * tp_cli_channel_interface_hold_call_get_hold_state
1784
1748
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1785
1749
                                                         <link linkend="gint">gint</link> timeout_ms,
1786
1750
                                                         <link linkend="tp-cli-channel-interface-hold-callback-for-get-hold-state">tp_cli_channel_interface_hold_callback_for_get_hold_state</link> callback,
1793
1757
<para>
1794
1758
Return whether the local user has placed the channel on hold.</para>
1795
1759
<para>
1796
 
 
1797
1760
</para><variablelist role="params">
1798
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1761
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1799
1762
<listitem><simpara> the <link linkend="TpProxy"><type>TpProxy</type></link>
1800
1763
</simpara></listitem></varlistentry>
1801
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
1764
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
1802
1765
<listitem><simpara> the timeout in milliseconds, or -1 to use the
1803
1766
  default
1804
1767
</simpara></listitem></varlistentry>
1805
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
1768
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
1806
1769
<listitem><simpara> called when the method call succeeds or fails;
1807
 
  may be <link linkend="NULL:CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
 
1770
  may be <link linkend="NULL--CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
1808
1771
  reply tracking
1809
1772
</simpara></listitem></varlistentry>
1810
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1773
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1811
1774
<listitem><simpara> user-supplied data passed to the callback;
1812
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1775
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1813
1776
</simpara></listitem></varlistentry>
1814
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
1777
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
1815
1778
<listitem><simpara> called with the user_data as argument, after the
1816
1779
  call has succeeded, failed or been cancelled;
1817
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1780
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1818
1781
</simpara></listitem></varlistentry>
1819
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
1820
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
 
1782
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
 
1783
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
1821
1784
  weakly referenced; if it is destroyed, this call 
1822
 
  will automatically be cancelled. Must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if 
1823
 
  <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1785
  will automatically be cancelled. Must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if 
 
1786
  <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1824
1787
</simpara></listitem></varlistentry>
1825
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
 
1788
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
1826
1789
 progress. It is borrowed from the object, and will become
1827
1790
 invalid when the callback is called, the call is
1828
1791
 cancelled or the <link linkend="TpProxy"><type>TpProxy</type></link> becomes invalid.
1830
1793
</variablelist></refsect2>
1831
1794
<refsect2 id="tp-cli-channel-interface-hold-run-get-hold-state" role="function">
1832
1795
<title>tp_cli_channel_interface_hold_run_get_hold_state ()</title>
1833
 
<indexterm zone="tp-cli-channel-interface-hold-run-get-hold-state"><primary>tp_cli_channel_interface_hold_run_get_hold_state</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_interface_hold_run_get_hold_state
 
1796
<indexterm zone="tp-cli-channel-interface-hold-run-get-hold-state"><primary sortas="tp_cli_channel_interface_hold_run_get_hold_state">tp_cli_channel_interface_hold_run_get_hold_state</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_interface_hold_run_get_hold_state
1834
1797
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1835
1798
                                                         <link linkend="gint">gint</link> timeout_ms,
1836
1799
                                                         <link linkend="guint">guint</link> *out_HoldState,
1847
1810
<para>
1848
1811
Return whether the local user has placed the channel on hold.</para>
1849
1812
<para>
1850
 
 
1851
1813
</para><variablelist role="params">
1852
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1814
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1853
1815
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
1854
1816
</simpara></listitem></varlistentry>
1855
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
1817
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
1856
1818
<listitem><simpara> Timeout in milliseconds, or -1 for default
1857
1819
</simpara></listitem></varlistentry>
1858
 
<varlistentry><term><parameter>out_HoldState</parameter>&nbsp;:</term>
1859
 
<listitem><simpara> Used to return an 'out' argument if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> is returned: The state of the channel
1860
 
</simpara></listitem></varlistentry>
1861
 
<varlistentry><term><parameter>out_Reason</parameter>&nbsp;:</term>
1862
 
<listitem><simpara> Used to return an 'out' argument if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> is returned: The reason why the channel is in that state
1863
 
</simpara></listitem></varlistentry>
1864
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
1865
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> 
 
1820
<varlistentry><term><parameter>out_HoldState</parameter>&#160;:</term>
 
1821
<listitem><simpara> Used to return an 'out' argument if <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> is returned: The state of the channel
 
1822
</simpara></listitem></varlistentry>
 
1823
<varlistentry><term><parameter>out_Reason</parameter>&#160;:</term>
 
1824
<listitem><simpara> Used to return an 'out' argument if <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> is returned: The reason why the channel is in that state
 
1825
</simpara></listitem></varlistentry>
 
1826
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
1827
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> 
1866
1828
 is returned
1867
1829
</simpara></listitem></varlistentry>
1868
 
<varlistentry><term><parameter>loop</parameter>&nbsp;:</term>
1869
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, set before re-entering 
 
1830
<varlistentry><term><parameter>loop</parameter>&#160;:</term>
 
1831
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, set before re-entering 
1870
1832
 the main loop, to point to a <link linkend="GMainLoop"><type>GMainLoop</type></link> 
1871
1833
 which can be used to cancel this call with 
1872
1834
 <link linkend="g-main-loop-quit"><function>g_main_loop_quit()</function></link>, causing a return of 
1873
 
 <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED:CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
 
1835
 <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED--CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
1874
1836
</simpara></listitem></varlistentry>
1875
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
 
1837
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
1876
1838
</simpara></listitem></varlistentry>
1877
1839
</variablelist></refsect2>
1878
1840
<refsect2 id="tp-cli-channel-interface-hold-callback-for-request-hold" role="function">
1879
1841
<title>tp_cli_channel_interface_hold_callback_for_request_hold ()</title>
1880
 
<indexterm zone="tp-cli-channel-interface-hold-callback-for-request-hold"><primary>tp_cli_channel_interface_hold_callback_for_request_hold</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_hold_callback_for_request_hold)
 
1842
<indexterm zone="tp-cli-channel-interface-hold-callback-for-request-hold"><primary sortas="tp_cli_channel_interface_hold_callback_for_request_hold">tp_cli_channel_interface_hold_callback_for_request_hold</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_hold_callback_for_request_hold)
1881
1843
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1882
1844
                                                         const <link linkend="GError">GError</link> *error,
1883
1845
                                                         <link linkend="gpointer">gpointer</link> user_data,
1886
1848
Signature of the callback called when a RequestHold method call
1887
1849
succeeds or fails.</para>
1888
1850
<para>
1889
 
 
1890
1851
</para><variablelist role="params">
1891
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1852
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1892
1853
<listitem><simpara> the proxy on which the call was made
1893
1854
</simpara></listitem></varlistentry>
1894
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
1895
 
<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link> on success, or an error on failure
 
1855
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
1856
<listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link> on success, or an error on failure
1896
1857
</simpara></listitem></varlistentry>
1897
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1858
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1898
1859
<listitem><simpara> user-supplied data
1899
1860
</simpara></listitem></varlistentry>
1900
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
1861
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
1901
1862
<listitem><simpara> user-supplied object
1902
1863
</simpara></listitem></varlistentry>
1903
1864
</variablelist></refsect2>
1904
1865
<refsect2 id="tp-cli-channel-interface-hold-call-request-hold" role="function">
1905
1866
<title>tp_cli_channel_interface_hold_call_request_hold ()</title>
1906
 
<indexterm zone="tp-cli-channel-interface-hold-call-request-hold"><primary>tp_cli_channel_interface_hold_call_request_hold</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* tp_cli_channel_interface_hold_call_request_hold
 
1867
<indexterm zone="tp-cli-channel-interface-hold-call-request-hold"><primary sortas="tp_cli_channel_interface_hold_call_request_hold">tp_cli_channel_interface_hold_call_request_hold</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * tp_cli_channel_interface_hold_call_request_hold
1907
1868
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1908
1869
                                                         <link linkend="gint">gint</link> timeout_ms,
1909
1870
                                                         <link linkend="gboolean">gboolean</link> in_Hold,
1915
1876
Start a RequestHold method call.
1916
1877
</para>
1917
1878
<para>
1918
 
&lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;         &lt;p&gt;Request that the channel be put on hold (be instructed not to send           any media streams to you) or be taken off hold.&lt;/p&gt;          &lt;p&gt;If the connection manager can immediately tell that the requested           state change could not possibly succeed, this method SHOULD           return the NotAvailable error. If the requested state is the           same as the current state, this method SHOULD return successfully           without doing anything.&lt;/p&gt;          &lt;p&gt;Otherwise, this method SHOULD immediately set the hold state to           Local_Hold_State_Pending_Hold or Local_Hold_State_Pending_Unhold           (as appropriate), emitting HoldStateChanged if this is a change,           and return successfully.&lt;/p&gt;          &lt;p&gt;The eventual success or failure of the request is indicated by a           subsequent HoldStateChanged signal, changing the hold state to           Local_Hold_State_Held or Local_Hold_State_Unheld.&lt;/p&gt;          &lt;p&gt;If the channel has multiple streams, and the connection manager           succeeds in changing the hold state of one stream but fails to           change the hold state of another, it SHOULD attempt to revert           all streams to their previous hold states.&lt;/p&gt;          &lt;p&gt;The following state transitions SHOULD be used, where           appropriate:&lt;/p&gt;          &lt;ul&gt;           &lt;li&gt;Successful hold:             (Unheld, any reason) → (Pending_Hold, Requested) →             (Held, Requested)           &lt;/li&gt;           &lt;li&gt;Successful unhold:             (Held, any reason) → (Pending_Unhold, Requested) →             (Unheld, Requested)           &lt;/li&gt;           &lt;li&gt;Attempting to unhold fails at the first attempt to acquire a             resource:             (Held, any reason) → (Pending_Unhold, Requested) →             (Held, Resource_Not_Available)           &lt;/li&gt;           &lt;li&gt;Attempting to unhold acquires one resource, but fails to acquire             a second, and takes time to release the first:             (Held, any reason) → (Pending_Unhold, Requested) →             (Pending_Hold, Resource_Not_Available) →             (Held, Resource_Not_Available)           &lt;/li&gt;         &lt;/ul&gt;</para>
 
1879
&lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;         &lt;p&gt;Request that the channel be put on hold (be instructed not to send           any media streams to you) or be taken off hold.&lt;/p&gt;          &lt;p&gt;If the connection manager can immediately tell that the requested           state change could not possibly succeed, this method SHOULD           return the NotAvailable error. If the requested state is the           same as the current state, this method SHOULD return successfully           without doing anything.&lt;/p&gt;          &lt;p&gt;Otherwise, this method SHOULD immediately set the hold state to           Local_Hold_State_Pending_Hold or Local_Hold_State_Pending_Unhold           (as appropriate), emitting           &lt;tp:member-ref&gt;HoldStateChanged&lt;/tp:member-ref&gt; if this is a change,           and return successfully.&lt;/p&gt;          &lt;p&gt;The eventual success or failure of the request is indicated by a           subsequent HoldStateChanged signal, changing the hold state to           Local_Hold_State_Held or Local_Hold_State_Unheld.&lt;/p&gt;          &lt;p&gt;If the channel has multiple streams, and the connection manager           succeeds in changing the hold state of one stream but fails to           change the hold state of another, it SHOULD attempt to revert           all streams to their previous hold states.&lt;/p&gt;          &lt;p&gt;The following state transitions SHOULD be used, where           appropriate:&lt;/p&gt;          &lt;ul&gt;           &lt;li&gt;Successful hold:             (Unheld, any reason) → (Pending_Hold, Requested) →             (Held, Requested)           &lt;/li&gt;           &lt;li&gt;Successful unhold:             (Held, any reason) → (Pending_Unhold, Requested) →             (Unheld, Requested)           &lt;/li&gt;           &lt;li&gt;Attempting to unhold fails at the first attempt to acquire a             resource:             (Held, any reason) → (Pending_Unhold, Requested) →             (Held, Resource_Not_Available)           &lt;/li&gt;           &lt;li&gt;Attempting to unhold acquires one resource, but fails to acquire             a second, and takes time to release the first:             (Held, any reason) → (Pending_Unhold, Requested) →             (Pending_Hold, Resource_Not_Available) →             (Held, Resource_Not_Available)           &lt;/li&gt;         &lt;/ul&gt;</para>
1919
1880
<para>
1920
 
 
1921
1881
</para><variablelist role="params">
1922
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1882
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1923
1883
<listitem><simpara> the <link linkend="TpProxy"><type>TpProxy</type></link>
1924
1884
</simpara></listitem></varlistentry>
1925
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
1885
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
1926
1886
<listitem><simpara> the timeout in milliseconds, or -1 to use the
1927
1887
  default
1928
1888
</simpara></listitem></varlistentry>
1929
 
<varlistentry><term><parameter>in_Hold</parameter>&nbsp;:</term>
 
1889
<varlistentry><term><parameter>in_Hold</parameter>&#160;:</term>
1930
1890
<listitem><simpara> Used to pass an 'in' argument: A boolean indicating whether or not the channel should be on hold
1931
1891
</simpara></listitem></varlistentry>
1932
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
1892
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
1933
1893
<listitem><simpara> called when the method call succeeds or fails;
1934
 
  may be <link linkend="NULL:CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
 
1894
  may be <link linkend="NULL--CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
1935
1895
  reply tracking
1936
1896
</simpara></listitem></varlistentry>
1937
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1897
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
1938
1898
<listitem><simpara> user-supplied data passed to the callback;
1939
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1899
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1940
1900
</simpara></listitem></varlistentry>
1941
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
1901
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
1942
1902
<listitem><simpara> called with the user_data as argument, after the
1943
1903
  call has succeeded, failed or been cancelled;
1944
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1904
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1945
1905
</simpara></listitem></varlistentry>
1946
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
1947
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
 
1906
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
 
1907
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
1948
1908
  weakly referenced; if it is destroyed, this call 
1949
 
  will automatically be cancelled. Must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if 
1950
 
  <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
1909
  will automatically be cancelled. Must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if 
 
1910
  <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1951
1911
</simpara></listitem></varlistentry>
1952
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
 
1912
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
1953
1913
 progress. It is borrowed from the object, and will become
1954
1914
 invalid when the callback is called, the call is
1955
1915
 cancelled or the <link linkend="TpProxy"><type>TpProxy</type></link> becomes invalid.
1957
1917
</variablelist></refsect2>
1958
1918
<refsect2 id="tp-cli-channel-interface-hold-run-request-hold" role="function">
1959
1919
<title>tp_cli_channel_interface_hold_run_request_hold ()</title>
1960
 
<indexterm zone="tp-cli-channel-interface-hold-run-request-hold"><primary>tp_cli_channel_interface_hold_run_request_hold</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_interface_hold_run_request_hold
 
1920
<indexterm zone="tp-cli-channel-interface-hold-run-request-hold"><primary sortas="tp_cli_channel_interface_hold_run_request_hold">tp_cli_channel_interface_hold_run_request_hold</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_interface_hold_run_request_hold
1961
1921
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
1962
1922
                                                         <link linkend="gint">gint</link> timeout_ms,
1963
1923
                                                         <link linkend="gboolean">gboolean</link> in_Hold,
1971
1931
state.
1972
1932
</para>
1973
1933
<para>
1974
 
&lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;         &lt;p&gt;Request that the channel be put on hold (be instructed not to send           any media streams to you) or be taken off hold.&lt;/p&gt;          &lt;p&gt;If the connection manager can immediately tell that the requested           state change could not possibly succeed, this method SHOULD           return the NotAvailable error. If the requested state is the           same as the current state, this method SHOULD return successfully           without doing anything.&lt;/p&gt;          &lt;p&gt;Otherwise, this method SHOULD immediately set the hold state to           Local_Hold_State_Pending_Hold or Local_Hold_State_Pending_Unhold           (as appropriate), emitting HoldStateChanged if this is a change,           and return successfully.&lt;/p&gt;          &lt;p&gt;The eventual success or failure of the request is indicated by a           subsequent HoldStateChanged signal, changing the hold state to           Local_Hold_State_Held or Local_Hold_State_Unheld.&lt;/p&gt;          &lt;p&gt;If the channel has multiple streams, and the connection manager           succeeds in changing the hold state of one stream but fails to           change the hold state of another, it SHOULD attempt to revert           all streams to their previous hold states.&lt;/p&gt;          &lt;p&gt;The following state transitions SHOULD be used, where           appropriate:&lt;/p&gt;          &lt;ul&gt;           &lt;li&gt;Successful hold:             (Unheld, any reason) → (Pending_Hold, Requested) →             (Held, Requested)           &lt;/li&gt;           &lt;li&gt;Successful unhold:             (Held, any reason) → (Pending_Unhold, Requested) →             (Unheld, Requested)           &lt;/li&gt;           &lt;li&gt;Attempting to unhold fails at the first attempt to acquire a             resource:             (Held, any reason) → (Pending_Unhold, Requested) →             (Held, Resource_Not_Available)           &lt;/li&gt;           &lt;li&gt;Attempting to unhold acquires one resource, but fails to acquire             a second, and takes time to release the first:             (Held, any reason) → (Pending_Unhold, Requested) →             (Pending_Hold, Resource_Not_Available) →             (Held, Resource_Not_Available)           &lt;/li&gt;         &lt;/ul&gt;</para>
 
1934
&lt;tp:docstring xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;         &lt;p&gt;Request that the channel be put on hold (be instructed not to send           any media streams to you) or be taken off hold.&lt;/p&gt;          &lt;p&gt;If the connection manager can immediately tell that the requested           state change could not possibly succeed, this method SHOULD           return the NotAvailable error. If the requested state is the           same as the current state, this method SHOULD return successfully           without doing anything.&lt;/p&gt;          &lt;p&gt;Otherwise, this method SHOULD immediately set the hold state to           Local_Hold_State_Pending_Hold or Local_Hold_State_Pending_Unhold           (as appropriate), emitting           &lt;tp:member-ref&gt;HoldStateChanged&lt;/tp:member-ref&gt; if this is a change,           and return successfully.&lt;/p&gt;          &lt;p&gt;The eventual success or failure of the request is indicated by a           subsequent HoldStateChanged signal, changing the hold state to           Local_Hold_State_Held or Local_Hold_State_Unheld.&lt;/p&gt;          &lt;p&gt;If the channel has multiple streams, and the connection manager           succeeds in changing the hold state of one stream but fails to           change the hold state of another, it SHOULD attempt to revert           all streams to their previous hold states.&lt;/p&gt;          &lt;p&gt;The following state transitions SHOULD be used, where           appropriate:&lt;/p&gt;          &lt;ul&gt;           &lt;li&gt;Successful hold:             (Unheld, any reason) → (Pending_Hold, Requested) →             (Held, Requested)           &lt;/li&gt;           &lt;li&gt;Successful unhold:             (Held, any reason) → (Pending_Unhold, Requested) →             (Unheld, Requested)           &lt;/li&gt;           &lt;li&gt;Attempting to unhold fails at the first attempt to acquire a             resource:             (Held, any reason) → (Pending_Unhold, Requested) →             (Held, Resource_Not_Available)           &lt;/li&gt;           &lt;li&gt;Attempting to unhold acquires one resource, but fails to acquire             a second, and takes time to release the first:             (Held, any reason) → (Pending_Unhold, Requested) →             (Pending_Hold, Resource_Not_Available) →             (Held, Resource_Not_Available)           &lt;/li&gt;         &lt;/ul&gt;</para>
1975
1935
<para>
1976
 
 
1977
1936
</para><variablelist role="params">
1978
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1937
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
1979
1938
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
1980
1939
</simpara></listitem></varlistentry>
1981
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
1940
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
1982
1941
<listitem><simpara> Timeout in milliseconds, or -1 for default
1983
1942
</simpara></listitem></varlistentry>
1984
 
<varlistentry><term><parameter>in_Hold</parameter>&nbsp;:</term>
 
1943
<varlistentry><term><parameter>in_Hold</parameter>&#160;:</term>
1985
1944
<listitem><simpara> Used to pass an 'in' argument: A boolean indicating whether or not the channel should be on hold
1986
1945
</simpara></listitem></varlistentry>
1987
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
1988
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> 
 
1946
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
1947
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> 
1989
1948
 is returned
1990
1949
</simpara></listitem></varlistentry>
1991
 
<varlistentry><term><parameter>loop</parameter>&nbsp;:</term>
1992
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, set before re-entering 
 
1950
<varlistentry><term><parameter>loop</parameter>&#160;:</term>
 
1951
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, set before re-entering 
1993
1952
 the main loop, to point to a <link linkend="GMainLoop"><type>GMainLoop</type></link> 
1994
1953
 which can be used to cancel this call with 
1995
1954
 <link linkend="g-main-loop-quit"><function>g_main_loop_quit()</function></link>, causing a return of 
1996
 
 <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED:CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
 
1955
 <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED--CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
1997
1956
</simpara></listitem></varlistentry>
1998
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
 
1957
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
1999
1958
</simpara></listitem></varlistentry>
2000
1959
</variablelist></refsect2>
2001
1960
<refsect2 id="tp-cli-channel-interface-hold-signal-callback-hold-state-changed" role="function">
2002
1961
<title>tp_cli_channel_interface_hold_signal_callback_hold_state_changed ()</title>
2003
 
<indexterm zone="tp-cli-channel-interface-hold-signal-callback-hold-state-changed"><primary>tp_cli_channel_interface_hold_signal_callback_hold_state_changed</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_hold_signal_callback_hold_state_changed)
 
1962
<indexterm zone="tp-cli-channel-interface-hold-signal-callback-hold-state-changed"><primary sortas="tp_cli_channel_interface_hold_signal_callback_hold_state_changed">tp_cli_channel_interface_hold_signal_callback_hold_state_changed</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_hold_signal_callback_hold_state_changed)
2004
1963
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
2005
1964
                                                         <link linkend="guint">guint</link> arg_HoldState,
2006
1965
                                                         <link linkend="guint">guint</link> arg_Reason,
2009
1968
<para>
2010
1969
Represents the signature of a callback for the signal HoldStateChanged.</para>
2011
1970
<para>
2012
 
 
2013
1971
</para><variablelist role="params">
2014
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
1972
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
2015
1973
<listitem><simpara> The proxy on which <link linkend="tp-cli-channel-interface-hold-connect-to-hold-state-changed"><function>tp_cli_channel_interface_hold_connect_to_hold_state_changed()</function></link>
2016
1974
 was called
2017
1975
</simpara></listitem></varlistentry>
2018
 
<varlistentry><term><parameter>arg_HoldState</parameter>&nbsp;:</term>
 
1976
<varlistentry><term><parameter>arg_HoldState</parameter>&#160;:</term>
2019
1977
<listitem><simpara> The state of the channel
2020
1978
</simpara></listitem></varlistentry>
2021
 
<varlistentry><term><parameter>arg_Reason</parameter>&nbsp;:</term>
 
1979
<varlistentry><term><parameter>arg_Reason</parameter>&#160;:</term>
2022
1980
<listitem><simpara> The reason for the state change
2023
1981
</simpara></listitem></varlistentry>
2024
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
1982
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
2025
1983
<listitem><simpara> User-supplied data
2026
1984
</simpara></listitem></varlistentry>
2027
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
1985
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
2028
1986
<listitem><simpara> User-supplied weakly referenced object
2029
1987
</simpara></listitem></varlistentry>
2030
1988
</variablelist></refsect2>
2031
1989
<refsect2 id="tp-cli-channel-interface-hold-connect-to-hold-state-changed" role="function">
2032
1990
<title>tp_cli_channel_interface_hold_connect_to_hold_state_changed ()</title>
2033
 
<indexterm zone="tp-cli-channel-interface-hold-connect-to-hold-state-changed"><primary>tp_cli_channel_interface_hold_connect_to_hold_state_changed</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* tp_cli_channel_interface_hold_connect_to_hold_state_changed
 
1991
<indexterm zone="tp-cli-channel-interface-hold-connect-to-hold-state-changed"><primary sortas="tp_cli_channel_interface_hold_connect_to_hold_state_changed">tp_cli_channel_interface_hold_connect_to_hold_state_changed</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * tp_cli_channel_interface_hold_connect_to_hold_state_changed
2034
1992
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
2035
1993
                                                         <link linkend="tp-cli-channel-interface-hold-signal-callback-hold-state-changed">tp_cli_channel_interface_hold_signal_callback_hold_state_changed</link> callback,
2036
1994
                                                         <link linkend="gpointer">gpointer</link> user_data,
2041
1999
Connect a handler to the signal HoldStateChanged.
2042
2000
</para>
2043
2001
<para>
2044
 
Emitted to indicate that the hold state has changed for this channel.         This may occur as a consequence of you requesting a change with         RequestHold, or the state changing as a result of a request from         another process.</para>
 
2002
Emitted to indicate that the hold state has changed for this channel.         This may occur as a consequence of you requesting a change with         &lt;tp:member-ref&gt;RequestHold&lt;/tp:member-ref&gt;, or the state changing as a         result of a request from         another process.</para>
2045
2003
<para>
2046
 
 
2047
2004
</para><variablelist role="params">
2048
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
2005
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
2049
2006
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
2050
2007
</simpara></listitem></varlistentry>
2051
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
2008
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
2052
2009
<listitem><simpara> Callback to be called when the signal is
2053
2010
  received
2054
2011
</simpara></listitem></varlistentry>
2055
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
2012
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
2056
2013
<listitem><simpara> User-supplied data for the callback
2057
2014
</simpara></listitem></varlistentry>
2058
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
2015
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
2059
2016
<listitem><simpara> Destructor for the user-supplied data, which
2060
2017
  will be called when this signal is disconnected, or
2061
 
  before this function returns <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
2018
  before this function returns <link linkend="NULL--CAPS"><literal>NULL</literal></link>
2062
2019
</simpara></listitem></varlistentry>
2063
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
2020
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
2064
2021
<listitem><simpara> A <link linkend="GObject"><type>GObject</type></link> which will be weakly referenced; 
2065
2022
  if it is destroyed, this callback will automatically be
2066
2023
  disconnected
2067
2024
</simpara></listitem></varlistentry>
2068
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
2069
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL:CAPS"><literal>NULL</literal></link> is
 
2025
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
2026
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL--CAPS"><literal>NULL</literal></link> is
2070
2027
  returned
2071
2028
</simpara></listitem></varlistentry>
2072
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxySignalConnection"><type>TpProxySignalConnection</type></link> containing all of the
 
2029
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxySignalConnection"><type>TpProxySignalConnection</type></link> containing all of the
2073
2030
above, which can be used to disconnect the signal; or
2074
 
<link linkend="NULL:CAPS"><literal>NULL</literal></link> if the proxy does not have the desired interface
 
2031
<link linkend="NULL--CAPS"><literal>NULL</literal></link> if the proxy does not have the desired interface
2075
2032
or has become invalid.
2076
2033
</simpara></listitem></varlistentry>
2077
2034
</variablelist></refsect2>
2078
2035
<refsect2 id="tp-cli-channel-interface-media-signalling-run-get-session-handlers" role="function">
2079
2036
<title>tp_cli_channel_interface_media_signalling_run_get_session_handlers ()</title>
2080
 
<indexterm zone="tp-cli-channel-interface-media-signalling-run-get-session-handlers"><primary>tp_cli_channel_interface_media_signalling_run_get_session_handlers</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_interface_media_signalling_run_get_session_handlers
 
2037
<indexterm zone="tp-cli-channel-interface-media-signalling-run-get-session-handlers"><primary sortas="tp_cli_channel_interface_media_signalling_run_get_session_handlers">tp_cli_channel_interface_media_signalling_run_get_session_handlers</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            tp_cli_channel_interface_media_signalling_run_get_session_handlers
2081
2038
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
2082
2039
                                                         <link linkend="gint">gint</link> timeout_ms,
2083
 
                                                         <link linkend="GPtrArray">GPtrArray</link> **out0,
 
2040
                                                         <link linkend="GPtrArray">GPtrArray</link> **out_Session_Handlers,
2084
2041
                                                         <link linkend="GError">GError</link> **error,
2085
2042
                                                         <link linkend="GMainLoop">GMainLoop</link> **loop);</programlisting>
2086
2043
<para>
2093
2050
<para>
2094
2051
Returns all currently active session handlers on this channel         as a list of (session_handler_path, type).</para>
2095
2052
<para>
2096
 
 
2097
2053
</para><variablelist role="params">
2098
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
2054
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
2099
2055
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
2100
2056
</simpara></listitem></varlistentry>
2101
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
2057
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
2102
2058
<listitem><simpara> Timeout in milliseconds, or -1 for default
2103
2059
</simpara></listitem></varlistentry>
2104
 
<varlistentry><term><parameter>out0</parameter>&nbsp;:</term>
2105
 
<listitem><simpara> Used to return an 'out' argument if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> is returned: (Undocumented)
 
2060
<varlistentry><term><parameter>out_Session_Handlers</parameter>&#160;:</term>
 
2061
<listitem><simpara> Used to return an 'out' argument if <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> is returned: (Undocumented)
2106
2062
</simpara></listitem></varlistentry>
2107
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
2108
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> 
 
2063
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
2064
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to return errors if <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> 
2109
2065
 is returned
2110
2066
</simpara></listitem></varlistentry>
2111
 
<varlistentry><term><parameter>loop</parameter>&nbsp;:</term>
2112
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, set before re-entering 
 
2067
<varlistentry><term><parameter>loop</parameter>&#160;:</term>
 
2068
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, set before re-entering 
2113
2069
 the main loop, to point to a <link linkend="GMainLoop"><type>GMainLoop</type></link> 
2114
2070
 which can be used to cancel this call with 
2115
2071
 <link linkend="g-main-loop-quit"><function>g_main_loop_quit()</function></link>, causing a return of 
2116
 
 <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED:CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
 
2072
 <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> with <parameter>error</parameter> set to <link linkend="TP-DBUS-ERROR-CANCELLED--CAPS"><literal>TP_DBUS_ERROR_CANCELLED</literal></link>
2117
2073
</simpara></listitem></varlistentry>
2118
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
 
2074
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success, FALSE and sets <parameter>error</parameter> on error
2119
2075
</simpara></listitem></varlistentry>
2120
2076
</variablelist></refsect2>
2121
2077
<refsect2 id="tp-cli-channel-interface-media-signalling-call-get-session-handlers" role="function">
2122
2078
<title>tp_cli_channel_interface_media_signalling_call_get_session_handlers ()</title>
2123
 
<indexterm zone="tp-cli-channel-interface-media-signalling-call-get-session-handlers"><primary>tp_cli_channel_interface_media_signalling_call_get_session_handlers</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link>* tp_cli_channel_interface_media_signalling_call_get_session_handlers
 
2079
<indexterm zone="tp-cli-channel-interface-media-signalling-call-get-session-handlers"><primary sortas="tp_cli_channel_interface_media_signalling_call_get_session_handlers">tp_cli_channel_interface_media_signalling_call_get_session_handlers</primary></indexterm><programlisting><link linkend="TpProxyPendingCall">TpProxyPendingCall</link> * tp_cli_channel_interface_media_signalling_call_get_session_handlers
2124
2080
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
2125
2081
                                                         <link linkend="gint">gint</link> timeout_ms,
2126
2082
                                                         <link linkend="tp-cli-channel-interface-media-signalling-callback-for-get-session-handlers">tp_cli_channel_interface_media_signalling_callback_for_get_session_handlers</link> callback,
2133
2089
<para>
2134
2090
Returns all currently active session handlers on this channel         as a list of (session_handler_path, type).</para>
2135
2091
<para>
2136
 
 
2137
2092
</para><variablelist role="params">
2138
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
2093
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
2139
2094
<listitem><simpara> the <link linkend="TpProxy"><type>TpProxy</type></link>
2140
2095
</simpara></listitem></varlistentry>
2141
 
<varlistentry><term><parameter>timeout_ms</parameter>&nbsp;:</term>
 
2096
<varlistentry><term><parameter>timeout_ms</parameter>&#160;:</term>
2142
2097
<listitem><simpara> the timeout in milliseconds, or -1 to use the
2143
2098
  default
2144
2099
</simpara></listitem></varlistentry>
2145
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
2100
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
2146
2101
<listitem><simpara> called when the method call succeeds or fails;
2147
 
  may be <link linkend="NULL:CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
 
2102
  may be <link linkend="NULL--CAPS"><literal>NULL</literal></link> to make a "fire and forget" call with no 
2148
2103
  reply tracking
2149
2104
</simpara></listitem></varlistentry>
2150
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
2105
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
2151
2106
<listitem><simpara> user-supplied data passed to the callback;
2152
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
2107
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
2153
2108
</simpara></listitem></varlistentry>
2154
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
2109
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
2155
2110
<listitem><simpara> called with the user_data as argument, after the
2156
2111
  call has succeeded, failed or been cancelled;
2157
 
  must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
2112
  must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
2158
2113
</simpara></listitem></varlistentry>
2159
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
2160
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
 
2114
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
 
2115
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, a <link linkend="GObject"><type>GObject</type></link> which will be 
2161
2116
  weakly referenced; if it is destroyed, this call 
2162
 
  will automatically be cancelled. Must be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if 
2163
 
  <parameter>callback</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
2117
  will automatically be cancelled. Must be <link linkend="NULL--CAPS"><literal>NULL</literal></link> if 
 
2118
  <parameter>callback</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>
2164
2119
</simpara></listitem></varlistentry>
2165
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
 
2120
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxyPendingCall"><type>TpProxyPendingCall</type></link> representing the call in
2166
2121
 progress. It is borrowed from the object, and will become
2167
2122
 invalid when the callback is called, the call is
2168
2123
 cancelled or the <link linkend="TpProxy"><type>TpProxy</type></link> becomes invalid.
2170
2125
</variablelist></refsect2>
2171
2126
<refsect2 id="tp-cli-channel-interface-media-signalling-callback-for-get-session-handlers" role="function">
2172
2127
<title>tp_cli_channel_interface_media_signalling_callback_for_get_session_handlers ()</title>
2173
 
<indexterm zone="tp-cli-channel-interface-media-signalling-callback-for-get-session-handlers"><primary>tp_cli_channel_interface_media_signalling_callback_for_get_session_handlers</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_media_signalling_callback_for_get_session_handlers)
 
2128
<indexterm zone="tp-cli-channel-interface-media-signalling-callback-for-get-session-handlers"><primary sortas="tp_cli_channel_interface_media_signalling_callback_for_get_session_handlers">tp_cli_channel_interface_media_signalling_callback_for_get_session_handlers</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_media_signalling_callback_for_get_session_handlers)
2174
2129
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
2175
 
                                                         const <link linkend="GPtrArray">GPtrArray</link> *out0,
 
2130
                                                         const <link linkend="GPtrArray">GPtrArray</link> *out_Session_Handlers,
2176
2131
                                                         const <link linkend="GError">GError</link> *error,
2177
2132
                                                         <link linkend="gpointer">gpointer</link> user_data,
2178
2133
                                                         <link linkend="GObject">GObject</link> *weak_object);</programlisting>
2180
2135
Signature of the callback called when a GetSessionHandlers method call
2181
2136
succeeds or fails.</para>
2182
2137
<para>
2183
 
 
2184
2138
</para><variablelist role="params">
2185
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
2139
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
2186
2140
<listitem><simpara> the proxy on which the call was made
2187
2141
</simpara></listitem></varlistentry>
2188
 
<varlistentry><term><parameter>out0</parameter>&nbsp;:</term>
2189
 
<listitem><simpara> Used to return an 'out' argument if <parameter>error</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>: (Undocumented)
2190
 
</simpara></listitem></varlistentry>
2191
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
2192
 
<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link> on success, or an error on failure
2193
 
</simpara></listitem></varlistentry>
2194
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
2142
<varlistentry><term><parameter>out_Session_Handlers</parameter>&#160;:</term>
 
2143
<listitem><simpara> Used to return an 'out' argument if <parameter>error</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>: (Undocumented)
 
2144
</simpara></listitem></varlistentry>
 
2145
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
2146
<listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link> on success, or an error on failure
 
2147
</simpara></listitem></varlistentry>
 
2148
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
2195
2149
<listitem><simpara> user-supplied data
2196
2150
</simpara></listitem></varlistentry>
2197
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
2151
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
2198
2152
<listitem><simpara> user-supplied object
2199
2153
</simpara></listitem></varlistentry>
2200
2154
</variablelist></refsect2>
2201
2155
<refsect2 id="tp-cli-channel-interface-media-signalling-connect-to-new-session-handler" role="function">
2202
2156
<title>tp_cli_channel_interface_media_signalling_connect_to_new_session_handler ()</title>
2203
 
<indexterm zone="tp-cli-channel-interface-media-signalling-connect-to-new-session-handler"><primary>tp_cli_channel_interface_media_signalling_connect_to_new_session_handler</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link>* tp_cli_channel_interface_media_signalling_connect_to_new_session_handler
 
2157
<indexterm zone="tp-cli-channel-interface-media-signalling-connect-to-new-session-handler"><primary sortas="tp_cli_channel_interface_media_signalling_connect_to_new_session_handler">tp_cli_channel_interface_media_signalling_connect_to_new_session_handler</primary></indexterm><programlisting><link linkend="TpProxySignalConnection">TpProxySignalConnection</link> * tp_cli_channel_interface_media_signalling_connect_to_new_session_handler
2204
2158
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
2205
2159
                                                         <link linkend="tp-cli-channel-interface-media-signalling-signal-callback-new-session-handler">tp_cli_channel_interface_media_signalling_signal_callback_new_session_handler</link> callback,
2206
2160
                                                         <link linkend="gpointer">gpointer</link> user_data,
2213
2167
<para>
2214
2168
Signal that a session handler object has been created. The client         should create a session object and create streams for the streams         within.</para>
2215
2169
<para>
2216
 
 
2217
2170
</para><variablelist role="params">
2218
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
2171
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
2219
2172
<listitem><simpara> A <link linkend="TpChannel"><type>TpChannel</type></link> or subclass
2220
2173
</simpara></listitem></varlistentry>
2221
 
<varlistentry><term><parameter>callback</parameter>&nbsp;:</term>
 
2174
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
2222
2175
<listitem><simpara> Callback to be called when the signal is
2223
2176
  received
2224
2177
</simpara></listitem></varlistentry>
2225
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
2178
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
2226
2179
<listitem><simpara> User-supplied data for the callback
2227
2180
</simpara></listitem></varlistentry>
2228
 
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
2181
<varlistentry><term><parameter>destroy</parameter>&#160;:</term>
2229
2182
<listitem><simpara> Destructor for the user-supplied data, which
2230
2183
  will be called when this signal is disconnected, or
2231
 
  before this function returns <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
2184
  before this function returns <link linkend="NULL--CAPS"><literal>NULL</literal></link>
2232
2185
</simpara></listitem></varlistentry>
2233
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
2186
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
2234
2187
<listitem><simpara> A <link linkend="GObject"><type>GObject</type></link> which will be weakly referenced; 
2235
2188
  if it is destroyed, this callback will automatically be
2236
2189
  disconnected
2237
2190
</simpara></listitem></varlistentry>
2238
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
2239
 
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL:CAPS"><literal>NULL</literal></link> is
 
2191
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
2192
<listitem><simpara> If not <link linkend="NULL--CAPS"><literal>NULL</literal></link>, used to raise an error if <link linkend="NULL--CAPS"><literal>NULL</literal></link> is
2240
2193
  returned
2241
2194
</simpara></listitem></varlistentry>
2242
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="TpProxySignalConnection"><type>TpProxySignalConnection</type></link> containing all of the
 
2195
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="TpProxySignalConnection"><type>TpProxySignalConnection</type></link> containing all of the
2243
2196
above, which can be used to disconnect the signal; or
2244
 
<link linkend="NULL:CAPS"><literal>NULL</literal></link> if the proxy does not have the desired interface
 
2197
<link linkend="NULL--CAPS"><literal>NULL</literal></link> if the proxy does not have the desired interface
2245
2198
or has become invalid.
2246
2199
</simpara></listitem></varlistentry>
2247
2200
</variablelist></refsect2>
2248
2201
<refsect2 id="tp-cli-channel-interface-media-signalling-signal-callback-new-session-handler" role="function">
2249
2202
<title>tp_cli_channel_interface_media_signalling_signal_callback_new_session_handler ()</title>
2250
 
<indexterm zone="tp-cli-channel-interface-media-signalling-signal-callback-new-session-handler"><primary>tp_cli_channel_interface_media_signalling_signal_callback_new_session_handler</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_media_signalling_signal_callback_new_session_handler)
 
2203
<indexterm zone="tp-cli-channel-interface-media-signalling-signal-callback-new-session-handler"><primary sortas="tp_cli_channel_interface_media_signalling_signal_callback_new_session_handler">tp_cli_channel_interface_media_signalling_signal_callback_new_session_handler</primary></indexterm><programlisting><link linkend="void">void</link>                (*tp_cli_channel_interface_media_signalling_signal_callback_new_session_handler)
2251
2204
                                                        (<link linkend="TpChannel">TpChannel</link> *proxy,
2252
2205
                                                         const <link linkend="gchar">gchar</link> *arg_Session_Handler,
2253
2206
                                                         const <link linkend="gchar">gchar</link> *arg_Session_Type,
2256
2209
<para>
2257
2210
Represents the signature of a callback for the signal NewSessionHandler.</para>
2258
2211
<para>
2259
 
 
2260
2212
</para><variablelist role="params">
2261
 
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
 
2213
<varlistentry><term><parameter>proxy</parameter>&#160;:</term>
2262
2214
<listitem><simpara> The proxy on which <link linkend="tp-cli-channel-interface-media-signalling-connect-to-new-session-handler"><function>tp_cli_channel_interface_media_signalling_connect_to_new_session_handler()</function></link>
2263
2215
 was called
2264
2216
</simpara></listitem></varlistentry>
2265
 
<varlistentry><term><parameter>arg_Session_Handler</parameter>&nbsp;:</term>
2266
 
<listitem><simpara> Object path of the new MediaSessionHandler object
 
2217
<varlistentry><term><parameter>arg_Session_Handler</parameter>&#160;:</term>
 
2218
<listitem><simpara> Object path of the new &lt;tp:dbus-ref namespace=&quot;org.freedesktop.Telepathy&quot;&gt;Media.SessionHandler&lt;/tp:dbus-ref&gt;           object
2267
2219
</simpara></listitem></varlistentry>
2268
 
<varlistentry><term><parameter>arg_Session_Type</parameter>&nbsp;:</term>
 
2220
<varlistentry><term><parameter>arg_Session_Type</parameter>&#160;:</term>
2269
2221
<listitem><simpara> String indicating type of session, eg &amp;quot;rtp&amp;quot;
2270
2222
</simpara></listitem></varlistentry>
2271
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
2223
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
2272
2224
<listitem><simpara> User-supplied data
2273
2225
</simpara></listitem></varlistentry>
2274
 
<varlistentry><term><parameter>weak_object</parameter>&nbsp;:</term>
 
2226
<varlistentry><term><parameter>weak_object</parameter>&#160;:</term>
2275
2227
<listitem><simpara> User-supplied weakly referenced object
2276
2228
</simpara></listitem></varlistentry>
2277
2229
</variablelist></refsect2>