/
MediaChannelTemplate.xml
120 lines (114 loc) · 6.2 KB
/
MediaChannelTemplate.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
<Type Name="MediaChannelTemplate" FullName="Microsoft.Rtc.Collaboration.AudioVideo.MediaChannelTemplate">
<TypeSignature Language="C#" Value="public abstract class MediaChannelTemplate" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit MediaChannelTemplate extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Rtc.Collaboration.AudioVideo.MediaChannelTemplate" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class MediaChannelTemplate" />
<TypeSignature Language="C++ CLI" Value="public ref class MediaChannelTemplate abstract" />
<TypeSignature Language="F#" Value="type MediaChannelTemplate = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Media Channel Template.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AllowedDirection">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.AudioVideo.MediaChannelDirection AllowedDirection { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Rtc.Collaboration.AudioVideo.MediaChannelDirection AllowedDirection" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.AudioVideo.MediaChannelTemplate.AllowedDirection" />
<MemberSignature Language="VB.NET" Value="Public Property AllowedDirection As MediaChannelDirection" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::AudioVideo::MediaChannelDirection AllowedDirection { Microsoft::Rtc::Collaboration::AudioVideo::MediaChannelDirection get(); void set(Microsoft::Rtc::Collaboration::AudioVideo::MediaChannelDirection value); };" />
<MemberSignature Language="F#" Value="member this.AllowedDirection : Microsoft.Rtc.Collaboration.AudioVideo.MediaChannelDirection with get, set" Usage="Microsoft.Rtc.Collaboration.AudioVideo.MediaChannelTemplate.AllowedDirection" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.AudioVideo.MediaChannelDirection</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the stream allowed direction.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown when assigned value is not defined in enumerated type.</exception>
<example>
<para />
<para>
The following example changes AllowedDirection and applies it to an AudioVideoFlow.
</para>
<para> C# Modifying AudioChannelTemplate properties.</para>
<code>
AudioVideoFlowTemplate templateToApply = new AudioVideoFlowTemplate(audioVideoFlow);
AudioChannelTemplate audioChannelTemplate = (AudioChannelTemplate)templateToApply.Audio.GetChannels()[ChannelLabel.AudioMono];
audioChannelTemplate.AllowedDirection = MediaChannelDirection.SendOnly;
audioChannelTemplate.SendDirectionSamplingRate = AudioSamplingRate.EightKhz;
// ApplyChanges
audioVideoFlow.BeginApplyChanges(
templateToApply,
new AsyncCallback(delegate(IAsyncResult result)
{
try
{
audioVideoFlow.EndApplyChanges(result);
}
catch (RealTimeException e)
{
// handle exception
throw e;
}
// ApplyChanges is done, verify changes result..
AudioChannel audioChannel = audioVideoFlow.Audio.GetChannels()[ChannelLabel.AudioMono];
if (audioChannel.Direction == MediaChannelDirection.SendOnly &amp;&amp;
audioChannel.SendDirectionSamplingRate == AudioSamplingRate.EightKhz)
{
// remote side accepted changes as they were
}
else
{
// remote side accepted changes but filtered them more.
}
}),
this);
</code>
</example>
</Docs>
</Member>
<Member MemberName="Label">
<MemberSignature Language="C#" Value="public Microsoft.Rtc.Collaboration.AudioVideo.ChannelLabel Label { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Rtc.Collaboration.AudioVideo.ChannelLabel Label" />
<MemberSignature Language="DocId" Value="P:Microsoft.Rtc.Collaboration.AudioVideo.MediaChannelTemplate.Label" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Label As ChannelLabel" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Rtc::Collaboration::AudioVideo::ChannelLabel Label { Microsoft::Rtc::Collaboration::AudioVideo::ChannelLabel get(); };" />
<MemberSignature Language="F#" Value="member this.Label : Microsoft.Rtc.Collaboration.AudioVideo.ChannelLabel" Usage="Microsoft.Rtc.Collaboration.AudioVideo.MediaChannelTemplate.Label" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Rtc.Collaboration.AudioVideo.IMediaChannel.Label</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Rtc.Collaboration</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Rtc.Collaboration.AudioVideo.ChannelLabel</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the Stream Label.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>