-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
AudioLevelUpdatedEventArgs.xml
102 lines (87 loc) · 5.79 KB
/
AudioLevelUpdatedEventArgs.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
<Type Name="AudioLevelUpdatedEventArgs" FullName="System.Speech.Recognition.AudioLevelUpdatedEventArgs">
<TypeSignature Language="C#" Value="public class AudioLevelUpdatedEventArgs : EventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AudioLevelUpdatedEventArgs extends System.EventArgs" />
<TypeSignature Language="DocId" Value="T:System.Speech.Recognition.AudioLevelUpdatedEventArgs" />
<TypeSignature Language="VB.NET" Value="Public Class AudioLevelUpdatedEventArgs
Inherits EventArgs" />
<TypeSignature Language="F#" Value="type AudioLevelUpdatedEventArgs = class
 inherit EventArgs" />
<TypeSignature Language="C++ CLI" Value="public ref class AudioLevelUpdatedEventArgs : EventArgs" />
<AssemblyInfo>
<AssemblyName>System.Speech</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.EventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides data for the <see langword="AudioLevelUpdated" /> event of the <see cref="T:System.Speech.Recognition.SpeechRecognizer" /> or the <see cref="T:System.Speech.Recognition.SpeechRecognitionEngine" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When they are raised, the <xref:System.Speech.Recognition.SpeechRecognitionEngine.AudioLevelUpdated?displayProperty=nameWithType> and <xref:System.Speech.Recognition.SpeechRecognizer.AudioLevelUpdated?displayProperty=nameWithType> events pass an instance of <xref:System.Speech.Recognition.AudioLevelUpdatedEventArgs> to the handler for the associated event.
The <xref:System.Speech.Recognition.AudioLevelUpdatedEventArgs.AudioLevel%2A> property gets the new level of audio input when the <xref:System.Speech.Recognition.SpeechRecognitionEngine.AudioLevelUpdated?displayProperty=nameWithType> or <xref:System.Speech.Recognition.SpeechRecognizer.AudioLevelUpdated?displayProperty=nameWithType> event is raised.
The `AudioLevel` property of the <xref:System.Speech.Recognition.SpeechRecognizer> and <xref:System.Speech.Recognition.SpeechRecognitionEngine> classes provides the current level of the audio input to the speech recognition engine.
## Examples
The following example adds an event handler to a <xref:System.Speech.Recognition.SpeechRecognitionEngine> object. The handler outputs the new audio level to the console.
<xref:System.Speech.Recognition.AudioLevelUpdatedEventArgs> derives from <xref:System.EventArgs>.
```csharp
private SpeechRecognitionEngine sre;
// Initialize the SpeechRecognitionEngine object.
private void Initialize()
{
sre = new SpeechRecognitionEngine();
// Add an event handler for the AudioLevelUpdated event.
sre.AudioLevelUpdated += new EventHandler<AudioLevelUpdatedEventArgs>(sre_AudioLevelUpdated);
// Add other initialization code here.
}
// Write the audio level to the console when the AudioLevelUpdated event is raised.
void sre_AudioLevelUpdated(object sender, AudioLevelUpdatedEventArgs e)
{
Console.WriteLine("The audio level is now: {0}.", e.AudioLevel);
}
```
]]></format>
</remarks>
<altmember cref="P:System.Speech.Recognition.SpeechRecognitionEngine.AudioLevel" />
<altmember cref="E:System.Speech.Recognition.SpeechRecognitionEngine.AudioLevelUpdated" />
<altmember cref="P:System.Speech.Recognition.SpeechRecognizer.AudioLevel" />
<altmember cref="E:System.Speech.Recognition.SpeechRecognizer.AudioLevelUpdated" />
</Docs>
<Members>
<Member MemberName="AudioLevel">
<MemberSignature Language="C#" Value="public int AudioLevel { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 AudioLevel" />
<MemberSignature Language="DocId" Value="P:System.Speech.Recognition.AudioLevelUpdatedEventArgs.AudioLevel" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AudioLevel As Integer" />
<MemberSignature Language="F#" Value="member this.AudioLevel : int" Usage="System.Speech.Recognition.AudioLevelUpdatedEventArgs.AudioLevel" />
<MemberSignature Language="C++ CLI" Value="public:
 property int AudioLevel { int get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Speech</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the new level of audio input after the <see cref="E:System.Speech.Recognition.SpeechRecognitionEngine.AudioLevelUpdated" /> or the <see cref="E:System.Speech.Recognition.SpeechRecognizer.AudioLevelUpdated" /> event is raised.</summary>
<value>The new level of audio input.</value>
<remarks>To be added.</remarks>
<altmember cref="P:System.Speech.Recognition.SpeechRecognitionEngine.AudioLevel" />
<altmember cref="P:System.Speech.Recognition.SpeechRecognizer.AudioLevel" />
</Docs>
</Member>
</Members>
</Type>