-
Notifications
You must be signed in to change notification settings - Fork 24
/
McuParticipantEndpointProperties.xml
346 lines (346 loc) · 21.9 KB
/
McuParticipantEndpointProperties.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
<Type Name="McuParticipantEndpointProperties" FullName="Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties">
<TypeSignature Language="C#" Value="public abstract class McuParticipantEndpointProperties : ICloneable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit McuParticipantEndpointProperties extends System.Object implements class System.ICloneable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class McuParticipantEndpointProperties
Implements ICloneable" />
<TypeSignature Language="C++ CLI" Value="public ref class McuParticipantEndpointProperties abstract : ICloneable" />
<TypeSignature Language="F#" Value="type McuParticipantEndpointProperties = class
 interface ICloneable" />
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.ICloneable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Represents instances of properties common to all McuSession participants.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected McuParticipantEndpointProperties (Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties properties);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties properties) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.#ctor(Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties)" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (properties As McuParticipantEndpointProperties)" />
<MemberSignature Language="C++ CLI" Value="protected:
 McuParticipantEndpointProperties(Microsoft::Rtc::Collaboration::ComponentModel::McuParticipantEndpointProperties ^ properties);" />
<MemberSignature Language="F#" Value="new Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties : Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties -> Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties" Usage="new Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties properties" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="properties" Type="Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties" />
</Parameters>
<Docs>
<param name="properties">Properties to copy.</param>
<summary>
Creates a new instance of the McuParticipantEndpointProperties class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected McuParticipantEndpointProperties (string category);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(string category) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (category As String)" />
<MemberSignature Language="C++ CLI" Value="protected:
 McuParticipantEndpointProperties(System::String ^ category);" />
<MemberSignature Language="F#" Value="new Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties : string -> Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties" Usage="new Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties category" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="category" Type="System.String" />
</Parameters>
<Docs>
<param name="category">MCU type.</param>
<summary>
Creates a new instance of the McuParticipantEndpointProperties class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AccessMethod">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.ConferenceAccessMethod AccessMethod { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Rtc.Collaboration.ConferenceAccessMethod AccessMethod" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.AccessMethod" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AccessMethod As ConferenceAccessMethod" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::ConferenceAccessMethod AccessMethod { Microsoft::Rtc::Collaboration::ConferenceAccessMethod get(); };" />
<MemberSignature Language="F#" Value="member this.AccessMethod : Microsoft.Rtc.Collaboration.ConferenceAccessMethod" Usage="Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.AccessMethod" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.ConferenceAccessMethod</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the conference access method.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AuthenticationMethod">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.ConferenceAuthenticationMethod AuthenticationMethod { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Rtc.Collaboration.ConferenceAuthenticationMethod AuthenticationMethod" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.AuthenticationMethod" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AuthenticationMethod As ConferenceAuthenticationMethod" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::ConferenceAuthenticationMethod AuthenticationMethod { Microsoft::Rtc::Collaboration::ConferenceAuthenticationMethod get(); };" />
<MemberSignature Language="F#" Value="member this.AuthenticationMethod : Microsoft.Rtc.Collaboration.ConferenceAuthenticationMethod" Usage="Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.AuthenticationMethod" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.ConferenceAuthenticationMethod</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the conference authentication method.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Clone">
<MemberSignature Language="C#" Value="public abstract object Clone ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance object Clone() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.Clone" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function Clone () As Object" />
<MemberSignature Language="C++ CLI" Value="public:
 abstract System::Object ^ Clone();" />
<MemberSignature Language="F#" Value="abstract member Clone : unit -> obj" Usage="mcuParticipantEndpointProperties.Clone " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.ICloneable.Clone</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Implements ICloneable.Clone().
</summary>
<returns>A deep copy of this instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Entity">
<MemberSignature Language="C#" Value="public string Entity { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Entity" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.Entity" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Entity As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Entity { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Entity : string" Usage="Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.Entity" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the endpoint entity that uniquely identifies the endpoint among other endpoints in the conference.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="JoinMethod">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.ConferenceJoinMethod JoinMethod { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Rtc.Collaboration.ConferenceJoinMethod JoinMethod" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.JoinMethod" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property JoinMethod As ConferenceJoinMethod" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::ConferenceJoinMethod JoinMethod { Microsoft::Rtc::Collaboration::ConferenceJoinMethod get(); };" />
<MemberSignature Language="F#" Value="member this.JoinMethod : Microsoft.Rtc.Collaboration.ConferenceJoinMethod" Usage="Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.JoinMethod" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.ConferenceJoinMethod</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the endpoint join method.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="McuType">
<MemberSignature Language="C#" Value="public string McuType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string McuType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.McuType" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property McuType As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ McuType { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.McuType : string" Usage="Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.McuType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the type of MCU to which the participant endpoint belongs to.
</summary>
<value>To be added.</value>
<remarks>
<para>
Applications can get type of MCU from this property and compare it with <see cref="T:Microsoft.Rtc.Collaboration.ConferenceManagement.McuType" /> to check the type of MCU the participant endpoint belongs to.
</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Media">
<MemberSignature Language="C#" Value="public System.Collections.ObjectModel.Collection<Microsoft.Rtc.Collaboration.McuMediaChannel> Media { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.Collection`1<class Microsoft.Rtc.Collaboration.McuMediaChannel> Media" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.Media" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Media As Collection(Of McuMediaChannel)" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::ObjectModel::Collection<Microsoft::Rtc::Collaboration::McuMediaChannel ^> ^ Media { System::Collections::ObjectModel::Collection<Microsoft::Rtc::Collaboration::McuMediaChannel ^> ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Media : System.Collections.ObjectModel.Collection<Microsoft.Rtc.Collaboration.McuMediaChannel>" Usage="Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.Media" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.Collection<Microsoft.Rtc.Collaboration.McuMediaChannel></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the media the participant is participating in.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PreferredLanguages">
<MemberSignature Language="C#" Value="public System.Collections.ObjectModel.Collection<System.Globalization.CultureInfo> PreferredLanguages { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.Collection`1<class System.Globalization.CultureInfo> PreferredLanguages" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.PreferredLanguages" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PreferredLanguages As Collection(Of CultureInfo)" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::ObjectModel::Collection<System::Globalization::CultureInfo ^> ^ PreferredLanguages { System::Collections::ObjectModel::Collection<System::Globalization::CultureInfo ^> ^ get(); };" />
<MemberSignature Language="F#" Value="member this.PreferredLanguages : System.Collections.ObjectModel.Collection<System.Globalization.CultureInfo>" Usage="Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.PreferredLanguages" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.Collection<System.Globalization.CultureInfo></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the preferred languages for announcements.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Role">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.ConferencingRole Role { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Rtc.Collaboration.ConferencingRole Role" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.Role" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Role As ConferencingRole" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::ConferencingRole Role { Microsoft::Rtc::Collaboration::ConferencingRole get(); };" />
<MemberSignature Language="F#" Value="member this.Role : Microsoft.Rtc.Collaboration.ConferencingRole" Usage="Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.Role" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.ConferencingRole</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the endpoint role.
</summary>
<value>To be added.</value>
<remarks>
<para>
The endpoint role, when specified, overrides the user role.
</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Services">
<MemberSignature Language="C#" Value="public System.Collections.ObjectModel.Collection<Microsoft.Rtc.Collaboration.ActiveConferenceService> Services { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.Collection`1<class Microsoft.Rtc.Collaboration.ActiveConferenceService> Services" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.Services" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Services As Collection(Of ActiveConferenceService)" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::ObjectModel::Collection<Microsoft::Rtc::Collaboration::ActiveConferenceService ^> ^ Services { System::Collections::ObjectModel::Collection<Microsoft::Rtc::Collaboration::ActiveConferenceService ^> ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Services : System.Collections.ObjectModel.Collection<Microsoft.Rtc.Collaboration.ActiveConferenceService>" Usage="Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.Services" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("This property will be removed from future versions.")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.Collection<Microsoft.Rtc.Collaboration.ActiveConferenceService></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the list of conferencing services for the participant.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="State">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.ConferenceEndpointState State { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Rtc.Collaboration.ConferenceEndpointState State" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.State" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property State As ConferenceEndpointState" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::ConferenceEndpointState State { Microsoft::Rtc::Collaboration::ConferenceEndpointState get(); };" />
<MemberSignature Language="F#" Value="member this.State : Microsoft.Rtc.Collaboration.ConferenceEndpointState" Usage="Microsoft.Rtc.Collaboration.ComponentModel.McuParticipantEndpointProperties.State" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.ConferenceEndpointState</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the endpoint state.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>