-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
VoiceChangeEventArgs.xml
71 lines (66 loc) · 4.52 KB
/
VoiceChangeEventArgs.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
<Type Name="VoiceChangeEventArgs" FullName="System.Speech.Synthesis.VoiceChangeEventArgs">
<TypeSignature Language="C#" Value="public class VoiceChangeEventArgs : System.Speech.Synthesis.PromptEventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit VoiceChangeEventArgs extends System.Speech.Synthesis.PromptEventArgs" />
<TypeSignature Language="DocId" Value="T:System.Speech.Synthesis.VoiceChangeEventArgs" />
<TypeSignature Language="VB.NET" Value="Public Class VoiceChangeEventArgs
Inherits PromptEventArgs" />
<TypeSignature Language="F#" Value="type VoiceChangeEventArgs = class
 inherit PromptEventArgs" />
<TypeSignature Language="C++ CLI" Value="public ref class VoiceChangeEventArgs : System::Speech::Synthesis::PromptEventArgs" />
<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.Speech.Synthesis.PromptEventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Returns data from the <see cref="E:System.Speech.Synthesis.SpeechSynthesizer.VoiceChange" /> event.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
An instance of <xref:System.Speech.Synthesis.VoiceChangeEventArgs> is created when the <xref:System.Speech.Synthesis.SpeechSynthesizer> object raises the <xref:System.Speech.Synthesis.SpeechSynthesizer.VoiceChange> event. To obtain the identity of the new <xref:System.Speech.Synthesis.SpeechSynthesizer.Voice%2A>, access the <xref:System.Speech.Synthesis.VoiceChangeEventArgs.Voice%2A> property in the handler for the event.
You can change the voice in use by the <xref:System.Speech.Synthesis.SpeechSynthesizer> with any of the <xref:System.Speech.Synthesis.PromptBuilder>'s <xref:System.Speech.Synthesis.PromptBuilder.StartVoice%2A> methods or the <xref:System.Speech.Synthesis.SpeechSynthesizer>'s <xref:System.Speech.Synthesis.SpeechSynthesizer.SelectVoice%2A> or <xref:System.Speech.Synthesis.SpeechSynthesizer.SelectVoiceByHints%2A> methods.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="Voice">
<MemberSignature Language="C#" Value="public System.Speech.Synthesis.VoiceInfo Voice { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Speech.Synthesis.VoiceInfo Voice" />
<MemberSignature Language="DocId" Value="P:System.Speech.Synthesis.VoiceChangeEventArgs.Voice" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Voice As VoiceInfo" />
<MemberSignature Language="F#" Value="member this.Voice : System.Speech.Synthesis.VoiceInfo" Usage="System.Speech.Synthesis.VoiceChangeEventArgs.Voice" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Speech::Synthesis::VoiceInfo ^ Voice { System::Speech::Synthesis::VoiceInfo ^ 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.Speech.Synthesis.VoiceInfo</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.Speech.Synthesis.VoiceInfo" /> object of the new voice.</summary>
<value>Returns information that describes and identifies the new voice.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Speech.Synthesis.VoiceChangeEventArgs.Voice%2A> property gets the <xref:System.Speech.Synthesis.VoiceInfo> object when a <xref:System.Speech.Synthesis.SpeechSynthesizer.VoiceChange> event is raised.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>