-
Notifications
You must be signed in to change notification settings - Fork 254
/
com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.yml
290 lines (290 loc) · 30.2 KB
/
com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.yml
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
### YamlMime:JavaType
uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber"
name: "ConversationTranscriber"
nameWithType: "ConversationTranscriber"
summary: "Performs conversation transcribing for audio input streams, and gets transcribed text and speaker id as a result."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer?alt=com.microsoft.cognitiveservices.speech.Recognizer&text=Recognizer\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.canceledSetCallback(long)?alt=com.microsoft.cognitiveservices.speech.Recognizer.canceledSetCallback&text=canceledSetCallback\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.close()?alt=com.microsoft.cognitiveservices.speech.Recognizer.close&text=close\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.dispose(boolean)?alt=com.microsoft.cognitiveservices.speech.Recognizer.dispose&text=dispose\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.doAsyncRecognitionAction(java.lang.Runnable)?alt=com.microsoft.cognitiveservices.speech.Recognizer.doAsyncRecognitionAction&text=doAsyncRecognitionAction\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.getImpl()?alt=com.microsoft.cognitiveservices.speech.Recognizer.getImpl&text=getImpl\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.getPropertyBagFromRecognizerHandle(com.microsoft.cognitiveservices.speech.util.SafeHandle,com.microsoft.cognitiveservices.speech.util.IntRef)?alt=com.microsoft.cognitiveservices.speech.Recognizer.getPropertyBagFromRecognizerHandle&text=getPropertyBagFromRecognizerHandle\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.recognize()?alt=com.microsoft.cognitiveservices.speech.Recognizer.recognize&text=recognize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.recognizedSetCallback(long)?alt=com.microsoft.cognitiveservices.speech.Recognizer.recognizedSetCallback&text=recognizedSetCallback\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.recognizingSetCallback(long)?alt=com.microsoft.cognitiveservices.speech.Recognizer.recognizingSetCallback&text=recognizingSetCallback\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.sessionStartedEventCallback(long)?alt=com.microsoft.cognitiveservices.speech.Recognizer.sessionStartedEventCallback&text=sessionStartedEventCallback\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.sessionStartedSetCallback(long)?alt=com.microsoft.cognitiveservices.speech.Recognizer.sessionStartedSetCallback&text=sessionStartedSetCallback\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.sessionStoppedEventCallback(long)?alt=com.microsoft.cognitiveservices.speech.Recognizer.sessionStoppedEventCallback&text=sessionStoppedEventCallback\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.sessionStoppedSetCallback(long)?alt=com.microsoft.cognitiveservices.speech.Recognizer.sessionStoppedSetCallback&text=sessionStoppedSetCallback\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.speechEndDetectedEventCallback(long)?alt=com.microsoft.cognitiveservices.speech.Recognizer.speechEndDetectedEventCallback&text=speechEndDetectedEventCallback\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.speechEndDetectedSetCallback(long)?alt=com.microsoft.cognitiveservices.speech.Recognizer.speechEndDetectedSetCallback&text=speechEndDetectedSetCallback\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.speechStartDetectedEventCallback(long)?alt=com.microsoft.cognitiveservices.speech.Recognizer.speechStartDetectedEventCallback&text=speechStartDetectedEventCallback\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.speechStartDetectedSetCallback(long)?alt=com.microsoft.cognitiveservices.speech.Recognizer.speechStartDetectedSetCallback&text=speechStartDetectedSetCallback\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.startContinuousRecognition(com.microsoft.cognitiveservices.speech.util.SafeHandle)?alt=com.microsoft.cognitiveservices.speech.Recognizer.startContinuousRecognition&text=startContinuousRecognition\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.startKeywordRecognition(com.microsoft.cognitiveservices.speech.util.SafeHandle,com.microsoft.cognitiveservices.speech.util.SafeHandle)?alt=com.microsoft.cognitiveservices.speech.Recognizer.startKeywordRecognition&text=startKeywordRecognition\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.stopContinuousRecognition(com.microsoft.cognitiveservices.speech.util.SafeHandle)?alt=com.microsoft.cognitiveservices.speech.Recognizer.stopContinuousRecognition&text=stopContinuousRecognition\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.Recognizer.stopKeywordRecognition(com.microsoft.cognitiveservices.speech.util.SafeHandle)?alt=com.microsoft.cognitiveservices.speech.Recognizer.stopKeywordRecognition&text=stopKeywordRecognition\" data-throw-if-not-resolved=\"False\" />"
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public final class **ConversationTranscriber**</br> extends <xref href=\"com.microsoft.cognitiveservices.speech.Recognizer?alt=com.microsoft.cognitiveservices.speech.Recognizer&text=Recognizer\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.ConversationTranscriber(com.microsoft.cognitiveservices.speech.SpeechConfig)"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.ConversationTranscriber(SpeechConfig speechConfig)"
name: "ConversationTranscriber(SpeechConfig speechConfig)"
nameWithType: "ConversationTranscriber.ConversationTranscriber(SpeechConfig speechConfig)"
summary: "Initializes a new instance of Conversation Transcriber."
parameters:
- description: "speech configuration."
name: "speechConfig"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig?alt=com.microsoft.cognitiveservices.speech.SpeechConfig&text=SpeechConfig\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ConversationTranscriber(SpeechConfig speechConfig)"
desc: "Initializes a new instance of Conversation Transcriber."
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.ConversationTranscriber(com.microsoft.cognitiveservices.speech.SpeechConfig,com.microsoft.cognitiveservices.speech.AutoDetectSourceLanguageConfig)"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.ConversationTranscriber(SpeechConfig speechConfig, AutoDetectSourceLanguageConfig autoDetectSourceLangConfig)"
name: "ConversationTranscriber(SpeechConfig speechConfig, AutoDetectSourceLanguageConfig autoDetectSourceLangConfig)"
nameWithType: "ConversationTranscriber.ConversationTranscriber(SpeechConfig speechConfig, AutoDetectSourceLanguageConfig autoDetectSourceLangConfig)"
summary: "Initializes a new instance of Conversation Transcriber."
parameters:
- description: "speech configuration."
name: "speechConfig"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig?alt=com.microsoft.cognitiveservices.speech.SpeechConfig&text=SpeechConfig\" data-throw-if-not-resolved=\"False\" />"
- description: "the configuration for auto detecting source language"
name: "autoDetectSourceLangConfig"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.AutoDetectSourceLanguageConfig?alt=com.microsoft.cognitiveservices.speech.AutoDetectSourceLanguageConfig&text=AutoDetectSourceLanguageConfig\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ConversationTranscriber(SpeechConfig speechConfig, AutoDetectSourceLanguageConfig autoDetectSourceLangConfig)"
desc: "Initializes a new instance of Conversation Transcriber."
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.ConversationTranscriber(com.microsoft.cognitiveservices.speech.SpeechConfig,com.microsoft.cognitiveservices.speech.AutoDetectSourceLanguageConfig,com.microsoft.cognitiveservices.speech.audio.AudioConfig)"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.ConversationTranscriber(SpeechConfig speechConfig, AutoDetectSourceLanguageConfig autoDetectSourceLangConfig, AudioConfig audioConfig)"
name: "ConversationTranscriber(SpeechConfig speechConfig, AutoDetectSourceLanguageConfig autoDetectSourceLangConfig, AudioConfig audioConfig)"
nameWithType: "ConversationTranscriber.ConversationTranscriber(SpeechConfig speechConfig, AutoDetectSourceLanguageConfig autoDetectSourceLangConfig, AudioConfig audioConfig)"
summary: "Initializes a new instance of Conversation Transcriber."
parameters:
- description: "speech configuration."
name: "speechConfig"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig?alt=com.microsoft.cognitiveservices.speech.SpeechConfig&text=SpeechConfig\" data-throw-if-not-resolved=\"False\" />"
- description: "the configuration for auto detecting source language"
name: "autoDetectSourceLangConfig"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.AutoDetectSourceLanguageConfig?alt=com.microsoft.cognitiveservices.speech.AutoDetectSourceLanguageConfig&text=AutoDetectSourceLanguageConfig\" data-throw-if-not-resolved=\"False\" />"
- description: "audio configuration."
name: "audioConfig"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.AudioConfig?alt=com.microsoft.cognitiveservices.speech.audio.AudioConfig&text=AudioConfig\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ConversationTranscriber(SpeechConfig speechConfig, AutoDetectSourceLanguageConfig autoDetectSourceLangConfig, AudioConfig audioConfig)"
desc: "Initializes a new instance of Conversation Transcriber."
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.ConversationTranscriber(com.microsoft.cognitiveservices.speech.SpeechConfig,com.microsoft.cognitiveservices.speech.SourceLanguageConfig)"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.ConversationTranscriber(SpeechConfig speechConfig, SourceLanguageConfig sourceLanguageConfig)"
name: "ConversationTranscriber(SpeechConfig speechConfig, SourceLanguageConfig sourceLanguageConfig)"
nameWithType: "ConversationTranscriber.ConversationTranscriber(SpeechConfig speechConfig, SourceLanguageConfig sourceLanguageConfig)"
summary: "Initializes a new instance of Conversation Transcriber."
parameters:
- description: "speech configuration."
name: "speechConfig"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig?alt=com.microsoft.cognitiveservices.speech.SpeechConfig&text=SpeechConfig\" data-throw-if-not-resolved=\"False\" />"
- description: "the configuration for source language"
name: "sourceLanguageConfig"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.SourceLanguageConfig?alt=com.microsoft.cognitiveservices.speech.SourceLanguageConfig&text=SourceLanguageConfig\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ConversationTranscriber(SpeechConfig speechConfig, SourceLanguageConfig sourceLanguageConfig)"
desc: "Initializes a new instance of Conversation Transcriber."
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.ConversationTranscriber(com.microsoft.cognitiveservices.speech.SpeechConfig,com.microsoft.cognitiveservices.speech.SourceLanguageConfig,com.microsoft.cognitiveservices.speech.audio.AudioConfig)"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.ConversationTranscriber(SpeechConfig speechConfig, SourceLanguageConfig sourceLanguageConfig, AudioConfig audioConfig)"
name: "ConversationTranscriber(SpeechConfig speechConfig, SourceLanguageConfig sourceLanguageConfig, AudioConfig audioConfig)"
nameWithType: "ConversationTranscriber.ConversationTranscriber(SpeechConfig speechConfig, SourceLanguageConfig sourceLanguageConfig, AudioConfig audioConfig)"
summary: "Initializes a new instance of Conversation Transcriber."
parameters:
- description: "speech configuration."
name: "speechConfig"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig?alt=com.microsoft.cognitiveservices.speech.SpeechConfig&text=SpeechConfig\" data-throw-if-not-resolved=\"False\" />"
- description: "the configuration for source language"
name: "sourceLanguageConfig"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.SourceLanguageConfig?alt=com.microsoft.cognitiveservices.speech.SourceLanguageConfig&text=SourceLanguageConfig\" data-throw-if-not-resolved=\"False\" />"
- description: "audio configuration."
name: "audioConfig"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.AudioConfig?alt=com.microsoft.cognitiveservices.speech.audio.AudioConfig&text=AudioConfig\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ConversationTranscriber(SpeechConfig speechConfig, SourceLanguageConfig sourceLanguageConfig, AudioConfig audioConfig)"
desc: "Initializes a new instance of Conversation Transcriber."
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.ConversationTranscriber(com.microsoft.cognitiveservices.speech.SpeechConfig,com.microsoft.cognitiveservices.speech.audio.AudioConfig)"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.ConversationTranscriber(SpeechConfig speechConfig, AudioConfig audioConfig)"
name: "ConversationTranscriber(SpeechConfig speechConfig, AudioConfig audioConfig)"
nameWithType: "ConversationTranscriber.ConversationTranscriber(SpeechConfig speechConfig, AudioConfig audioConfig)"
summary: "Initializes a new instance of Conversation Transcriber."
parameters:
- description: "speech configuration."
name: "speechConfig"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig?alt=com.microsoft.cognitiveservices.speech.SpeechConfig&text=SpeechConfig\" data-throw-if-not-resolved=\"False\" />"
- description: "audio configuration."
name: "audioConfig"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.AudioConfig?alt=com.microsoft.cognitiveservices.speech.audio.AudioConfig&text=AudioConfig\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ConversationTranscriber(SpeechConfig speechConfig, AudioConfig audioConfig)"
desc: "Initializes a new instance of Conversation Transcriber."
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.ConversationTranscriber(com.microsoft.cognitiveservices.speech.SpeechConfig,java.lang.String)"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.ConversationTranscriber(SpeechConfig speechConfig, String sourceLanguage)"
name: "ConversationTranscriber(SpeechConfig speechConfig, String sourceLanguage)"
nameWithType: "ConversationTranscriber.ConversationTranscriber(SpeechConfig speechConfig, String sourceLanguage)"
summary: "Initializes a new instance of Conversation Transcriber."
parameters:
- description: "speech configuration."
name: "speechConfig"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig?alt=com.microsoft.cognitiveservices.speech.SpeechConfig&text=SpeechConfig\" data-throw-if-not-resolved=\"False\" />"
- description: "the recognition source language"
name: "sourceLanguage"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ConversationTranscriber(SpeechConfig speechConfig, String sourceLanguage)"
desc: "Initializes a new instance of Conversation Transcriber."
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.ConversationTranscriber(com.microsoft.cognitiveservices.speech.SpeechConfig,java.lang.String,com.microsoft.cognitiveservices.speech.audio.AudioConfig)"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.ConversationTranscriber(SpeechConfig speechConfig, String sourceLanguage, AudioConfig audioConfig)"
name: "ConversationTranscriber(SpeechConfig speechConfig, String sourceLanguage, AudioConfig audioConfig)"
nameWithType: "ConversationTranscriber.ConversationTranscriber(SpeechConfig speechConfig, String sourceLanguage, AudioConfig audioConfig)"
summary: "Initializes a new instance of Conversation Transcriber."
parameters:
- description: "speech configuration."
name: "speechConfig"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig?alt=com.microsoft.cognitiveservices.speech.SpeechConfig&text=SpeechConfig\" data-throw-if-not-resolved=\"False\" />"
- description: "the recognition source language"
name: "sourceLanguage"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "audio configuration."
name: "audioConfig"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.audio.AudioConfig?alt=com.microsoft.cognitiveservices.speech.audio.AudioConfig&text=AudioConfig\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ConversationTranscriber(SpeechConfig speechConfig, String sourceLanguage, AudioConfig audioConfig)"
desc: "Initializes a new instance of Conversation Transcriber."
fields:
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.canceled"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.canceled"
name: "canceled"
nameWithType: "ConversationTranscriber.canceled"
summary: "The event canceled signals that the recognition was canceled."
modifiers:
- "final"
field:
type: "<xref href=\"com.microsoft.cognitiveservices.speech.util.EventHandlerImpl?alt=com.microsoft.cognitiveservices.speech.util.EventHandlerImpl&text=EventHandlerImpl\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriptionCanceledEventArgs?alt=com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriptionCanceledEventArgs&text=ConversationTranscriptionCanceledEventArgs\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public final EventHandlerImpl<ConversationTranscriptionCanceledEventArgs> canceled"
desc: "The event canceled signals that the recognition was canceled."
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.transcribed"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.transcribed"
name: "transcribed"
nameWithType: "ConversationTranscriber.transcribed"
summary: "The event transcribed signals that a final recognition result is received."
modifiers:
- "final"
field:
type: "<xref href=\"com.microsoft.cognitiveservices.speech.util.EventHandlerImpl?alt=com.microsoft.cognitiveservices.speech.util.EventHandlerImpl&text=EventHandlerImpl\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriptionEventArgs?alt=com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriptionEventArgs&text=ConversationTranscriptionEventArgs\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public final EventHandlerImpl<ConversationTranscriptionEventArgs> transcribed"
desc: "The event transcribed signals that a final recognition result is received."
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.transcribing"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.transcribing"
name: "transcribing"
nameWithType: "ConversationTranscriber.transcribing"
summary: "The event transcribing signals that an intermediate recognition result is received."
modifiers:
- "final"
field:
type: "<xref href=\"com.microsoft.cognitiveservices.speech.util.EventHandlerImpl?alt=com.microsoft.cognitiveservices.speech.util.EventHandlerImpl&text=EventHandlerImpl\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriptionEventArgs?alt=com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriptionEventArgs&text=ConversationTranscriptionEventArgs\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public final EventHandlerImpl<ConversationTranscriptionEventArgs> transcribing"
desc: "The event transcribing signals that an intermediate recognition result is received."
methods:
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.dispose(boolean)"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.dispose(boolean disposing)"
name: "dispose(boolean disposing)"
nameWithType: "ConversationTranscriber.dispose(boolean disposing)"
summary: "This method performs cleanup of resources."
modifiers:
- "protected"
overridden: "com.microsoft.cognitiveservices.speech.Recognizer.dispose(boolean)"
parameters:
- name: "disposing"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected void dispose(boolean disposing)"
desc: "This method performs cleanup of resources. The Boolean parameter disposing indicates whether the method is called from Dispose (if disposing is true) or from the finalizer (if disposing is false). Derived classes should override this method to dispose resource if needed."
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.getAuthorizationToken()"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.getAuthorizationToken()"
name: "getAuthorizationToken()"
nameWithType: "ConversationTranscriber.getAuthorizationToken()"
summary: "Gets the authorization token used to communicate with the service."
syntax: "public String getAuthorizationToken()"
desc: "Gets the authorization token used to communicate with the service."
returns:
description: "Authorization token."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.getOutputFormat()"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.getOutputFormat()"
name: "getOutputFormat()"
nameWithType: "ConversationTranscriber.getOutputFormat()"
summary: "Gets the output format of recognition."
syntax: "public OutputFormat getOutputFormat()"
desc: "Gets the output format of recognition."
returns:
description: "The output format of recognition."
type: "<xref href=\"com.microsoft.cognitiveservices.speech.OutputFormat?alt=com.microsoft.cognitiveservices.speech.OutputFormat&text=OutputFormat\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.getProperties()"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.getProperties()"
name: "getProperties()"
nameWithType: "ConversationTranscriber.getProperties()"
summary: "The collection of properties and their values defined for this Conversation<wbr>Transcriber."
syntax: "public PropertyCollection getProperties()"
desc: "The collection of properties and their values defined for this ConversationTranscriber."
returns:
description: "The collection of properties and their values defined for this ConversationTranscriber."
type: "<xref href=\"com.microsoft.cognitiveservices.speech.PropertyCollection?alt=com.microsoft.cognitiveservices.speech.PropertyCollection&text=PropertyCollection\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.getSpeechRecognitionLanguage()"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.getSpeechRecognitionLanguage()"
name: "getSpeechRecognitionLanguage()"
nameWithType: "ConversationTranscriber.getSpeechRecognitionLanguage()"
summary: "Gets the spoken language of recognition."
syntax: "public String getSpeechRecognitionLanguage()"
desc: "Gets the spoken language of recognition."
returns:
description: "The spoken language of recognition."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.setAuthorizationToken(java.lang.String)"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.setAuthorizationToken(String token)"
name: "setAuthorizationToken(String token)"
nameWithType: "ConversationTranscriber.setAuthorizationToken(String token)"
summary: "Sets the authorization token used to communicate with the service."
parameters:
- description: "Authorization token."
name: "token"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setAuthorizationToken(String token)"
desc: "Sets the authorization token used to communicate with the service. Note: The caller needs to ensure that the authorization token is valid. Before the authorization token expires, the caller needs to refresh it by calling this setter with a new valid token. Otherwise, the recognizer will encounter errors during recognition."
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.startTranscribingAsync()"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.startTranscribingAsync()"
name: "startTranscribingAsync()"
nameWithType: "ConversationTranscriber.startTranscribingAsync()"
summary: "Starts conversation transcribing on a continuous audio stream, until stop<wbr>Transcribing<wbr>Async() is called."
syntax: "public Future<Void> startTranscribingAsync()"
desc: "Starts conversation transcribing on a continuous audio stream, until stopTranscribingAsync() is called. User must subscribe to events to receive transcription results."
returns:
description: "A task representing the asynchronous operation that starts the transcription."
type: "<xref href=\"java.util.concurrent.Future?alt=java.util.concurrent.Future&text=Future\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.Void?alt=java.lang.Void&text=Void\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.stopTranscribingAsync()"
fullName: "com.microsoft.cognitiveservices.speech.transcription.ConversationTranscriber.stopTranscribingAsync()"
name: "stopTranscribingAsync()"
nameWithType: "ConversationTranscriber.stopTranscribingAsync()"
summary: "Stops conversation transcribing."
syntax: "public Future<Void> stopTranscribingAsync()"
desc: "Stops conversation transcribing."
returns:
description: "A task representing the asynchronous operation that stops the transcription."
type: "<xref href=\"java.util.concurrent.Future?alt=java.util.concurrent.Future&text=Future\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.Void?alt=java.lang.Void&text=Void\" data-throw-if-not-resolved=\"False\" />>"
type: "class"
desc: "Performs conversation transcribing for audio input streams, and gets transcribed text and speaker id as a result. Note: close() must be called in order to release underlying resources held by the object."
metadata: {}
package: "com.microsoft.cognitiveservices.speech.transcription"
artifact: com.microsoft.cognitiveservices.speech:client-sdk:1.38.0