-
Notifications
You must be signed in to change notification settings - Fork 180
/
Recognizer.yml
145 lines (142 loc) · 5.12 KB
/
Recognizer.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
### YamlMime:TSType
name: Recognizer
uid: microsoft-cognitiveservices-speech-sdk.Recognizer
package: microsoft-cognitiveservices-speech-sdk
summary: Defines the base class Recognizer which mainly contains common event handlers.
fullName: Recognizer
remarks: ''
isDeprecated: false
type: class
properties:
- name: internalData
uid: microsoft-cognitiveservices-speech-sdk.Recognizer.internalData
package: microsoft-cognitiveservices-speech-sdk
summary: ''
fullName: internalData
remarks: ''
isDeprecated: false
syntax:
content: object internalData
return:
description: ''
type: object
- name: sessionStarted
uid: microsoft-cognitiveservices-speech-sdk.Recognizer.sessionStarted
package: microsoft-cognitiveservices-speech-sdk
summary: Defines event handler for session started events.
fullName: sessionStarted
remarks: ''
isDeprecated: false
syntax:
content: >-
public sessionStarted: (sender: Recognizer, event: SessionEventArgs) =>
void
return:
description: ''
type: '(sender: Recognizer, event: SessionEventArgs) => void'
- name: sessionStopped
uid: microsoft-cognitiveservices-speech-sdk.Recognizer.sessionStopped
package: microsoft-cognitiveservices-speech-sdk
summary: Defines event handler for session stopped events.
fullName: sessionStopped
remarks: ''
isDeprecated: false
syntax:
content: >-
public sessionStopped: (sender: Recognizer, event: SessionEventArgs) =>
void
return:
description: ''
type: '(sender: Recognizer, event: SessionEventArgs) => void'
- name: speechEndDetected
uid: microsoft-cognitiveservices-speech-sdk.Recognizer.speechEndDetected
package: microsoft-cognitiveservices-speech-sdk
summary: Defines event handler for speech stopped events.
fullName: speechEndDetected
remarks: ''
isDeprecated: false
syntax:
content: >-
public speechEndDetected: (sender: Recognizer, event:
RecognitionEventArgs) => void
return:
description: ''
type: '(sender: Recognizer, event: RecognitionEventArgs) => void'
- name: speechStartDetected
uid: microsoft-cognitiveservices-speech-sdk.Recognizer.speechStartDetected
package: microsoft-cognitiveservices-speech-sdk
summary: Defines event handler for speech started events.
fullName: speechStartDetected
remarks: ''
isDeprecated: false
syntax:
content: >-
public speechStartDetected: (sender: Recognizer, event:
RecognitionEventArgs) => void
return:
description: ''
type: '(sender: Recognizer, event: RecognitionEventArgs) => void'
- name: telemetryEnabled
uid: microsoft-cognitiveservices-speech-sdk.Recognizer.telemetryEnabled
package: microsoft-cognitiveservices-speech-sdk
summary: This method returns the current state of the telemetry setting.
fullName: telemetryEnabled
remarks: ''
isDeprecated: false
syntax:
content: static boolean telemetryEnabled
return:
description: true if the telemetry is enabled, false otherwise.
type: boolean
methods:
- name: 'close(() => void, (error: string) => void)'
uid: microsoft-cognitiveservices-speech-sdk.Recognizer.close
package: microsoft-cognitiveservices-speech-sdk
summary: Dispose of associated resources.
remarks: ''
isDeprecated: false
syntax:
content: 'function close(cb?: () => void, errorCb?: (error: string) => void)'
parameters:
- id: cb
type: () => void
description: ''
- id: errorCb
type: '(error: string) => void'
description: ''
- name: dispose(boolean)
uid: microsoft-cognitiveservices-speech-sdk.Recognizer.dispose
package: microsoft-cognitiveservices-speech-sdk
summary: >-
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.
remarks: ''
isDeprecated: false
syntax:
content: 'function dispose(disposing: boolean): Promise<void>'
parameters:
- id: disposing
type: boolean
description: Flag to request disposal.
return:
description: ''
type: Promise<void>
- name: enableTelemetry(boolean)
uid: microsoft-cognitiveservices-speech-sdk.Recognizer.enableTelemetry
package: microsoft-cognitiveservices-speech-sdk
summary: This method globally enables or disables telemetry.
remarks: ''
isDeprecated: false
syntax:
content: 'static function enableTelemetry(enabled: boolean)'
parameters:
- id: enabled
type: boolean
description: |-
Global setting for telemetry collection.
If set to true, telemetry information like microphone errors,
recognition errors are collected and sent to Microsoft.
If set to false, no telemetry is sent to Microsoft.