-
Notifications
You must be signed in to change notification settings - Fork 257
/
VoiceProfileEnrollmentCancellationDetails.xml
156 lines (156 loc) · 9.41 KB
/
VoiceProfileEnrollmentCancellationDetails.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
<Type Name="VoiceProfileEnrollmentCancellationDetails" FullName="Microsoft.CognitiveServices.Speech.Speaker.VoiceProfileEnrollmentCancellationDetails">
<TypeSignature Language="C#" Value="public class VoiceProfileEnrollmentCancellationDetails" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit VoiceProfileEnrollmentCancellationDetails extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.CognitiveServices.Speech.Speaker.VoiceProfileEnrollmentCancellationDetails" />
<TypeSignature Language="VB.NET" Value="Public Class VoiceProfileEnrollmentCancellationDetails" />
<TypeSignature Language="F#" Value="type VoiceProfileEnrollmentCancellationDetails = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<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 the cancellation details of an enrollment result.
Added in 1.12.0
</summary>
<remarks>
See also: [Get started with Speaker recognition](/azure/cognitive-services/speech-service/get-started-speaker-recognition)
</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.Speaker.VoiceProfileEnrollmentCancellationDetails.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.Speaker.VoiceProfileEnrollmentCancellationDetails.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 enrollment (<see cref="P:Microsoft.CognitiveServices.Speech.Speaker.VoiceProfileEnrollmentCancellationDetails.Reason" /> is set to Error).
</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.Speaker.VoiceProfileEnrollmentCancellationDetails.ErrorDetails" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ErrorDetails As String" />
<MemberSignature Language="F#" Value="member this.ErrorDetails : string" Usage="Microsoft.CognitiveServices.Speech.Speaker.VoiceProfileEnrollmentCancellationDetails.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 enrollment (<see cref="P:Microsoft.CognitiveServices.Speech.Speaker.VoiceProfileEnrollmentCancellationDetails.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.Speaker.VoiceProfileEnrollmentCancellationDetails FromResult (Microsoft.CognitiveServices.Speech.Speaker.VoiceProfileEnrollmentResult result);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.CognitiveServices.Speech.Speaker.VoiceProfileEnrollmentCancellationDetails FromResult(class Microsoft.CognitiveServices.Speech.Speaker.VoiceProfileEnrollmentResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Speaker.VoiceProfileEnrollmentCancellationDetails.FromResult(Microsoft.CognitiveServices.Speech.Speaker.VoiceProfileEnrollmentResult)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function FromResult (result As VoiceProfileEnrollmentResult) As VoiceProfileEnrollmentCancellationDetails" />
<MemberSignature Language="F#" Value="static member FromResult : Microsoft.CognitiveServices.Speech.Speaker.VoiceProfileEnrollmentResult -> Microsoft.CognitiveServices.Speech.Speaker.VoiceProfileEnrollmentCancellationDetails" Usage="Microsoft.CognitiveServices.Speech.Speaker.VoiceProfileEnrollmentCancellationDetails.FromResult result" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.Speaker.VoiceProfileEnrollmentCancellationDetails</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="Microsoft.CognitiveServices.Speech.Speaker.VoiceProfileEnrollmentResult" />
</Parameters>
<Docs>
<param name="result">A voice profile enrollment result object.</param>
<summary>
Create an object that represents the details of a canceled enrollment result.
</summary>
<returns>A voice profile enrollment cancellation details object.</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.Speaker.VoiceProfileEnrollmentCancellationDetails.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.Speaker.VoiceProfileEnrollmentCancellationDetails.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 enrollment 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.Speaker.VoiceProfileEnrollmentCancellationDetails.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="voiceProfileEnrollmentCancellationDetails.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>