~ubuntu-branches/ubuntu/precise/telepathy-glib/precise-201202222208

« back to all changes in this revision

Viewing changes to docs/reference/html/telepathy-glib-enums.html

  • Committer: Ken VanDine
  • Date: 2012-02-22 18:08:37 UTC
  • mfrom: (1.6.39)
  • Revision ID: ken.vandine@canonical.com-20120222180837-02um6fex0eg073lf
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
137
137
#define             <a class="link" href="telepathy-glib-enums.html#NUM-TP-SASL-ABORT-REASONS:CAPS" title="NUM_TP_SASL_ABORT_REASONS">NUM_TP_SASL_ABORT_REASONS</a>
138
138
enum                <a class="link" href="telepathy-glib-enums.html#TpSASLStatus" title="enum TpSASLStatus">TpSASLStatus</a>;
139
139
#define             <a class="link" href="telepathy-glib-enums.html#NUM-TP-SASL-STATUSES:CAPS" title="NUM_TP_SASL_STATUSES">NUM_TP_SASL_STATUSES</a>
 
140
enum                <a class="link" href="telepathy-glib-enums.html#TpCaptchaStatus" title="enum TpCaptchaStatus">TpCaptchaStatus</a>;
 
141
#define             <a class="link" href="telepathy-glib-enums.html#NUM-TP-CAPTCHA-STATUSES:CAPS" title="NUM_TP_CAPTCHA_STATUSES">NUM_TP_CAPTCHA_STATUSES</a>
 
142
enum                <a class="link" href="telepathy-glib-enums.html#TpCaptchaCancelReason" title="enum TpCaptchaCancelReason">TpCaptchaCancelReason</a>;
 
143
#define             <a class="link" href="telepathy-glib-enums.html#NUM-TP-CAPTCHA-CANCEL-REASONS:CAPS" title="NUM_TP_CAPTCHA_CANCEL_REASONS">NUM_TP_CAPTCHA_CANCEL_REASONS</a>
 
144
enum                <a class="link" href="telepathy-glib-enums.html#TpCaptchaFlags" title="enum TpCaptchaFlags">TpCaptchaFlags</a>;
 
145
enum                <a class="link" href="telepathy-glib-enums.html#TpCallContentDisposition" title="enum TpCallContentDisposition">TpCallContentDisposition</a>;
 
146
#define             <a class="link" href="telepathy-glib-enums.html#NUM-TP-CALL-CONTENT-DISPOSITIONS:CAPS" title="NUM_TP_CALL_CONTENT_DISPOSITIONS">NUM_TP_CALL_CONTENT_DISPOSITIONS</a>
 
147
enum                <a class="link" href="telepathy-glib-enums.html#TpCallContentPacketizationType" title="enum TpCallContentPacketizationType">TpCallContentPacketizationType</a>;
 
148
#define             <a class="link" href="telepathy-glib-enums.html#NUM-TP-CALL-CONTENT-PACKETIZATION-TYPES:CAPS" title="NUM_TP_CALL_CONTENT_PACKETIZATION_TYPES">NUM_TP_CALL_CONTENT_PACKETIZATION_TYPES</a>
 
149
enum                <a class="link" href="telepathy-glib-enums.html#TpCallState" title="enum TpCallState">TpCallState</a>;
 
150
#define             <a class="link" href="telepathy-glib-enums.html#NUM-TP-CALL-STATES:CAPS" title="NUM_TP_CALL_STATES">NUM_TP_CALL_STATES</a>
 
151
enum                <a class="link" href="telepathy-glib-enums.html#TpCallStateChangeReason" title="enum TpCallStateChangeReason">TpCallStateChangeReason</a>;
 
152
#define             <a class="link" href="telepathy-glib-enums.html#NUM-TP-CALL-STATE-CHANGE-REASONS:CAPS" title="NUM_TP_CALL_STATE_CHANGE_REASONS">NUM_TP_CALL_STATE_CHANGE_REASONS</a>
 
153
enum                <a class="link" href="telepathy-glib-enums.html#TpCallStreamCandidateType" title="enum TpCallStreamCandidateType">TpCallStreamCandidateType</a>;
 
154
#define             <a class="link" href="telepathy-glib-enums.html#NUM-TP-CALL-STREAM-CANDIDATE-TYPES:CAPS" title="NUM_TP_CALL_STREAM_CANDIDATE_TYPES">NUM_TP_CALL_STREAM_CANDIDATE_TYPES</a>
 
155
enum                <a class="link" href="telepathy-glib-enums.html#TpRCPTXRRTTMode" title="enum TpRCPTXRRTTMode">TpRCPTXRRTTMode</a>;
 
156
#define             <a class="link" href="telepathy-glib-enums.html#NUM-TP-RCPT-XR-RTT-MODES:CAPS" title="NUM_TP_RCPT_XR_RTT_MODES">NUM_TP_RCPT_XR_RTT_MODES</a>
 
157
enum                <a class="link" href="telepathy-glib-enums.html#TpSendingState" title="enum TpSendingState">TpSendingState</a>;
 
158
#define             <a class="link" href="telepathy-glib-enums.html#NUM-TP-SENDING-STATES:CAPS" title="NUM_TP_SENDING_STATES">NUM_TP_SENDING_STATES</a>
 
159
enum                <a class="link" href="telepathy-glib-enums.html#TpStreamComponent" title="enum TpStreamComponent">TpStreamComponent</a>;
 
160
#define             <a class="link" href="telepathy-glib-enums.html#NUM-TP-STREAM-COMPONENTS:CAPS" title="NUM_TP_STREAM_COMPONENTS">NUM_TP_STREAM_COMPONENTS</a>
 
161
enum                <a class="link" href="telepathy-glib-enums.html#TpStreamEndpointState" title="enum TpStreamEndpointState">TpStreamEndpointState</a>;
 
162
#define             <a class="link" href="telepathy-glib-enums.html#NUM-TP-STREAM-ENDPOINT-STATES:CAPS" title="NUM_TP_STREAM_ENDPOINT_STATES">NUM_TP_STREAM_ENDPOINT_STATES</a>
 
163
enum                <a class="link" href="telepathy-glib-enums.html#TpStreamFlowState" title="enum TpStreamFlowState">TpStreamFlowState</a>;
 
164
#define             <a class="link" href="telepathy-glib-enums.html#NUM-TP-STREAM-FLOW-STATES:CAPS" title="NUM_TP_STREAM_FLOW_STATES">NUM_TP_STREAM_FLOW_STATES</a>
 
165
enum                <a class="link" href="telepathy-glib-enums.html#TpStreamTransportType" title="enum TpStreamTransportType">TpStreamTransportType</a>;
 
166
#define             <a class="link" href="telepathy-glib-enums.html#NUM-TP-STREAM-TRANSPORT-TYPES:CAPS" title="NUM_TP_STREAM_TRANSPORT_TYPES">NUM_TP_STREAM_TRANSPORT_TYPES</a>
 
167
enum                <a class="link" href="telepathy-glib-enums.html#TpCallFlags" title="enum TpCallFlags">TpCallFlags</a>;
 
168
enum                <a class="link" href="telepathy-glib-enums.html#TpCallMemberFlags" title="enum TpCallMemberFlags">TpCallMemberFlags</a>;
 
169
enum                <a class="link" href="telepathy-glib-enums.html#TpRTCPXRStatisticsFlags" title="enum TpRTCPXRStatisticsFlags">TpRTCPXRStatisticsFlags</a>;
140
170
</pre>
141
171
</div>
142
172
<div class="refsect1">
3128
3158
1 higher than the highest valid value of <a class="link" href="telepathy-glib-enums.html#TpSASLStatus" title="enum TpSASLStatus"><span class="type">TpSASLStatus</span></a>.
3129
3159
</p>
3130
3160
</div>
 
3161
<hr>
 
3162
<div class="refsect2">
 
3163
<a name="TpCaptchaStatus"></a><h3>enum TpCaptchaStatus</h3>
 
3164
<pre class="programlisting">typedef enum {
 
3165
    TP_CAPTCHA_STATUS_LOCAL_PENDING = 0,
 
3166
    TP_CAPTCHA_STATUS_REMOTE_PENDING = 1,
 
3167
    TP_CAPTCHA_STATUS_SUCCEEDED = 2,
 
3168
    TP_CAPTCHA_STATUS_TRY_AGAIN = 3,
 
3169
    TP_CAPTCHA_STATUS_FAILED = 4,
 
3170
} TpCaptchaStatus;
 
3171
</pre>
 
3172
<p>
 
3173
Bitfield/set of flags generated from the Telepathy specification.
 
3174
</p>
 
3175
<div class="variablelist"><table border="0">
 
3176
<col align="left" valign="top">
 
3177
<tbody>
 
3178
<tr>
 
3179
<td><p><a name="TP-CAPTCHA-STATUS-LOCAL-PENDING:CAPS"></a><span class="term"><code class="literal">TP_CAPTCHA_STATUS_LOCAL_PENDING</code></span></p></td>
 
3180
<td>           The challenge/response exchange is in progress and waiting for           a local action. Call AnswerCaptchas           to go to the Remote_Pending state, or call           CancelCaptcha followed by            Close           to give up.         
 
3181
</td>
 
3182
</tr>
 
3183
<tr>
 
3184
<td><p><a name="TP-CAPTCHA-STATUS-REMOTE-PENDING:CAPS"></a><span class="term"><code class="literal">TP_CAPTCHA_STATUS_REMOTE_PENDING</code></span></p></td>
 
3185
<td>           The challenge/response exchange is in progress and waiting for           a response from the server. Wait for a reply from the server,           which will result in the Succeeded, Try_Again, or Failed state,           or call CancelCaptcha followed by           Close           to give up.         
 
3186
</td>
 
3187
</tr>
 
3188
<tr>
 
3189
<td><p><a name="TP-CAPTCHA-STATUS-SUCCEEDED:CAPS"></a><span class="term"><code class="literal">TP_CAPTCHA_STATUS_SUCCEEDED</code></span></p></td>
 
3190
<td>           Everyone is happy. Connection to the server will proceed as soon as           this state is reached. There is nothing useful to do in this state           except to call Close           to close the channel.         
 
3191
</td>
 
3192
</tr>
 
3193
<tr>
 
3194
<td><p><a name="TP-CAPTCHA-STATUS-TRY-AGAIN:CAPS"></a><span class="term"><code class="literal">TP_CAPTCHA_STATUS_TRY_AGAIN</code></span></p></td>
 
3195
<td>           The server has indicated an authentication failure.           Call GetCaptchas again to get           a new captcha, or           CancelCaptcha followed by           Close           to give up.         
 
3196
</td>
 
3197
</tr>
 
3198
<tr>
 
3199
<td><p><a name="TP-CAPTCHA-STATUS-FAILED:CAPS"></a><span class="term"><code class="literal">TP_CAPTCHA_STATUS_FAILED</code></span></p></td>
 
3200
<td>           Authentication has failed in some way. There is nothing           useful to do in this state except to close the channel with           Close.         
 
3201
</td>
 
3202
</tr>
 
3203
</tbody>
 
3204
</table></div>
 
3205
</div>
 
3206
<hr>
 
3207
<div class="refsect2">
 
3208
<a name="NUM-TP-CAPTCHA-STATUSES:CAPS"></a><h3>NUM_TP_CAPTCHA_STATUSES</h3>
 
3209
<pre class="programlisting">#define NUM_TP_CAPTCHA_STATUSES (4+1)
 
3210
</pre>
 
3211
<p>
 
3212
1 higher than the highest valid value of <a class="link" href="telepathy-glib-enums.html#TpCaptchaStatus" title="enum TpCaptchaStatus"><span class="type">TpCaptchaStatus</span></a>.
 
3213
</p>
 
3214
</div>
 
3215
<hr>
 
3216
<div class="refsect2">
 
3217
<a name="TpCaptchaCancelReason"></a><h3>enum TpCaptchaCancelReason</h3>
 
3218
<pre class="programlisting">typedef enum {
 
3219
    TP_CAPTCHA_CANCEL_REASON_USER_CANCELLED = 0,
 
3220
    TP_CAPTCHA_CANCEL_REASON_NOT_SUPPORTED = 1,
 
3221
    TP_CAPTCHA_CANCEL_REASON_SERVICE_CONFUSED = 2,
 
3222
} TpCaptchaCancelReason;
 
3223
</pre>
 
3224
<p>
 
3225
         A reason why captcha authentication was aborted by the client.       
 
3226
</p>
 
3227
<p>
 
3228
Bitfield/set of flags generated from the Telepathy specification.
 
3229
</p>
 
3230
<div class="variablelist"><table border="0">
 
3231
<col align="left" valign="top">
 
3232
<tbody>
 
3233
<tr>
 
3234
<td><p><a name="TP-CAPTCHA-CANCEL-REASON-USER-CANCELLED:CAPS"></a><span class="term"><code class="literal">TP_CAPTCHA_CANCEL_REASON_USER_CANCELLED</code></span></p></td>
 
3235
<td>           The user aborted the authentication. If this is used, the           CaptchaError SHOULD be set to           Cancelled         
 
3236
</td>
 
3237
</tr>
 
3238
<tr>
 
3239
<td><p><a name="TP-CAPTCHA-CANCEL-REASON-NOT-SUPPORTED:CAPS"></a><span class="term"><code class="literal">TP_CAPTCHA_CANCEL_REASON_NOT_SUPPORTED</code></span></p></td>
 
3240
<td>           The Handler doesn't support the given/required captcha types.           If this is used, the CaptchaError           SHOULD be set to CaptchaNotSupported.           This SHOULD also be used if           Close is called           before CancelCaptcha.                        If no Handler supports captcha channels,             the ChannelDispatcher will just call             Close,             because it has no knowledge of specific channel types.                    
 
3241
</td>
 
3242
</tr>
 
3243
<tr>
 
3244
<td><p><a name="TP-CAPTCHA-CANCEL-REASON-SERVICE-CONFUSED:CAPS"></a><span class="term"><code class="literal">TP_CAPTCHA_CANCEL_REASON_SERVICE_CONFUSED</code></span></p></td>
 
3245
<td>           The Handler doesn't understand the captcha data received. The           challenger may be sending gibberish.           If this is used, the CaptchaError           SHOULD be set to ServiceConfused.         
 
3246
</td>
 
3247
</tr>
 
3248
</tbody>
 
3249
</table></div>
 
3250
</div>
 
3251
<hr>
 
3252
<div class="refsect2">
 
3253
<a name="NUM-TP-CAPTCHA-CANCEL-REASONS:CAPS"></a><h3>NUM_TP_CAPTCHA_CANCEL_REASONS</h3>
 
3254
<pre class="programlisting">#define NUM_TP_CAPTCHA_CANCEL_REASONS (2+1)
 
3255
</pre>
 
3256
<p>
 
3257
1 higher than the highest valid value of <a class="link" href="telepathy-glib-enums.html#TpCaptchaCancelReason" title="enum TpCaptchaCancelReason"><span class="type">TpCaptchaCancelReason</span></a>.
 
3258
</p>
 
3259
</div>
 
3260
<hr>
 
3261
<div class="refsect2">
 
3262
<a name="TpCaptchaFlags"></a><h3>enum TpCaptchaFlags</h3>
 
3263
<pre class="programlisting">typedef enum {
 
3264
    TP_CAPTCHA_FLAGS_REQUIRED = 1,
 
3265
} TpCaptchaFlags;
 
3266
</pre>
 
3267
<p>
 
3268
         Extra flags to include with Captcha information       
 
3269
</p>
 
3270
<p>
 
3271
Bitfield/set of flags generated from the Telepathy specification.
 
3272
</p>
 
3273
<div class="variablelist"><table border="0">
 
3274
<col align="left" valign="top">
 
3275
<tbody><tr>
 
3276
<td><p><a name="TP-CAPTCHA-FLAGS-REQUIRED:CAPS"></a><span class="term"><code class="literal">TP_CAPTCHA_FLAGS_REQUIRED</code></span></p></td>
 
3277
<td>           This captcha mechanism is required to be successfully           answered in order to pass this captcha challenge.         
 
3278
</td>
 
3279
</tr></tbody>
 
3280
</table></div>
 
3281
</div>
 
3282
<hr>
 
3283
<div class="refsect2">
 
3284
<a name="TpCallContentDisposition"></a><h3>enum TpCallContentDisposition</h3>
 
3285
<pre class="programlisting">typedef enum {
 
3286
    TP_CALL_CONTENT_DISPOSITION_NONE = 0,
 
3287
    TP_CALL_CONTENT_DISPOSITION_INITIAL = 1,
 
3288
} TpCallContentDisposition;
 
3289
</pre>
 
3290
<p>
 
3291
         The disposition of this content, which defines whether to         automatically start sending data on the streams when         Accept is         called on the channel.       
 
3292
</p>
 
3293
<p>
 
3294
Bitfield/set of flags generated from the Telepathy specification.
 
3295
</p>
 
3296
<div class="variablelist"><table border="0">
 
3297
<col align="left" valign="top">
 
3298
<tbody>
 
3299
<tr>
 
3300
<td><p><a name="TP-CALL-CONTENT-DISPOSITION-NONE:CAPS"></a><span class="term"><code class="literal">TP_CALL_CONTENT_DISPOSITION_NONE</code></span></p></td>
 
3301
<td>           The content has no specific disposition.         
 
3302
</td>
 
3303
</tr>
 
3304
<tr>
 
3305
<td><p><a name="TP-CALL-CONTENT-DISPOSITION-INITIAL:CAPS"></a><span class="term"><code class="literal">TP_CALL_CONTENT_DISPOSITION_INITIAL</code></span></p></td>
 
3306
<td>           The content was initially part of the call. When           Accept           is called on the channel, all streams of this content with           LocalSendingState           set to Pending_Send will be           moved to Sending as if           SetSending           (True) had been called.         
 
3307
</td>
 
3308
</tr>
 
3309
</tbody>
 
3310
</table></div>
 
3311
</div>
 
3312
<hr>
 
3313
<div class="refsect2">
 
3314
<a name="NUM-TP-CALL-CONTENT-DISPOSITIONS:CAPS"></a><h3>NUM_TP_CALL_CONTENT_DISPOSITIONS</h3>
 
3315
<pre class="programlisting">#define NUM_TP_CALL_CONTENT_DISPOSITIONS (1+1)
 
3316
</pre>
 
3317
<p>
 
3318
1 higher than the highest valid value of <a class="link" href="telepathy-glib-enums.html#TpCallContentDisposition" title="enum TpCallContentDisposition"><span class="type">TpCallContentDisposition</span></a>.
 
3319
</p>
 
3320
</div>
 
3321
<hr>
 
3322
<div class="refsect2">
 
3323
<a name="TpCallContentPacketizationType"></a><h3>enum TpCallContentPacketizationType</h3>
 
3324
<pre class="programlisting">typedef enum {
 
3325
    TP_CALL_CONTENT_PACKETIZATION_TYPE_RTP = 0,
 
3326
    TP_CALL_CONTENT_PACKETIZATION_TYPE_RAW = 1,
 
3327
    TP_CALL_CONTENT_PACKETIZATION_TYPE_MSN_WEBCAM = 2,
 
3328
} TpCallContentPacketizationType;
 
3329
</pre>
 
3330
<p>
 
3331
         A packetization method that can be used for a content.       
 
3332
</p>
 
3333
<p>
 
3334
Bitfield/set of flags generated from the Telepathy specification.
 
3335
</p>
 
3336
<div class="variablelist"><table border="0">
 
3337
<col align="left" valign="top">
 
3338
<tbody>
 
3339
<tr>
 
3340
<td><p><a name="TP-CALL-CONTENT-PACKETIZATION-TYPE-RTP:CAPS"></a><span class="term"><code class="literal">TP_CALL_CONTENT_PACKETIZATION_TYPE_RTP</code></span></p></td>
 
3341
<td>           Real-time Transport Protocol, as documented by RFC 3550.         
 
3342
</td>
 
3343
</tr>
 
3344
<tr>
 
3345
<td><p><a name="TP-CALL-CONTENT-PACKETIZATION-TYPE-RAW:CAPS"></a><span class="term"><code class="literal">TP_CALL_CONTENT_PACKETIZATION_TYPE_RAW</code></span></p></td>
 
3346
<td>           Raw media.         
 
3347
</td>
 
3348
</tr>
 
3349
<tr>
 
3350
<td><p><a name="TP-CALL-CONTENT-PACKETIZATION-TYPE-MSN-WEBCAM:CAPS"></a><span class="term"><code class="literal">TP_CALL_CONTENT_PACKETIZATION_TYPE_MSN_WEBCAM</code></span></p></td>
 
3351
<td>           MSN webcam. This is the video-only one-way type which was           used in earlier versions of WLM. Although no longer used,           modern WLM clients still support the MSN webcam protocol.         
 
3352
</td>
 
3353
</tr>
 
3354
</tbody>
 
3355
</table></div>
 
3356
</div>
 
3357
<hr>
 
3358
<div class="refsect2">
 
3359
<a name="NUM-TP-CALL-CONTENT-PACKETIZATION-TYPES:CAPS"></a><h3>NUM_TP_CALL_CONTENT_PACKETIZATION_TYPES</h3>
 
3360
<pre class="programlisting">#define NUM_TP_CALL_CONTENT_PACKETIZATION_TYPES (2+1)
 
3361
</pre>
 
3362
<p>
 
3363
1 higher than the highest valid value of <a class="link" href="telepathy-glib-enums.html#TpCallContentPacketizationType" title="enum TpCallContentPacketizationType"><span class="type">TpCallContentPacketizationType</span></a>.
 
3364
</p>
 
3365
</div>
 
3366
<hr>
 
3367
<div class="refsect2">
 
3368
<a name="TpCallState"></a><h3>enum TpCallState</h3>
 
3369
<pre class="programlisting">typedef enum {
 
3370
    TP_CALL_STATE_UNKNOWN = 0,
 
3371
    TP_CALL_STATE_PENDING_INITIATOR = 1,
 
3372
    TP_CALL_STATE_INITIALISING = 2,
 
3373
    TP_CALL_STATE_INITIALISED = 3,
 
3374
    TP_CALL_STATE_ACCEPTED = 4,
 
3375
    TP_CALL_STATE_ACTIVE = 5,
 
3376
    TP_CALL_STATE_ENDED = 6,
 
3377
} TpCallState;
 
3378
</pre>
 
3379
<p>
 
3380
         The state of a call, as a whole.          The allowed transitions are:                     Pending_Initiator → Initialising (for outgoing calls,             when Accept is called)           Initialising → Initialised (for outgoing calls, when             the remote client indicates that the user has been notified about             the call. If the network is known not to provide feedback about whether             the remote side is ringing, then the call should immediately be             set to Ringing.           Initialising → Initialised (for incoming calls, when e.g. the             implementation has been initialised far enough that it is sensible             to notify the user about the call (to reduce the probability that             the user will pick up the call and have it immediately fail).             The UI should then alert the user about the call, and call             SetRinging)           Initialised → Accepted (for outgoing calls to a contact,             when the remote contact accepts the call; for incoming calls, when             Accept is called.)           Accepted → Active (when the local user successfully             joins the call/conference, and media is known to be flowing             successfully; also, when temporary connection problems are             resolved (See below)). If the network is known not to provide             feedback about when the call is properly connected, the call             should immediately be set to Active.           Active → Accepted (when there are temporary connection problems             that the CM is aware of and able to recover from)           any state → Ended (when the call is terminated             normally, or when an error occurs that the CM is unable to recover             from)                   Clients MAY consider unknown values from this enum to be an           error - additional values will not be defined after the Call           specification is declared to be stable.       
 
3381
</p>
 
3382
<p>
 
3383
Bitfield/set of flags generated from the Telepathy specification.
 
3384
</p>
 
3385
<div class="variablelist"><table border="0">
 
3386
<col align="left" valign="top">
 
3387
<tbody>
 
3388
<tr>
 
3389
<td><p><a name="TP-CALL-STATE-UNKNOWN:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_UNKNOWN</code></span></p></td>
 
3390
<td>           The call state is not known. This call state MUST NOT appear as a           value of the CallState property, but           MAY be used by client code to represent calls whose state is as yet           unknown.         
 
3391
</td>
 
3392
</tr>
 
3393
<tr>
 
3394
<td><p><a name="TP-CALL-STATE-PENDING-INITIATOR:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_PENDING_INITIATOR</code></span></p></td>
 
3395
<td>           The initiator of the call hasn't accepted the call yet. This state           only makes sense for outgoing calls, where it means that the local           user has not yet sent any signalling messages to the remote user(s),           and will not do so until Accept is           called.         
 
3396
</td>
 
3397
</tr>
 
3398
<tr>
 
3399
<td><p><a name="TP-CALL-STATE-INITIALISING:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_INITIALISING</code></span></p></td>
 
3400
<td>           Progress has been made in placing the call, but the           contact has not been made aware of the call yet. This corresponds to SIP's           status code 183 Session Progress, and should be used for the period           where the CM is waiting for the streaming implementation to           initialise (before sending the initial INVITE or equivalent) and when the           outgoing call has reached a gateway or ICE negotiation is pending.           UIs should not produce a dialtone or start ringing if the call is in           this state.         
 
3401
</td>
 
3402
</tr>
 
3403
<tr>
 
3404
<td><p><a name="TP-CALL-STATE-INITIALISED:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_INITIALISED</code></span></p></td>
 
3405
<td>           In the outgoing case: at least one called user has been alerted           about the call (a SIP 180 (Ringing) packet or equivalent has been           received) but none have answered, so the call cannot go to Accepted           (use Ringing to determine which           members have been informed and which haven't, if you care). UIs           SHOULD produce a dialtone for outgoing calls in this state.            In the incoming case, the local user should be informed of the call           as soon as the call reaches this state (and           SetRinging should be called           to inform the CM that this has happened, so that it can relay this           fact to the caller using a SIP 180 (Ringing) packet or equivalent).         
 
3406
</td>
 
3407
</tr>
 
3408
<tr>
 
3409
<td><p><a name="TP-CALL-STATE-ACCEPTED:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_ACCEPTED</code></span></p></td>
 
3410
<td>           The contact being called has accepted the call, but the call is not           in the Active state (The most common reason for this is that the           streaming implementation hasn't connected yet).         
 
3411
</td>
 
3412
</tr>
 
3413
<tr>
 
3414
<td><p><a name="TP-CALL-STATE-ACTIVE:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_ACTIVE</code></span></p></td>
 
3415
<td>           The contact being called has accepted the call, and discourse between           at least two parties should now be possible.         
 
3416
</td>
 
3417
</tr>
 
3418
<tr>
 
3419
<td><p><a name="TP-CALL-STATE-ENDED:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_ENDED</code></span></p></td>
 
3420
<td>           The call has ended, either via normal termination or an error.         
 
3421
</td>
 
3422
</tr>
 
3423
</tbody>
 
3424
</table></div>
 
3425
</div>
 
3426
<hr>
 
3427
<div class="refsect2">
 
3428
<a name="NUM-TP-CALL-STATES:CAPS"></a><h3>NUM_TP_CALL_STATES</h3>
 
3429
<pre class="programlisting">#define NUM_TP_CALL_STATES (6+1)
 
3430
</pre>
 
3431
<p>
 
3432
1 higher than the highest valid value of <a class="link" href="telepathy-glib-enums.html#TpCallState" title="enum TpCallState"><span class="type">TpCallState</span></a>.
 
3433
</p>
 
3434
</div>
 
3435
<hr>
 
3436
<div class="refsect2">
 
3437
<a name="TpCallStateChangeReason"></a><h3>enum TpCallStateChangeReason</h3>
 
3438
<pre class="programlisting">typedef enum {
 
3439
    TP_CALL_STATE_CHANGE_REASON_UNKNOWN = 0,
 
3440
    TP_CALL_STATE_CHANGE_REASON_PROGRESS_MADE = 1,
 
3441
    TP_CALL_STATE_CHANGE_REASON_USER_REQUESTED = 2,
 
3442
    TP_CALL_STATE_CHANGE_REASON_FORWARDED = 3,
 
3443
    TP_CALL_STATE_CHANGE_REASON_REJECTED = 4,
 
3444
    TP_CALL_STATE_CHANGE_REASON_NO_ANSWER = 5,
 
3445
    TP_CALL_STATE_CHANGE_REASON_INVALID_CONTACT = 6,
 
3446
    TP_CALL_STATE_CHANGE_REASON_PERMISSION_DENIED = 7,
 
3447
    TP_CALL_STATE_CHANGE_REASON_BUSY = 8,
 
3448
    TP_CALL_STATE_CHANGE_REASON_INTERNAL_ERROR = 9,
 
3449
    TP_CALL_STATE_CHANGE_REASON_SERVICE_ERROR = 10,
 
3450
    TP_CALL_STATE_CHANGE_REASON_NETWORK_ERROR = 11,
 
3451
    TP_CALL_STATE_CHANGE_REASON_MEDIA_ERROR = 12,
 
3452
    TP_CALL_STATE_CHANGE_REASON_CONNECTIVITY_ERROR = 13,
 
3453
} TpCallStateChangeReason;
 
3454
</pre>
 
3455
<p>
 
3456
         A simple representation of the reason for a change in the call's         state, which may be used by simple clients, or used as a fallback         when the DBus_Reason member of a Call_State_Reason         struct is not understood.       
 
3457
</p>
 
3458
<p>
 
3459
Bitfield/set of flags generated from the Telepathy specification.
 
3460
</p>
 
3461
<div class="variablelist"><table border="0">
 
3462
<col align="left" valign="top">
 
3463
<tbody>
 
3464
<tr>
 
3465
<td><p><a name="TP-CALL-STATE-CHANGE-REASON-UNKNOWN:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_CHANGE_REASON_UNKNOWN</code></span></p></td>
 
3466
<td>           We just don't know. Unknown values of this enum SHOULD also be           treated like this.         
 
3467
</td>
 
3468
</tr>
 
3469
<tr>
 
3470
<td><p><a name="TP-CALL-STATE-CHANGE-REASON-PROGRESS-MADE:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_CHANGE_REASON_PROGRESS_MADE</code></span></p></td>
 
3471
<td>           Situation normal. Progress has been made in the setup/teardown of           the call (and it didn't require any user interaction).         
 
3472
</td>
 
3473
</tr>
 
3474
<tr>
 
3475
<td><p><a name="TP-CALL-STATE-CHANGE-REASON-USER-REQUESTED:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_CHANGE_REASON_USER_REQUESTED</code></span></p></td>
 
3476
<td>           The change was requested by the contact indicated by the Actor             member of a Call_State_Reason struct.            If the Actor is the local user, the DBus_Reason SHOULD be the             empty string.            If the Actor is a remote user, the DBus_Reason SHOULD be the empty             string if the call was terminated normally, but MAY be a non-empty             error name to indicate error-like call termination reasons (call             rejected as busy, kicked from a conference by a moderator, etc.).         
 
3477
</td>
 
3478
</tr>
 
3479
<tr>
 
3480
<td><p><a name="TP-CALL-STATE-CHANGE-REASON-FORWARDED:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_CHANGE_REASON_FORWARDED</code></span></p></td>
 
3481
<td>           The call was forwarded. If known, the handle of the           contact the call was forwarded to will be indicated by the           "forwarded-to" member of a           CallStateDetails dictionnary           in the CallStateChanged           signal.         
 
3482
</td>
 
3483
</tr>
 
3484
<tr>
 
3485
<td><p><a name="TP-CALL-STATE-CHANGE-REASON-REJECTED:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_CHANGE_REASON_REJECTED</code></span></p></td>
 
3486
<td>           The CallState changed from             Initialised or             Ended (or a content's direction             changed) because it was rejected by the remote user.           Corresponds to Rejected         
 
3487
</td>
 
3488
</tr>
 
3489
<tr>
 
3490
<td><p><a name="TP-CALL-STATE-CHANGE-REASON-NO-ANSWER:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_CHANGE_REASON_NO_ANSWER</code></span></p></td>
 
3491
<td>           The CallState changed from             Initialised or             Ended because the initiator             ended the call before the receiver accepted it. With an             incoming call this state change reason signifies a missed             call, or one that was picked up elsewhere before it was             picked up here.           Corresponds to NoAnswer or             PickedUpElsewhere         
 
3492
</td>
 
3493
</tr>
 
3494
<tr>
 
3495
<td><p><a name="TP-CALL-STATE-CHANGE-REASON-INVALID-CONTACT:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_CHANGE_REASON_INVALID_CONTACT</code></span></p></td>
 
3496
<td>           The CallState changed because one             of the addresses does not exist on the network.           Corresponds to DoesNotExist         
 
3497
</td>
 
3498
</tr>
 
3499
<tr>
 
3500
<td><p><a name="TP-CALL-STATE-CHANGE-REASON-PERMISSION-DENIED:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_CHANGE_REASON_PERMISSION_DENIED</code></span></p></td>
 
3501
<td>           The CallState changed because the           local user is not authorised.           Corresponds to PermissionDenied or             InsufficientBalance                      
 
3502
</td>
 
3503
</tr>
 
3504
<tr>
 
3505
<td><p><a name="TP-CALL-STATE-CHANGE-REASON-BUSY:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_CHANGE_REASON_BUSY</code></span></p></td>
 
3506
<td>           The CallState changed from             Initialised             Ended because the receiver is busy             (e.g. is already engaged in another call, and has not placed the             initiator in a call-waiting queue).           Corresponds to Busy         
 
3507
</td>
 
3508
</tr>
 
3509
<tr>
 
3510
<td><p><a name="TP-CALL-STATE-CHANGE-REASON-INTERNAL-ERROR:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_CHANGE_REASON_INTERNAL_ERROR</code></span></p></td>
 
3511
<td>           There has been an unexpected error in either the CM or some other             local component.           Corresponds to Confused or           Media.StreamingError                    
 
3512
</td>
 
3513
</tr>
 
3514
<tr>
 
3515
<td><p><a name="TP-CALL-STATE-CHANGE-REASON-SERVICE-ERROR:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_CHANGE_REASON_SERVICE_ERROR</code></span></p></td>
 
3516
<td>           There has been an unexpected error in the server or some other             remote component.           Corresponds to             ServiceConfused                    
 
3517
</td>
 
3518
</tr>
 
3519
<tr>
 
3520
<td><p><a name="TP-CALL-STATE-CHANGE-REASON-NETWORK-ERROR:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_CHANGE_REASON_NETWORK_ERROR</code></span></p></td>
 
3521
<td>           There has been a network error related to the CM or the             signalling part of the call (compare and contrast:             Streaming_Error).           Corresponds to             NetworkError         
 
3522
</td>
 
3523
</tr>
 
3524
<tr>
 
3525
<td><p><a name="TP-CALL-STATE-CHANGE-REASON-MEDIA-ERROR:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_CHANGE_REASON_MEDIA_ERROR</code></span></p></td>
 
3526
<td>           Some aspect of the content is unsupported so has to be             removed from the call.           Corresponds to Media.UnsupportedType             or Media.CodecsIncompatible                    
 
3527
</td>
 
3528
</tr>
 
3529
<tr>
 
3530
<td><p><a name="TP-CALL-STATE-CHANGE-REASON-CONNECTIVITY-ERROR:CAPS"></a><span class="term"><code class="literal">TP_CALL_STATE_CHANGE_REASON_CONNECTIVITY_ERROR</code></span></p></td>
 
3531
<td>           It was not possible for the streaming implementation to connect             to any of the users participating in this call or content.           Corresponds to ConnectionFailed or             ConnectionLost         
 
3532
</td>
 
3533
</tr>
 
3534
</tbody>
 
3535
</table></div>
 
3536
</div>
 
3537
<hr>
 
3538
<div class="refsect2">
 
3539
<a name="NUM-TP-CALL-STATE-CHANGE-REASONS:CAPS"></a><h3>NUM_TP_CALL_STATE_CHANGE_REASONS</h3>
 
3540
<pre class="programlisting">#define NUM_TP_CALL_STATE_CHANGE_REASONS (13+1)
 
3541
</pre>
 
3542
<p>
 
3543
1 higher than the highest valid value of <a class="link" href="telepathy-glib-enums.html#TpCallStateChangeReason" title="enum TpCallStateChangeReason"><span class="type">TpCallStateChangeReason</span></a>.
 
3544
</p>
 
3545
</div>
 
3546
<hr>
 
3547
<div class="refsect2">
 
3548
<a name="TpCallStreamCandidateType"></a><h3>enum TpCallStreamCandidateType</h3>
 
3549
<pre class="programlisting">typedef enum {
 
3550
    TP_CALL_STREAM_CANDIDATE_TYPE_NONE = 0,
 
3551
    TP_CALL_STREAM_CANDIDATE_TYPE_HOST = 1,
 
3552
    TP_CALL_STREAM_CANDIDATE_TYPE_SERVER_REFLEXIVE = 2,
 
3553
    TP_CALL_STREAM_CANDIDATE_TYPE_PEER_REFLEXIVE = 3,
 
3554
    TP_CALL_STREAM_CANDIDATE_TYPE_RELAY = 4,
 
3555
    TP_CALL_STREAM_CANDIDATE_TYPE_MULTICAST = 5,
 
3556
} TpCallStreamCandidateType;
 
3557
</pre>
 
3558
<p>
 
3559
         The network topology that an IP candidate represents. This can         sometimes be used to infer what kind of performance characteristics         (latency, bandwith, etc) can be expected of connections made to this         candidate.       
 
3560
</p>
 
3561
<p>
 
3562
Bitfield/set of flags generated from the Telepathy specification.
 
3563
</p>
 
3564
<div class="variablelist"><table border="0">
 
3565
<col align="left" valign="top">
 
3566
<tbody>
 
3567
<tr>
 
3568
<td><p><a name="TP-CALL-STREAM-CANDIDATE-TYPE-NONE:CAPS"></a><span class="term"><code class="literal">TP_CALL_STREAM_CANDIDATE_TYPE_NONE</code></span></p></td>
 
3569
<td>           This is not an IP candidate. This is a reserved value, and should           not be seen on the bus.         
 
3570
</td>
 
3571
</tr>
 
3572
<tr>
 
3573
<td><p><a name="TP-CALL-STREAM-CANDIDATE-TYPE-HOST:CAPS"></a><span class="term"><code class="literal">TP_CALL_STREAM_CANDIDATE_TYPE_HOST</code></span></p></td>
 
3574
<td>           This candidate represents a direct connection to the host, as its           address is taken directly the host's IP stack.         
 
3575
</td>
 
3576
</tr>
 
3577
<tr>
 
3578
<td><p><a name="TP-CALL-STREAM-CANDIDATE-TYPE-SERVER-REFLEXIVE:CAPS"></a><span class="term"><code class="literal">TP_CALL_STREAM_CANDIDATE_TYPE_SERVER_REFLEXIVE</code></span></p></td>
 
3579
<td>           This candidate probably represents a connection to the host through           a NAT device, as its address was discovered by sending a binding           request to a STUN server or similar.         
 
3580
</td>
 
3581
</tr>
 
3582
<tr>
 
3583
<td><p><a name="TP-CALL-STREAM-CANDIDATE-TYPE-PEER-REFLEXIVE:CAPS"></a><span class="term"><code class="literal">TP_CALL_STREAM_CANDIDATE_TYPE_PEER_REFLEXIVE</code></span></p></td>
 
3584
<td>           This candidate probably represents a good route between the host and           its peer, as its address was discovered by sending a STUN binding           request to one of the candidates advertised by the peer.         
 
3585
</td>
 
3586
</tr>
 
3587
<tr>
 
3588
<td><p><a name="TP-CALL-STREAM-CANDIDATE-TYPE-RELAY:CAPS"></a><span class="term"><code class="literal">TP_CALL_STREAM_CANDIDATE_TYPE_RELAY</code></span></p></td>
 
3589
<td>           This candidate represents the address of a relay server (usually           somewhere on the public internet). This candidate is the most likely           to work, but all media will go via a relay server, so latency is           likely to be higher than other types of candidate.         
 
3590
</td>
 
3591
</tr>
 
3592
<tr>
 
3593
<td><p><a name="TP-CALL-STREAM-CANDIDATE-TYPE-MULTICAST:CAPS"></a><span class="term"><code class="literal">TP_CALL_STREAM_CANDIDATE_TYPE_MULTICAST</code></span></p></td>
 
3594
<td>           This candidate represents a Multicast group. This value should only           appear if the Stream's Transport is           set to Multicast.         
 
3595
</td>
 
3596
</tr>
 
3597
</tbody>
 
3598
</table></div>
 
3599
</div>
 
3600
<hr>
 
3601
<div class="refsect2">
 
3602
<a name="NUM-TP-CALL-STREAM-CANDIDATE-TYPES:CAPS"></a><h3>NUM_TP_CALL_STREAM_CANDIDATE_TYPES</h3>
 
3603
<pre class="programlisting">#define NUM_TP_CALL_STREAM_CANDIDATE_TYPES (5+1)
 
3604
</pre>
 
3605
<p>
 
3606
1 higher than the highest valid value of <a class="link" href="telepathy-glib-enums.html#TpCallStreamCandidateType" title="enum TpCallStreamCandidateType"><span class="type">TpCallStreamCandidateType</span></a>.
 
3607
</p>
 
3608
</div>
 
3609
<hr>
 
3610
<div class="refsect2">
 
3611
<a name="TpRCPTXRRTTMode"></a><h3>enum TpRCPTXRRTTMode</h3>
 
3612
<pre class="programlisting">typedef enum {
 
3613
    TP_RCPT_XR_RTT_MODE_ALL = 0,
 
3614
    TP_RCPT_XR_RTT_MODE_SENDER = 1,
 
3615
} TpRCPTXRRTTMode;
 
3616
</pre>
 
3617
<p>
 
3618
Bitfield/set of flags generated from the Telepathy specification.
 
3619
</p>
 
3620
<div class="variablelist"><table border="0">
 
3621
<col align="left" valign="top">
 
3622
<tbody>
 
3623
<tr>
 
3624
<td><p><a name="TP-RCPT-XR-RTT-MODE-ALL:CAPS"></a><span class="term"><code class="literal">TP_RCPT_XR_RTT_MODE_ALL</code></span></p></td>
 
3625
<td>           Both RTP data senders and data receivers MAY send DLRR           blocks.         
 
3626
</td>
 
3627
</tr>
 
3628
<tr>
 
3629
<td><p><a name="TP-RCPT-XR-RTT-MODE-SENDER:CAPS"></a><span class="term"><code class="literal">TP_RCPT_XR_RTT_MODE_SENDER</code></span></p></td>
 
3630
<td>           Only active RTP senders MAY send DLRR blocks, i.e., non RTP           senders SHALL NOT send DLRR blocks.         
 
3631
</td>
 
3632
</tr>
 
3633
</tbody>
 
3634
</table></div>
 
3635
</div>
 
3636
<hr>
 
3637
<div class="refsect2">
 
3638
<a name="NUM-TP-RCPT-XR-RTT-MODES:CAPS"></a><h3>NUM_TP_RCPT_XR_RTT_MODES</h3>
 
3639
<pre class="programlisting">#define NUM_TP_RCPT_XR_RTT_MODES (1+1)
 
3640
</pre>
 
3641
<p>
 
3642
1 higher than the highest valid value of <a class="link" href="telepathy-glib-enums.html#TpRCPTXRRTTMode" title="enum TpRCPTXRRTTMode"><span class="type">TpRCPTXRRTTMode</span></a>.
 
3643
</p>
 
3644
</div>
 
3645
<hr>
 
3646
<div class="refsect2">
 
3647
<a name="TpSendingState"></a><h3>enum TpSendingState</h3>
 
3648
<pre class="programlisting">typedef enum {
 
3649
    TP_SENDING_STATE_NONE = 0,
 
3650
    TP_SENDING_STATE_PENDING_SEND = 1,
 
3651
    TP_SENDING_STATE_SENDING = 2,
 
3652
    TP_SENDING_STATE_PENDING_STOP_SENDING = 3,
 
3653
} TpSendingState;
 
3654
</pre>
 
3655
<p>
 
3656
         Enum indicating whether a contact is sending media.       
 
3657
</p>
 
3658
<p>
 
3659
Bitfield/set of flags generated from the Telepathy specification.
 
3660
</p>
 
3661
<div class="variablelist"><table border="0">
 
3662
<col align="left" valign="top">
 
3663
<tbody>
 
3664
<tr>
 
3665
<td><p><a name="TP-SENDING-STATE-NONE:CAPS"></a><span class="term"><code class="literal">TP_SENDING_STATE_NONE</code></span></p></td>
 
3666
<td>           The contact is not sending media and has not been asked to           do so.         
 
3667
</td>
 
3668
</tr>
 
3669
<tr>
 
3670
<td><p><a name="TP-SENDING-STATE-PENDING-SEND:CAPS"></a><span class="term"><code class="literal">TP_SENDING_STATE_PENDING_SEND</code></span></p></td>
 
3671
<td>           The contact has been asked to start sending media.         
 
3672
</td>
 
3673
</tr>
 
3674
<tr>
 
3675
<td><p><a name="TP-SENDING-STATE-SENDING:CAPS"></a><span class="term"><code class="literal">TP_SENDING_STATE_SENDING</code></span></p></td>
 
3676
<td>           The contact is sending media.         
 
3677
</td>
 
3678
</tr>
 
3679
<tr>
 
3680
<td><p><a name="TP-SENDING-STATE-PENDING-STOP-SENDING:CAPS"></a><span class="term"><code class="literal">TP_SENDING_STATE_PENDING_STOP_SENDING</code></span></p></td>
 
3681
<td>           The contact has been asked to stop sending media.         
 
3682
</td>
 
3683
</tr>
 
3684
</tbody>
 
3685
</table></div>
 
3686
</div>
 
3687
<hr>
 
3688
<div class="refsect2">
 
3689
<a name="NUM-TP-SENDING-STATES:CAPS"></a><h3>NUM_TP_SENDING_STATES</h3>
 
3690
<pre class="programlisting">#define NUM_TP_SENDING_STATES (3+1)
 
3691
</pre>
 
3692
<p>
 
3693
1 higher than the highest valid value of <a class="link" href="telepathy-glib-enums.html#TpSendingState" title="enum TpSendingState"><span class="type">TpSendingState</span></a>.
 
3694
</p>
 
3695
</div>
 
3696
<hr>
 
3697
<div class="refsect2">
 
3698
<a name="TpStreamComponent"></a><h3>enum TpStreamComponent</h3>
 
3699
<pre class="programlisting">typedef enum {
 
3700
    TP_STREAM_COMPONENT_UNKNOWN = 0,
 
3701
    TP_STREAM_COMPONENT_DATA = 1,
 
3702
    TP_STREAM_COMPONENT_CONTROL = 2,
 
3703
} TpStreamComponent;
 
3704
</pre>
 
3705
<p>
 
3706
         Media streams can use more than one UDP socket: one for RTP (data)         and one for RTCP (control). Most of the time, they are adjacent         to each other, but some protocols (xmpp) signal each port separately.       
 
3707
</p>
 
3708
<p>
 
3709
Bitfield/set of flags generated from the Telepathy specification.
 
3710
</p>
 
3711
<div class="variablelist"><table border="0">
 
3712
<col align="left" valign="top">
 
3713
<tbody>
 
3714
<tr>
 
3715
<td><p><a name="TP-STREAM-COMPONENT-UNKNOWN:CAPS"></a><span class="term"><code class="literal">TP_STREAM_COMPONENT_UNKNOWN</code></span></p></td>
 
3716
<td>           The stream transport type is unknown or not applicable           (should not appear over dbus).         
 
3717
</td>
 
3718
</tr>
 
3719
<tr>
 
3720
<td><p><a name="TP-STREAM-COMPONENT-DATA:CAPS"></a><span class="term"><code class="literal">TP_STREAM_COMPONENT_DATA</code></span></p></td>
 
3721
<td>           This is the high-traffic data socket, containing the audio/video           data for the stream.         
 
3722
</td>
 
3723
</tr>
 
3724
<tr>
 
3725
<td><p><a name="TP-STREAM-COMPONENT-CONTROL:CAPS"></a><span class="term"><code class="literal">TP_STREAM_COMPONENT_CONTROL</code></span></p></td>
 
3726
<td>           This is the low-traffic control socket, usually containing feedback           about packet loss etc.         
 
3727
</td>
 
3728
</tr>
 
3729
</tbody>
 
3730
</table></div>
 
3731
</div>
 
3732
<hr>
 
3733
<div class="refsect2">
 
3734
<a name="NUM-TP-STREAM-COMPONENTS:CAPS"></a><h3>NUM_TP_STREAM_COMPONENTS</h3>
 
3735
<pre class="programlisting">#define NUM_TP_STREAM_COMPONENTS (2+1)
 
3736
</pre>
 
3737
<p>
 
3738
1 higher than the highest valid value of <a class="link" href="telepathy-glib-enums.html#TpStreamComponent" title="enum TpStreamComponent"><span class="type">TpStreamComponent</span></a>.
 
3739
</p>
 
3740
</div>
 
3741
<hr>
 
3742
<div class="refsect2">
 
3743
<a name="TpStreamEndpointState"></a><h3>enum TpStreamEndpointState</h3>
 
3744
<pre class="programlisting">typedef enum {
 
3745
    TP_STREAM_ENDPOINT_STATE_CONNECTING = 0,
 
3746
    TP_STREAM_ENDPOINT_STATE_PROVISIONALLY_CONNECTED = 1,
 
3747
    TP_STREAM_ENDPOINT_STATE_FULLY_CONNECTED = 2,
 
3748
    TP_STREAM_ENDPOINT_STATE_EXHAUSTED_CANDIDATES = 3,
 
3749
    TP_STREAM_ENDPOINT_STATE_FAILED = 4,
 
3750
} TpStreamEndpointState;
 
3751
</pre>
 
3752
<p>
 
3753
         Represents the state of ICE negotiation for a single component of a         stream to an endpoint.       
 
3754
</p>
 
3755
<p>
 
3756
Bitfield/set of flags generated from the Telepathy specification.
 
3757
</p>
 
3758
<div class="variablelist"><table border="0">
 
3759
<col align="left" valign="top">
 
3760
<tbody>
 
3761
<tr>
 
3762
<td><p><a name="TP-STREAM-ENDPOINT-STATE-CONNECTING:CAPS"></a><span class="term"><code class="literal">TP_STREAM_ENDPOINT_STATE_CONNECTING</code></span></p></td>
 
3763
<td>           Candidate gathering and connectivity checks are in progress.         
 
3764
</td>
 
3765
</tr>
 
3766
<tr>
 
3767
<td><p><a name="TP-STREAM-ENDPOINT-STATE-PROVISIONALLY-CONNECTED:CAPS"></a><span class="term"><code class="literal">TP_STREAM_ENDPOINT_STATE_PROVISIONALLY_CONNECTED</code></span></p></td>
 
3768
<td>           The streaming implementation has found at least one working           candidate pair. It is possible to send media at this point, but the           controlling side has yet to negotiate the final candidates for use           in this call.         
 
3769
</td>
 
3770
</tr>
 
3771
<tr>
 
3772
<td><p><a name="TP-STREAM-ENDPOINT-STATE-FULLY-CONNECTED:CAPS"></a><span class="term"><code class="literal">TP_STREAM_ENDPOINT_STATE_FULLY_CONNECTED</code></span></p></td>
 
3773
<td>           This component of the stream is connected, and an updated offer has           been sent and accepted (finalising the candidates to be used for the           call). This should be set by the CM in response to           AcceptSelectedCandidatePair.         
 
3774
</td>
 
3775
</tr>
 
3776
<tr>
 
3777
<td><p><a name="TP-STREAM-ENDPOINT-STATE-EXHAUSTED-CANDIDATES:CAPS"></a><span class="term"><code class="literal">TP_STREAM_ENDPOINT_STATE_EXHAUSTED_CANDIDATES</code></span></p></td>
 
3778
<td>           The streaming implementation has tried connecting to all of the           available candidates and none of them have connected. This is           distinct from Failed, because the CM might be able to provide more           candidates later (more likely in XMPP than SIP).         
 
3779
</td>
 
3780
</tr>
 
3781
<tr>
 
3782
<td><p><a name="TP-STREAM-ENDPOINT-STATE-FAILED:CAPS"></a><span class="term"><code class="literal">TP_STREAM_ENDPOINT_STATE_FAILED</code></span></p></td>
 
3783
<td>           The CM and streaming implementation are in agreement that it is           impossible to connect to this endpoint. This value should only be           set by the CM.         
 
3784
</td>
 
3785
</tr>
 
3786
</tbody>
 
3787
</table></div>
 
3788
</div>
 
3789
<hr>
 
3790
<div class="refsect2">
 
3791
<a name="NUM-TP-STREAM-ENDPOINT-STATES:CAPS"></a><h3>NUM_TP_STREAM_ENDPOINT_STATES</h3>
 
3792
<pre class="programlisting">#define NUM_TP_STREAM_ENDPOINT_STATES (4+1)
 
3793
</pre>
 
3794
<p>
 
3795
1 higher than the highest valid value of <a class="link" href="telepathy-glib-enums.html#TpStreamEndpointState" title="enum TpStreamEndpointState"><span class="type">TpStreamEndpointState</span></a>.
 
3796
</p>
 
3797
</div>
 
3798
<hr>
 
3799
<div class="refsect2">
 
3800
<a name="TpStreamFlowState"></a><h3>enum TpStreamFlowState</h3>
 
3801
<pre class="programlisting">typedef enum {
 
3802
    TP_STREAM_FLOW_STATE_STOPPED = 0,
 
3803
    TP_STREAM_FLOW_STATE_PENDING_START = 1,
 
3804
    TP_STREAM_FLOW_STATE_PENDING_STOP = 2,
 
3805
    TP_STREAM_FLOW_STATE_STARTED = 3,
 
3806
} TpStreamFlowState;
 
3807
</pre>
 
3808
<p>
 
3809
         The type of SendingState         and ReceivingState.       
 
3810
</p>
 
3811
<p>
 
3812
Bitfield/set of flags generated from the Telepathy specification.
 
3813
</p>
 
3814
<div class="variablelist"><table border="0">
 
3815
<col align="left" valign="top">
 
3816
<tbody>
 
3817
<tr>
 
3818
<td><p><a name="TP-STREAM-FLOW-STATE-STOPPED:CAPS"></a><span class="term"><code class="literal">TP_STREAM_FLOW_STATE_STOPPED</code></span></p></td>
 
3819
<td>           No data is flowing (or expected to be flowing) at this time.         
 
3820
</td>
 
3821
</tr>
 
3822
<tr>
 
3823
<td><p><a name="TP-STREAM-FLOW-STATE-PENDING-START:CAPS"></a><span class="term"><code class="literal">TP_STREAM_FLOW_STATE_PENDING_START</code></span></p></td>
 
3824
<td>           The streaming implementation has been told to start or receiving,           but has not yet indicated that it is doing so.         
 
3825
</td>
 
3826
</tr>
 
3827
<tr>
 
3828
<td><p><a name="TP-STREAM-FLOW-STATE-PENDING-STOP:CAPS"></a><span class="term"><code class="literal">TP_STREAM_FLOW_STATE_PENDING_STOP</code></span></p></td>
 
3829
<td>           The streaming implementation has been told to stop sending or           receiving data, but it has not yet indicated that it has done so.         
 
3830
</td>
 
3831
</tr>
 
3832
<tr>
 
3833
<td><p><a name="TP-STREAM-FLOW-STATE-STARTED:CAPS"></a><span class="term"><code class="literal">TP_STREAM_FLOW_STATE_STARTED</code></span></p></td>
 
3834
<td>           The streaming implementation is successfully sending or receiving           data, and everything is going swimmingly.         
 
3835
</td>
 
3836
</tr>
 
3837
</tbody>
 
3838
</table></div>
 
3839
</div>
 
3840
<hr>
 
3841
<div class="refsect2">
 
3842
<a name="NUM-TP-STREAM-FLOW-STATES:CAPS"></a><h3>NUM_TP_STREAM_FLOW_STATES</h3>
 
3843
<pre class="programlisting">#define NUM_TP_STREAM_FLOW_STATES (3+1)
 
3844
</pre>
 
3845
<p>
 
3846
1 higher than the highest valid value of <a class="link" href="telepathy-glib-enums.html#TpStreamFlowState" title="enum TpStreamFlowState"><span class="type">TpStreamFlowState</span></a>.
 
3847
</p>
 
3848
</div>
 
3849
<hr>
 
3850
<div class="refsect2">
 
3851
<a name="TpStreamTransportType"></a><h3>enum TpStreamTransportType</h3>
 
3852
<pre class="programlisting">typedef enum {
 
3853
    TP_STREAM_TRANSPORT_TYPE_UNKNOWN = 0,
 
3854
    TP_STREAM_TRANSPORT_TYPE_RAW_UDP = 1,
 
3855
    TP_STREAM_TRANSPORT_TYPE_ICE = 2,
 
3856
    TP_STREAM_TRANSPORT_TYPE_GTALK_P2P = 3,
 
3857
    TP_STREAM_TRANSPORT_TYPE_WLM_2009 = 4,
 
3858
    TP_STREAM_TRANSPORT_TYPE_SHM = 5,
 
3859
    TP_STREAM_TRANSPORT_TYPE_MULTICAST = 6,
 
3860
} TpStreamTransportType;
 
3861
</pre>
 
3862
<p>
 
3863
         A transport that can be used for streaming.       
 
3864
</p>
 
3865
<p>
 
3866
Bitfield/set of flags generated from the Telepathy specification.
 
3867
</p>
 
3868
<div class="variablelist"><table border="0">
 
3869
<col align="left" valign="top">
 
3870
<tbody>
 
3871
<tr>
 
3872
<td><p><a name="TP-STREAM-TRANSPORT-TYPE-UNKNOWN:CAPS"></a><span class="term"><code class="literal">TP_STREAM_TRANSPORT_TYPE_UNKNOWN</code></span></p></td>
 
3873
<td>           The stream transport type is unknown or not applicable           (for streams that do not have a configurable transport).         
 
3874
</td>
 
3875
</tr>
 
3876
<tr>
 
3877
<td><p><a name="TP-STREAM-TRANSPORT-TYPE-RAW-UDP:CAPS"></a><span class="term"><code class="literal">TP_STREAM_TRANSPORT_TYPE_RAW_UDP</code></span></p></td>
 
3878
<td>           Raw UDP, with or without STUN. All streaming clients are assumed to           support this transport, so there is no handler capability token for           it in the Call1 interface.           [This corresponds to "none" or "stun" in the old Media.StreamHandler           interface.]         
 
3879
</td>
 
3880
</tr>
 
3881
<tr>
 
3882
<td><p><a name="TP-STREAM-TRANSPORT-TYPE-ICE:CAPS"></a><span class="term"><code class="literal">TP_STREAM_TRANSPORT_TYPE_ICE</code></span></p></td>
 
3883
<td>           Interactive Connectivity Establishment, as defined by RFC           5245. Note that this value covers ICE-UDP only.           [This corresponds to "ice-udp" in the old           Media.StreamHandler interface.]         
 
3884
</td>
 
3885
</tr>
 
3886
<tr>
 
3887
<td><p><a name="TP-STREAM-TRANSPORT-TYPE-GTALK-P2P:CAPS"></a><span class="term"><code class="literal">TP_STREAM_TRANSPORT_TYPE_GTALK_P2P</code></span></p></td>
 
3888
<td>           Google Talk peer-to-peer connectivity establishment, as implemented           by libjingle 0.3.           [This corresponds to "gtalk-p2p" in the old Media.StreamHandler           interface.]         
 
3889
</td>
 
3890
</tr>
 
3891
<tr>
 
3892
<td><p><a name="TP-STREAM-TRANSPORT-TYPE-WLM-2009:CAPS"></a><span class="term"><code class="literal">TP_STREAM_TRANSPORT_TYPE_WLM_2009</code></span></p></td>
 
3893
<td>           The transport used by Windows Live Messenger 2009 or later, which           resembles ICE draft 19.           [This corresponds to "wlm-2009" in the old Media.StreamHandler           interface.]         
 
3894
</td>
 
3895
</tr>
 
3896
<tr>
 
3897
<td><p><a name="TP-STREAM-TRANSPORT-TYPE-SHM:CAPS"></a><span class="term"><code class="literal">TP_STREAM_TRANSPORT_TYPE_SHM</code></span></p></td>
 
3898
<td>           Shared memory transport, as implemented by the GStreamer           shmsrc and shmsink plugins.         
 
3899
</td>
 
3900
</tr>
 
3901
<tr>
 
3902
<td><p><a name="TP-STREAM-TRANSPORT-TYPE-MULTICAST:CAPS"></a><span class="term"><code class="literal">TP_STREAM_TRANSPORT_TYPE_MULTICAST</code></span></p></td>
 
3903
<td>           Multicast transport.         
 
3904
</td>
 
3905
</tr>
 
3906
</tbody>
 
3907
</table></div>
 
3908
</div>
 
3909
<hr>
 
3910
<div class="refsect2">
 
3911
<a name="NUM-TP-STREAM-TRANSPORT-TYPES:CAPS"></a><h3>NUM_TP_STREAM_TRANSPORT_TYPES</h3>
 
3912
<pre class="programlisting">#define NUM_TP_STREAM_TRANSPORT_TYPES (6+1)
 
3913
</pre>
 
3914
<p>
 
3915
1 higher than the highest valid value of <a class="link" href="telepathy-glib-enums.html#TpStreamTransportType" title="enum TpStreamTransportType"><span class="type">TpStreamTransportType</span></a>.
 
3916
</p>
 
3917
</div>
 
3918
<hr>
 
3919
<div class="refsect2">
 
3920
<a name="TpCallFlags"></a><h3>enum TpCallFlags</h3>
 
3921
<pre class="programlisting">typedef enum {
 
3922
    TP_CALL_FLAG_LOCALLY_HELD = 1,
 
3923
    TP_CALL_FLAG_LOCALLY_RINGING = 2,
 
3924
    TP_CALL_FLAG_LOCALLY_QUEUED = 4,
 
3925
    TP_CALL_FLAG_FORWARDED = 8,
 
3926
    TP_CALL_FLAG_CLEARING = 16,
 
3927
} TpCallFlags;
 
3928
</pre>
 
3929
<p>
 
3930
         A set of flags representing additional information than is available         in CallState. Many of these flags only make         sense in a particular (or may explain why a call is in a specific         state).       
 
3931
</p>
 
3932
<p>
 
3933
Bitfield/set of flags generated from the Telepathy specification.
 
3934
</p>
 
3935
<div class="variablelist"><table border="0">
 
3936
<col align="left" valign="top">
 
3937
<tbody>
 
3938
<tr>
 
3939
<td><p><a name="TP-CALL-FLAG-LOCALLY-HELD:CAPS"></a><span class="term"><code class="literal">TP_CALL_FLAG_LOCALLY_HELD</code></span></p></td>
 
3940
<td>           The call has been put on hold by the local user, e.g. using           the Hold interface. This flag SHOULD only be set           if there is at least one Content, and all Contents are           locally held.                         Otherwise, in transient situations where some but not all contents             are on hold, UIs would falsely indicate that the call as a whole             is on hold, which could lead to the user saying something they'll             regret, while under the impression that the other contacts can't             hear them!              This flag exists as a simplified proxy for HoldStateChanged,             to reduce the number of signals that need to be             listened to by a simple UI.                    
 
3941
</td>
 
3942
</tr>
 
3943
<tr>
 
3944
<td><p><a name="TP-CALL-FLAG-LOCALLY-RINGING:CAPS"></a><span class="term"><code class="literal">TP_CALL_FLAG_LOCALLY_RINGING</code></span></p></td>
 
3945
<td>           This flag exists for observability of the           SetRinging method (e.g. so that           loggers can tell whether the call got as far as alerting the user,           or whether something went wrong before then). It should be set when           the SetRinging is called, and unset when the call leaves           Initialised.         
 
3946
</td>
 
3947
</tr>
 
3948
<tr>
 
3949
<td><p><a name="TP-CALL-FLAG-LOCALLY-QUEUED:CAPS"></a><span class="term"><code class="literal">TP_CALL_FLAG_LOCALLY_QUEUED</code></span></p></td>
 
3950
<td>           This flag exists for observability of the           SetQueued method. It should be set           when the SetQueued is called, and unset when the call leaves           Initialising or           Initialised.         
 
3951
</td>
 
3952
</tr>
 
3953
<tr>
 
3954
<td><p><a name="TP-CALL-FLAG-FORWARDED:CAPS"></a><span class="term"><code class="literal">TP_CALL_FLAG_FORWARDED</code></span></p></td>
 
3955
<td>           The initiator of the call originally called a contact other than the           current recipient of the call, but the call was then forwarded or           diverted. This flag only makes sense on outgoing calls. It SHOULD be           set or unset according to informational messages from other           contacts.         
 
3956
</td>
 
3957
</tr>
 
3958
<tr>
 
3959
<td><p><a name="TP-CALL-FLAG-CLEARING:CAPS"></a><span class="term"><code class="literal">TP_CALL_FLAG_CLEARING</code></span></p></td>
 
3960
<td>           This flag only occurs when the CallState is Ended. The call with           this flag set has ended, but not all resources corresponding to the           call have been freed yet.            Depending on the protocol there might be some audible feedback while           the clearing flag is set.                         In calls following the ITU-T Q.931 standard there is a period of             time between the call ending and the underlying channel being             completely free for re-use.                    
 
3961
</td>
 
3962
</tr>
 
3963
</tbody>
 
3964
</table></div>
 
3965
</div>
 
3966
<hr>
 
3967
<div class="refsect2">
 
3968
<a name="TpCallMemberFlags"></a><h3>enum TpCallMemberFlags</h3>
 
3969
<pre class="programlisting">typedef enum {
 
3970
    TP_CALL_MEMBER_FLAG_RINGING = 1,
 
3971
    TP_CALL_MEMBER_FLAG_HELD = 2,
 
3972
    TP_CALL_MEMBER_FLAG_CONFERENCE_HOST = 4,
 
3973
} TpCallMemberFlags;
 
3974
</pre>
 
3975
<p>
 
3976
         A set of flags representing the status of a remote contact in a           call.          It is protocol- and client-specific whether a particular contact           will ever have a particular flag set on them, and Telepathy clients           SHOULD NOT assume that a flag will ever be set.                     180 Ringing in SIP, and its equivalent in XMPP, are optional             informational messages, and implementations are not required             to send them. The same applies to the messages used to indicate             hold state.                
 
3977
</p>
 
3978
<p>
 
3979
Bitfield/set of flags generated from the Telepathy specification.
 
3980
</p>
 
3981
<div class="variablelist"><table border="0">
 
3982
<col align="left" valign="top">
 
3983
<tbody>
 
3984
<tr>
 
3985
<td><p><a name="TP-CALL-MEMBER-FLAG-RINGING:CAPS"></a><span class="term"><code class="literal">TP_CALL_MEMBER_FLAG_RINGING</code></span></p></td>
 
3986
<td>           The remote contact's client has told us that the contact has been             alerted about the call but has not responded.                         This is a flag per member, not a flag for the call as a whole,               because in Muji conference calls, you could invite someone and               have their state be "ringing" for a while.                    
 
3987
</td>
 
3988
</tr>
 
3989
<tr>
 
3990
<td><p><a name="TP-CALL-MEMBER-FLAG-HELD:CAPS"></a><span class="term"><code class="literal">TP_CALL_MEMBER_FLAG_HELD</code></span></p></td>
 
3991
<td>           The call member has put this call on hold.                         This is a flag per member, not a flag for the call as a whole,               because in conference calls, any member could put the conference               on hold.                    
 
3992
</td>
 
3993
</tr>
 
3994
<tr>
 
3995
<td><p><a name="TP-CALL-MEMBER-FLAG-CONFERENCE-HOST:CAPS"></a><span class="term"><code class="literal">TP_CALL_MEMBER_FLAG_CONFERENCE_HOST</code></span></p></td>
 
3996
<td>           This contact has merged this call into a conference. Note that GSM           provides a notification when the remote party merges a call into a           conference, but not when it is split out again; thus, this flag can           only indicate that the call has been part of a conference at some           point. If a GSM connection manager receives a notification that a           call has been merged into a conference a second time, it SHOULD           represent this by clearing and immediately re-setting this flag on           the remote contact.         
 
3997
</td>
 
3998
</tr>
 
3999
</tbody>
 
4000
</table></div>
 
4001
</div>
 
4002
<hr>
 
4003
<div class="refsect2">
 
4004
<a name="TpRTCPXRStatisticsFlags"></a><h3>enum TpRTCPXRStatisticsFlags</h3>
 
4005
<pre class="programlisting">typedef enum {
 
4006
    TP_RTCP_XR_STATISTICS_FLAGS_LOSS = 1,
 
4007
    TP_RTCP_XR_STATISTICS_FLAGS_DUPLICATE = 2,
 
4008
    TP_RTCP_XR_STATISTICS_FLAGS_JITTER = 4,
 
4009
    TP_RTCP_XR_STATISTICS_FLAGS_TTL = 8,
 
4010
    TP_RTCP_XR_STATISTICS_FLAGS_HL = 16,
 
4011
} TpRTCPXRStatisticsFlags;
 
4012
</pre>
 
4013
<p>
 
4014
Bitfield/set of flags generated from the Telepathy specification.
 
4015
</p>
 
4016
<div class="variablelist"><table border="0">
 
4017
<col align="left" valign="top">
 
4018
<tbody>
 
4019
<tr>
 
4020
<td><p><a name="TP-RTCP-XR-STATISTICS-FLAGS-LOSS:CAPS"></a><span class="term"><code class="literal">TP_RTCP_XR_STATISTICS_FLAGS_LOSS</code></span></p></td>
 
4021
<td>           Loss report flag, as defined in RFC3611 section 4.6.         
 
4022
</td>
 
4023
</tr>
 
4024
<tr>
 
4025
<td><p><a name="TP-RTCP-XR-STATISTICS-FLAGS-DUPLICATE:CAPS"></a><span class="term"><code class="literal">TP_RTCP_XR_STATISTICS_FLAGS_DUPLICATE</code></span></p></td>
 
4026
<td>           Duplicate report flag, as defined in RFC3611 section 4.6.         
 
4027
</td>
 
4028
</tr>
 
4029
<tr>
 
4030
<td><p><a name="TP-RTCP-XR-STATISTICS-FLAGS-JITTER:CAPS"></a><span class="term"><code class="literal">TP_RTCP_XR_STATISTICS_FLAGS_JITTER</code></span></p></td>
 
4031
<td>           Jitter flag, as defined in RFC3611 section 4.6.         
 
4032
</td>
 
4033
</tr>
 
4034
<tr>
 
4035
<td><p><a name="TP-RTCP-XR-STATISTICS-FLAGS-TTL:CAPS"></a><span class="term"><code class="literal">TP_RTCP_XR_STATISTICS_FLAGS_TTL</code></span></p></td>
 
4036
<td>           First bit of TTL or Hop Limit flag, as defined in RFC3611 section           4.6.         
 
4037
</td>
 
4038
</tr>
 
4039
<tr>
 
4040
<td><p><a name="TP-RTCP-XR-STATISTICS-FLAGS-HL:CAPS"></a><span class="term"><code class="literal">TP_RTCP_XR_STATISTICS_FLAGS_HL</code></span></p></td>
 
4041
<td>           Second bit of TTL or Hop Limit flag, as defined in RFC3611 section           4.6.         
 
4042
</td>
 
4043
</tr>
 
4044
</tbody>
 
4045
</table></div>
 
4046
</div>
3131
4047
</div>
3132
4048
</div>
3133
4049
<div class="footer">