-
Notifications
You must be signed in to change notification settings - Fork 180
/
AvatarSynthesizer.yml
242 lines (237 loc) · 8.6 KB
/
AvatarSynthesizer.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
### YamlMime:TSType
name: AvatarSynthesizer
uid: microsoft-cognitiveservices-speech-sdk.AvatarSynthesizer
package: microsoft-cognitiveservices-speech-sdk
summary: Defines the avatar synthesizer.
fullName: AvatarSynthesizer
remarks: ''
isDeprecated: false
type: class
constructors:
- name: AvatarSynthesizer(SpeechConfig, AvatarConfig)
uid: microsoft-cognitiveservices-speech-sdk.AvatarSynthesizer.constructor
package: microsoft-cognitiveservices-speech-sdk
summary: Creates and initializes an instance of this class.
remarks: ''
isDeprecated: false
syntax:
content: >-
new AvatarSynthesizer(speechConfig: SpeechConfig, avatarConfig:
AvatarConfig)
parameters:
- id: speechConfig
type: <xref uid="microsoft-cognitiveservices-speech-sdk.SpeechConfig" />
description: The speech config.
- id: avatarConfig
type: <xref uid="microsoft-cognitiveservices-speech-sdk.AvatarConfig" />
description: The talking avatar config.
properties:
- name: authorizationToken
uid: >-
microsoft-cognitiveservices-speech-sdk.AvatarSynthesizer.authorizationToken
package: microsoft-cognitiveservices-speech-sdk
summary: Gets the authorization token used to communicate with the service.
fullName: authorizationToken
remarks: ''
isDeprecated: false
syntax:
content: string authorizationToken
return:
description: Authorization token.
type: string
- name: autoDetectSourceLanguage
uid: >-
microsoft-cognitiveservices-speech-sdk.AvatarSynthesizer.autoDetectSourceLanguage
package: microsoft-cognitiveservices-speech-sdk
summary: Indicates if auto detect source language is enabled
fullName: autoDetectSourceLanguage
remarks: ''
isDeprecated: false
syntax:
content: boolean autoDetectSourceLanguage
return:
description: if auto detect source language is enabled
type: boolean
- name: avatarEventReceived
uid: >-
microsoft-cognitiveservices-speech-sdk.AvatarSynthesizer.avatarEventReceived
package: microsoft-cognitiveservices-speech-sdk
summary: Defines event handler for avatar events.
fullName: avatarEventReceived
remarks: ''
isDeprecated: false
syntax:
content: >-
public avatarEventReceived: (sender: AvatarSynthesizer, event:
AvatarEventArgs) => void
return:
description: ''
type: '(sender: AvatarSynthesizer, event: AvatarEventArgs) => void'
- name: iceServers
uid: microsoft-cognitiveservices-speech-sdk.AvatarSynthesizer.iceServers
package: microsoft-cognitiveservices-speech-sdk
summary: Gets the ICE servers. Internal use only.
fullName: iceServers
remarks: ''
isDeprecated: false
syntax:
content: RTCIceServer[] iceServers
return:
description: ''
type: RTCIceServer[]
- name: properties
uid: microsoft-cognitiveservices-speech-sdk.AvatarSynthesizer.properties
package: microsoft-cognitiveservices-speech-sdk
summary: >-
The collection of properties and their values defined for this
Synthesizer.
fullName: properties
remarks: ''
isDeprecated: false
syntax:
content: PropertyCollection properties
return:
description: >-
The collection of properties and their values defined for this
SpeechSynthesizer.
type: >-
<xref uid="microsoft-cognitiveservices-speech-sdk.PropertyCollection"
/>
inheritedMethods:
- name: buildSsml(string)
uid: microsoft-cognitiveservices-speech-sdk.AvatarSynthesizer.buildSsml
package: microsoft-cognitiveservices-speech-sdk
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'function buildSsml(text: string): string'
parameters:
- id: text
type: string
description: ''
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[Synthesizer.buildSsml](xref:microsoft-cognitiveservices-speech-sdk.Synthesizer.buildSsml)
- name: dispose(boolean)
uid: microsoft-cognitiveservices-speech-sdk.AvatarSynthesizer.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>
inheritanceDescription: >-
<b>Inherited From</b>
[Synthesizer.dispose](xref:microsoft-cognitiveservices-speech-sdk.Synthesizer.dispose)
methods:
- name: close()
uid: microsoft-cognitiveservices-speech-sdk.AvatarSynthesizer.close
package: microsoft-cognitiveservices-speech-sdk
summary: Dispose of associated resources.
remarks: ''
isDeprecated: false
syntax:
content: 'function close(): Promise<void>'
return:
description: ''
type: Promise<void>
- name: speakSsmlAsync(string)
uid: microsoft-cognitiveservices-speech-sdk.AvatarSynthesizer.speakSsmlAsync
package: microsoft-cognitiveservices-speech-sdk
summary: >-
Speaks SSML asynchronously. The rendered audio and video will be sent via
the WebRTC connection.
remarks: ''
isDeprecated: false
syntax:
content: 'function speakSsmlAsync(ssml: string): Promise<SynthesisResult>'
parameters:
- id: ssml
type: string
description: The SSML text to speak.
return:
description: The promise of the synthesis result.
type: >-
Promise<<xref
uid="microsoft-cognitiveservices-speech-sdk.SynthesisResult" />>
- name: speakTextAsync(string)
uid: microsoft-cognitiveservices-speech-sdk.AvatarSynthesizer.speakTextAsync
package: microsoft-cognitiveservices-speech-sdk
summary: >-
Speaks plain text asynchronously. The rendered audio and video will be
sent via the WebRTC connection.
remarks: ''
isDeprecated: false
syntax:
content: 'function speakTextAsync(text: string): Promise<SynthesisResult>'
parameters:
- id: text
type: string
description: The plain text to speak.
return:
description: The promise of the synthesis result.
type: >-
Promise<<xref
uid="microsoft-cognitiveservices-speech-sdk.SynthesisResult" />>
- name: startAvatarAsync(RTCPeerConnection)
uid: microsoft-cognitiveservices-speech-sdk.AvatarSynthesizer.startAvatarAsync
package: microsoft-cognitiveservices-speech-sdk
summary: Starts the talking avatar session and establishes the WebRTC connection.
remarks: ''
isDeprecated: false
syntax:
content: >-
function startAvatarAsync(peerConnection: RTCPeerConnection):
Promise<SynthesisResult>
parameters:
- id: peerConnection
type: RTCPeerConnection
description: The peer connection.
return:
description: The promise of the connection result.
type: >-
Promise<<xref
uid="microsoft-cognitiveservices-speech-sdk.SynthesisResult" />>
- name: stopAvatarAsync()
uid: microsoft-cognitiveservices-speech-sdk.AvatarSynthesizer.stopAvatarAsync
package: microsoft-cognitiveservices-speech-sdk
summary: >-
Stops the talking avatar session and closes the WebRTC connection.
For now, this is the same as close().
You need to create a new AvatarSynthesizer instance to start a new
session.
remarks: ''
isDeprecated: false
syntax:
content: 'function stopAvatarAsync(): Promise<void>'
return:
description: The promise of the void result.
type: Promise<void>
- name: stopSpeakingAsync()
uid: microsoft-cognitiveservices-speech-sdk.AvatarSynthesizer.stopSpeakingAsync
package: microsoft-cognitiveservices-speech-sdk
summary: Speaks text asynchronously. The avatar will switch to idle state.
remarks: ''
isDeprecated: false
syntax:
content: 'function stopSpeakingAsync(): Promise<void>'
return:
description: The promise of the void result.
type: Promise<void>
extends: <xref uid="microsoft-cognitiveservices-speech-sdk.Synthesizer" />