-
Notifications
You must be signed in to change notification settings - Fork 24
/
BackToBackCall.xml
469 lines (469 loc) · 30.5 KB
/
BackToBackCall.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
<Type Name="BackToBackCall" FullName="Microsoft.Rtc.Collaboration.BackToBackCall">
<TypeSignature Language="C#" Value="public class BackToBackCall" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit BackToBackCall extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Rtc.Collaboration.BackToBackCall" />
<TypeSignature Language="VB.NET" Value="Public Class BackToBackCall" />
<TypeSignature Language="C++ CLI" Value="public ref class BackToBackCall" />
<TypeSignature Language="F#" Value="type BackToBackCall = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents a logical SIP network element that resides between two Calls to mediate SIP signaling between both ends of the call.
</summary>
<remarks>
<para>
BackToBackCall is a back-to-back user agent (B2BUA), which divides the communication session between two call legs
and mediates all SIP signaling from call establishment to termination between both ends of the call.
Common B2BUA usage is for agent anonymization in ACD (automatic call distribution) and support for other mid-way call
control features.
</para>
<para />
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BackToBackCall (Microsoft.Rtc.Collaboration.BackToBackCallSettings call1Settings, Microsoft.Rtc.Collaboration.BackToBackCallSettings call2Settings);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Rtc.Collaboration.BackToBackCallSettings call1Settings, class Microsoft.Rtc.Collaboration.BackToBackCallSettings call2Settings) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.BackToBackCall.#ctor(Microsoft.Rtc.Collaboration.BackToBackCallSettings,Microsoft.Rtc.Collaboration.BackToBackCallSettings)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (call1Settings As BackToBackCallSettings, call2Settings As BackToBackCallSettings)" />
<MemberSignature Language="C++ CLI" Value="public:
 BackToBackCall(Microsoft::Rtc::Collaboration::BackToBackCallSettings ^ call1Settings, Microsoft::Rtc::Collaboration::BackToBackCallSettings ^ call2Settings);" />
<MemberSignature Language="F#" Value="new Microsoft.Rtc.Collaboration.BackToBackCall : Microsoft.Rtc.Collaboration.BackToBackCallSettings * Microsoft.Rtc.Collaboration.BackToBackCallSettings -> Microsoft.Rtc.Collaboration.BackToBackCall" Usage="new Microsoft.Rtc.Collaboration.BackToBackCall (call1Settings, call2Settings)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="call1Settings" Type="Microsoft.Rtc.Collaboration.BackToBackCallSettings" />
<Parameter Name="call2Settings" Type="Microsoft.Rtc.Collaboration.BackToBackCallSettings" />
</Parameters>
<Docs>
<param name="call1Settings">Settings for first call leg.</param>
<param name="call2Settings">Settings for second call leg.</param>
<summary>
Creates an instance of the BackToBackCall class for the specified call legs.
</summary>
<remarks>
<para>
BackToBackCall can be used to create a back-to-back channel between an incoming call and a new outgoing call.
</para>
<para>
Before creating a BackToBackCall instance, create and initialize two CallSettings instances - one for the incoming call and the other for the outgoing idle call.
</para>
<para />
</remarks>
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="call1Settings" /> or <paramref name="call2Settings" /> is null.</exception>
<exception cref="T:System.ArgumentException">Thrown when a combination of <paramref name="call1Settings" /> and <paramref name="call2Settings" /> is not acceptable for BackToBackCall.</exception>
</Docs>
</Member>
<Member MemberName="BeginEstablish">
<MemberSignature Language="C#" Value="public IAsyncResult BeginEstablish (AsyncCallback userCallback, object state);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.IAsyncResult BeginEstablish(class System.AsyncCallback userCallback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.BackToBackCall.BeginEstablish(System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Function BeginEstablish (userCallback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="C++ CLI" Value="public:
 IAsyncResult ^ BeginEstablish(AsyncCallback ^ userCallback, System::Object ^ state);" />
<MemberSignature Language="F#" Value="member this.BeginEstablish : AsyncCallback * obj -> IAsyncResult" Usage="backToBackCall.BeginEstablish (userCallback, state)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="userCallback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="userCallback">The method to be called when the asynchronous operation is completed.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.</param>
<summary>
Begins an asynchronous operation to establish the back-to-back call between two call legs.
</summary>
<returns>An IAsyncResult that references the asynchronous operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Thrown if BackToBack call is not in the Idle state when the method is called.</exception>
</Docs>
</Member>
<Member MemberName="BeginTerminate">
<MemberSignature Language="C#" Value="public IAsyncResult BeginTerminate (AsyncCallback userCallback, object state);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.IAsyncResult BeginTerminate(class System.AsyncCallback userCallback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.BackToBackCall.BeginTerminate(System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Function BeginTerminate (userCallback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="C++ CLI" Value="public:
 IAsyncResult ^ BeginTerminate(AsyncCallback ^ userCallback, System::Object ^ state);" />
<MemberSignature Language="F#" Value="member this.BeginTerminate : AsyncCallback * obj -> IAsyncResult" Usage="backToBackCall.BeginTerminate (userCallback, state)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="userCallback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="userCallback">The method to be called when the asynchronous operation is completed.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.</param>
<summary>
Begins the asynchronous operation to terminate both call legs of BackToBackCall.
</summary>
<returns>An IAsyncResult that references the asynchronous operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BeginTerminate">
<MemberSignature Language="C#" Value="public IAsyncResult BeginTerminate (Microsoft.Rtc.Collaboration.BackToBackCallTerminateOptions options, AsyncCallback userCallback, object state);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.IAsyncResult BeginTerminate(class Microsoft.Rtc.Collaboration.BackToBackCallTerminateOptions options, class System.AsyncCallback userCallback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.BackToBackCall.BeginTerminate(Microsoft.Rtc.Collaboration.BackToBackCallTerminateOptions,System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Function BeginTerminate (options As BackToBackCallTerminateOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="C++ CLI" Value="public:
 IAsyncResult ^ BeginTerminate(Microsoft::Rtc::Collaboration::BackToBackCallTerminateOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);" />
<MemberSignature Language="F#" Value="member this.BeginTerminate : Microsoft.Rtc.Collaboration.BackToBackCallTerminateOptions * AsyncCallback * obj -> IAsyncResult" Usage="backToBackCall.BeginTerminate (options, userCallback, state)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="options" Type="Microsoft.Rtc.Collaboration.BackToBackCallTerminateOptions" />
<Parameter Name="userCallback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="options">Optional parameter for terminating the BackToBackCall.</param>
<param name="userCallback">The method to be called when the asynchronous operation is completed.</param>
<param name="state">A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.</param>
<summary>
Begins the asynchronous operation to terminate both call legs of BackToBackCall.
</summary>
<returns>An IAsyncResult that references the asynchronous operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
Thrown when the <paramref name="options" /> parameter contains invalid or restricted headers.
</exception>
</Docs>
</Member>
<Member MemberName="Call1">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.Call Call1 { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Rtc.Collaboration.Call Call1" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.BackToBackCall.Call1" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Call1 As Call" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::Call ^ Call1 { Microsoft::Rtc::Collaboration::Call ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Call1 : Microsoft.Rtc.Collaboration.Call" Usage="Microsoft.Rtc.Collaboration.BackToBackCall.Call1" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.Call</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the call instance that represents the first call leg of the BackToBackCall.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Call2">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.Call Call2 { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Rtc.Collaboration.Call Call2" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.BackToBackCall.Call2" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Call2 As Call" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::Call ^ Call2 { Microsoft::Rtc::Collaboration::Call ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Call2 : Microsoft.Rtc.Collaboration.Call" Usage="Microsoft.Rtc.Collaboration.BackToBackCall.Call2" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.Call</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the call instance that represents the second call leg of the BackToBackCall.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EndEstablish">
<MemberSignature Language="C#" Value="public void EndEstablish (IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void EndEstablish(class System.IAsyncResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.BackToBackCall.EndEstablish(System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Public Sub EndEstablish (result As IAsyncResult)" />
<MemberSignature Language="C++ CLI" Value="public:
 void EndEstablish(IAsyncResult ^ result);" />
<MemberSignature Language="F#" Value="member this.EndEstablish : IAsyncResult -> unit" Usage="backToBackCall.EndEstablish result" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">The reference to the pending asynchronous operation.</param>
<summary>
Determines whether the corresponding operation completed successfully.
This method will wait if the operation has not yet completed.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">
Thrown when this method is invoked multiple times using the same asyncResult.
</exception>
<exception cref="T:System.ArgumentNullException">
Thrown when the <paramref name="result" /> parameter is null.
</exception>
<exception cref="T:System.ArgumentException">
Thrown when the <paramref name="result" /> parameter is invalid.
</exception>
<exception cref="T:Microsoft.Rtc.Signaling.FailureResponseException">
Thrown when the remote side returns a failure response for the establish request operation.
</exception>
<exception cref="T:Microsoft.Rtc.Signaling.OperationTimeoutException">
Thrown when this operation timed out.
</exception>
<exception cref="T:Microsoft.Rtc.Signaling.OperationFailureException">
Thrown when any of the sub operations of this operation failed. This failure could be a failure to establish outgoing callleg
or failure to accept incoming call.
</exception>
<exception cref="T:Microsoft.Rtc.Signaling.RealTimeException">
Thrown when any of the sub-operations of this operation failed due to errors such as connection failure or authentication failure.
</exception>
</Docs>
</Member>
<Member MemberName="EndTerminate">
<MemberSignature Language="C#" Value="public void EndTerminate (IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void EndTerminate(class System.IAsyncResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.BackToBackCall.EndTerminate(System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Public Sub EndTerminate (result As IAsyncResult)" />
<MemberSignature Language="C++ CLI" Value="public:
 void EndTerminate(IAsyncResult ^ result);" />
<MemberSignature Language="F#" Value="member this.EndTerminate : IAsyncResult -> unit" Usage="backToBackCall.EndTerminate result" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">The reference to the pending asynchronous operation.</param>
<summary>
Determines whether the corresponding operation completed successfully.
This method will wait if the operation has not yet completed.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetPassThroughHeaderNames">
<MemberSignature Language="C#" Value="public System.Collections.ObjectModel.Collection<string> GetPassThroughHeaderNames ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.ObjectModel.Collection`1<string> GetPassThroughHeaderNames() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.BackToBackCall.GetPassThroughHeaderNames" />
<MemberSignature Language="VB.NET" Value="Public Function GetPassThroughHeaderNames () As Collection(Of String)" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Collections::ObjectModel::Collection<System::String ^> ^ GetPassThroughHeaderNames();" />
<MemberSignature Language="F#" Value="member this.GetPassThroughHeaderNames : unit -> System.Collections.ObjectModel.Collection<string>" Usage="backToBackCall.GetPassThroughHeaderNames " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.Collection<System.String></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Gets the list of header names that are designated by the application as pass-through headers.
</summary>
<returns>A collection of pass through header names.</returns>
<remarks>
<para>
All headers whose header name matches one of the names in the pass-through list are copied from
the incoming message on one call leg to the corresponding outgoing message on the other call leg.
</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="GetTraceCorrelationID">
<MemberSignature Language="C#" Value="public long GetTraceCorrelationID ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance int64 GetTraceCorrelationID() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.BackToBackCall.GetTraceCorrelationID" />
<MemberSignature Language="VB.NET" Value="Public Function GetTraceCorrelationID () As Long" />
<MemberSignature Language="C++ CLI" Value="public:
 long GetTraceCorrelationID();" />
<MemberSignature Language="F#" Value="member this.GetTraceCorrelationID : unit -> int64" Usage="backToBackCall.GetTraceCorrelationID " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Gets the trace correlation id for this instance.
</summary>
<returns>The trace correlation id.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RemoteMediaFlowState">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.RemoteMediaFlowState RemoteMediaFlowState { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Rtc.Collaboration.RemoteMediaFlowState RemoteMediaFlowState" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.BackToBackCall.RemoteMediaFlowState" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property RemoteMediaFlowState As RemoteMediaFlowState" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::RemoteMediaFlowState RemoteMediaFlowState { Microsoft::Rtc::Collaboration::RemoteMediaFlowState get(); };" />
<MemberSignature Language="F#" Value="member this.RemoteMediaFlowState : Microsoft.Rtc.Collaboration.RemoteMediaFlowState" Usage="Microsoft.Rtc.Collaboration.BackToBackCall.RemoteMediaFlowState" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.RemoteMediaFlowState</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the hint to observe the media flow state between remote participants of this back to back call.
</summary>
<value>To be added.</value>
<remarks>
<para>
The state is inferred primarily based on offer/answer renegotiation for audio video calls. If there is no known way to determine when
the media can flow between the remote endpoints, this state will remain Unknown. If the state goes to Connected, it will stay
in that state even after the back to back call is terminated. This hint is mainly provided to avoid media clipping for the
scenario where one of the call legs is on a conference and a different conversation contains an audio video call to play
message for the user involved in this back to back call. If the hint changes to Connecting before the back to back call is established,
it is recommended that the application wait for the Connected state before playing any content on the conference.
</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="RemoteMediaFlowStateChanged">
<MemberSignature Language="C#" Value="public event EventHandler<Microsoft.Rtc.Collaboration.RemoteMediaFlowStateChangedEventArgs> RemoteMediaFlowStateChanged;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.Rtc.Collaboration.RemoteMediaFlowStateChangedEventArgs> RemoteMediaFlowStateChanged" />
<MemberSignature Language="DocId" Value="E:Microsoft.Rtc.Collaboration.BackToBackCall.RemoteMediaFlowStateChanged" />
<MemberSignature Language="VB.NET" Value="Public Custom Event RemoteMediaFlowStateChanged As EventHandler(Of RemoteMediaFlowStateChangedEventArgs) " />
<MemberSignature Language="C++ CLI" Value="public:
 event EventHandler<Microsoft::Rtc::Collaboration::RemoteMediaFlowStateChangedEventArgs ^> ^ RemoteMediaFlowStateChanged;" />
<MemberSignature Language="F#" Value="member this.RemoteMediaFlowStateChanged : EventHandler<Microsoft.Rtc.Collaboration.RemoteMediaFlowStateChangedEventArgs> " Usage="member this.RemoteMediaFlowStateChanged : System.EventHandler<Microsoft.Rtc.Collaboration.RemoteMediaFlowStateChangedEventArgs> " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler<Microsoft.Rtc.Collaboration.RemoteMediaFlowStateChangedEventArgs></ReturnType>
</ReturnValue>
<Docs>
<summary>
Raised when the observed state of media flow between the two remote participants changes.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetPassThroughHeaderNames">
<MemberSignature Language="C#" Value="public void SetPassThroughHeaderNames (System.Collections.Generic.IEnumerable<string> passThroughHeaders);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetPassThroughHeaderNames(class System.Collections.Generic.IEnumerable`1<string> passThroughHeaders) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.BackToBackCall.SetPassThroughHeaderNames(System.Collections.Generic.IEnumerable{System.String})" />
<MemberSignature Language="VB.NET" Value="Public Sub SetPassThroughHeaderNames (passThroughHeaders As IEnumerable(Of String))" />
<MemberSignature Language="C++ CLI" Value="public:
 void SetPassThroughHeaderNames(System::Collections::Generic::IEnumerable<System::String ^> ^ passThroughHeaders);" />
<MemberSignature Language="F#" Value="member this.SetPassThroughHeaderNames : seq<string> -> unit" Usage="backToBackCall.SetPassThroughHeaderNames passThroughHeaders" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="passThroughHeaders" Type="System.Collections.Generic.IEnumerable<System.String>" />
</Parameters>
<Docs>
<param name="passThroughHeaders">Enumeration of pass through header names.</param>
<summary>
Sets the list of header names that must be passed from one call leg to the other call leg.
</summary>
<remarks>
<para>
If a restricted header name is specified in the pass-through header list, it will be ignored and will not
be passed from one call leg to the other call leg.
</para>
<para />
</remarks>
<exception cref="T:System.InvalidOperationException">Thrown when method is invoked and BackToBackCall state is not Idle.</exception>
</Docs>
</Member>
<Member MemberName="State">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.BackToBackCallState State { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Rtc.Collaboration.BackToBackCallState State" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.BackToBackCall.State" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property State As BackToBackCallState" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::BackToBackCallState State { Microsoft::Rtc::Collaboration::BackToBackCallState get(); };" />
<MemberSignature Language="F#" Value="member this.State : Microsoft.Rtc.Collaboration.BackToBackCallState" Usage="Microsoft.Rtc.Collaboration.BackToBackCall.State" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.BackToBackCallState</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the value of the current state of BackToBackCall.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StateChanged">
<MemberSignature Language="C#" Value="public event EventHandler<Microsoft.Rtc.Collaboration.BackToBackCallStateChangedEventArgs> StateChanged;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.Rtc.Collaboration.BackToBackCallStateChangedEventArgs> StateChanged" />
<MemberSignature Language="DocId" Value="E:Microsoft.Rtc.Collaboration.BackToBackCall.StateChanged" />
<MemberSignature Language="VB.NET" Value="Public Custom Event StateChanged As EventHandler(Of BackToBackCallStateChangedEventArgs) " />
<MemberSignature Language="C++ CLI" Value="public:
 event EventHandler<Microsoft::Rtc::Collaboration::BackToBackCallStateChangedEventArgs ^> ^ StateChanged;" />
<MemberSignature Language="F#" Value="member this.StateChanged : EventHandler<Microsoft.Rtc.Collaboration.BackToBackCallStateChangedEventArgs> " Usage="member this.StateChanged : System.EventHandler<Microsoft.Rtc.Collaboration.BackToBackCallStateChangedEventArgs> " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler<Microsoft.Rtc.Collaboration.BackToBackCallStateChangedEventArgs></ReturnType>
</ReturnValue>
<Docs>
<summary>
Raised when the state of the BackToBackCall changes.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>