-
Notifications
You must be signed in to change notification settings - Fork 255
/
SpeechSynthesisCancellationDetails.xml
183 lines (183 loc) · 11 KB
/
SpeechSynthesisCancellationDetails.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
<Type Name="SpeechSynthesisCancellationDetails" FullName="Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails">
<TypeSignature Language="C#" Value="public class SpeechSynthesisCancellationDetails" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SpeechSynthesisCancellationDetails extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails" />
<TypeSignature Language="VB.NET" Value="Public Class SpeechSynthesisCancellationDetails" />
<TypeSignature Language="F#" Value="type SpeechSynthesisCancellationDetails = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.16.0.28</AssemblyVersion>
<AssemblyVersion>1.17.0.28</AssemblyVersion>
<AssemblyVersion>1.18.0.28</AssemblyVersion>
<AssemblyVersion>1.19.0.28</AssemblyVersion>
<AssemblyVersion>1.20.0.28</AssemblyVersion>
<AssemblyVersion>1.21.0.28</AssemblyVersion>
<AssemblyVersion>1.22.0.28</AssemblyVersion>
<AssemblyVersion>1.23.0.28</AssemblyVersion>
<AssemblyVersion>1.24.0.28</AssemblyVersion>
<AssemblyVersion>1.24.1.28</AssemblyVersion>
<AssemblyVersion>1.25.1.26</AssemblyVersion>
<AssemblyVersion>1.27.0.28</AssemblyVersion>
<AssemblyVersion>1.28.0.28</AssemblyVersion>
<AssemblyVersion>1.30.0.28</AssemblyVersion>
<AssemblyVersion>1.31.0.28</AssemblyVersion>
<AssemblyVersion>1.32.1.28</AssemblyVersion>
<AssemblyVersion>1.34.0.28</AssemblyVersion>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Contains detailed information about why a speech synthesis result was canceled.
Added in 1.4.0
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="ErrorCode">
<MemberSignature Language="C#" Value="public Microsoft.CognitiveServices.Speech.CancellationErrorCode ErrorCode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.CognitiveServices.Speech.CancellationErrorCode ErrorCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails.ErrorCode" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ErrorCode As CancellationErrorCode" />
<MemberSignature Language="F#" Value="member this.ErrorCode : Microsoft.CognitiveServices.Speech.CancellationErrorCode" Usage="Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails.ErrorCode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.CancellationErrorCode</ReturnType>
</ReturnValue>
<Docs>
<summary>
The error code in case of an unsuccessful synthesis (<see cref="P:Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails.Reason" /> is set to Error).
If Reason is not Error, ErrorCode returns NoError.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ErrorDetails">
<MemberSignature Language="C#" Value="public string ErrorDetails { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ErrorDetails" />
<MemberSignature Language="DocId" Value="P:Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails.ErrorDetails" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ErrorDetails As String" />
<MemberSignature Language="F#" Value="member this.ErrorDetails : string" Usage="Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails.ErrorDetails" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The error message in case of an unsuccessful synthesis (<see cref="P:Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails.Reason" /> is set to Error).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FromResult">
<MemberSignature Language="C#" Value="public static Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails FromResult (Microsoft.CognitiveServices.Speech.SpeechSynthesisResult result);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails FromResult(class Microsoft.CognitiveServices.Speech.SpeechSynthesisResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails.FromResult(Microsoft.CognitiveServices.Speech.SpeechSynthesisResult)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function FromResult (result As SpeechSynthesisResult) As SpeechSynthesisCancellationDetails" />
<MemberSignature Language="F#" Value="static member FromResult : Microsoft.CognitiveServices.Speech.SpeechSynthesisResult -> Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails" Usage="Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails.FromResult result" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="Microsoft.CognitiveServices.Speech.SpeechSynthesisResult" />
</Parameters>
<Docs>
<param name="result">The result that was canceled.</param>
<summary>
Creates an instance of SpeechSynthesisCancellationDetails object for the canceled SpeechSynthesisResult.
</summary>
<returns>The CancellationDetails object being created.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FromStream">
<MemberSignature Language="C#" Value="public static Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails FromStream (Microsoft.CognitiveServices.Speech.AudioDataStream stream);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails FromStream(class Microsoft.CognitiveServices.Speech.AudioDataStream stream) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails.FromStream(Microsoft.CognitiveServices.Speech.AudioDataStream)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function FromStream (stream As AudioDataStream) As SpeechSynthesisCancellationDetails" />
<MemberSignature Language="F#" Value="static member FromStream : Microsoft.CognitiveServices.Speech.AudioDataStream -> Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails" Usage="Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails.FromStream stream" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stream" Type="Microsoft.CognitiveServices.Speech.AudioDataStream" />
</Parameters>
<Docs>
<param name="stream">The stream that was canceled</param>
<summary>
Creates an instance of SpeechSynthesisCancellationDetails object for the canceled AudioDataStream.
</summary>
<returns>The CancellationDetails object being created.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Reason">
<MemberSignature Language="C#" Value="public Microsoft.CognitiveServices.Speech.CancellationReason Reason { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.CognitiveServices.Speech.CancellationReason Reason" />
<MemberSignature Language="DocId" Value="P:Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails.Reason" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Reason As CancellationReason" />
<MemberSignature Language="F#" Value="member this.Reason : Microsoft.CognitiveServices.Speech.CancellationReason" Usage="Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails.Reason" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.CancellationReason</ReturnType>
</ReturnValue>
<Docs>
<summary>
The reason the synthesis was canceled.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.SpeechSynthesisCancellationDetails.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="speechSynthesisCancellationDetails.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns a string that represents the cancellation details.
</summary>
<returns>A string that represents the cancellation details.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>