-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.yml
257 lines (257 loc) · 27.9 KB
/
com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.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
### YamlMime:JavaType
uid: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig"
fullName: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig"
name: "SpeechTranslationConfig"
nameWithType: "SpeechTranslationConfig"
summary: "Speech translation configuration."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig?alt=com.microsoft.cognitiveservices.speech.SpeechConfig&text=SpeechConfig\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.close()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.close&text=close\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.enableAudioLogging()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.enableAudioLogging&text=enableAudioLogging\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.enableDictation()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.enableDictation&text=enableDictation\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.fromAuthorizationToken(java.lang.String,java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.fromAuthorizationToken&text=fromAuthorizationToken\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.fromEndpoint(java.net.URI)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.fromEndpoint&text=fromEndpoint\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.fromEndpoint(java.net.URI,java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.fromEndpoint&text=fromEndpoint\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.fromHost(java.net.URI)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.fromHost&text=fromHost\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.fromHost(java.net.URI,java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.fromHost&text=fromHost\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.fromSubscription(java.lang.String,java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.fromSubscription&text=fromSubscription\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getAuthorizationToken()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getAuthorizationToken&text=getAuthorizationToken\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getEndpointId()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getEndpointId&text=getEndpointId\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getImpl()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getImpl&text=getImpl\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getOutputFormat()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getOutputFormat&text=getOutputFormat\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getProperty(com.microsoft.cognitiveservices.speech.PropertyId)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getProperty&text=getProperty\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getProperty(java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getProperty&text=getProperty\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getSpeechRecognitionLanguage()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getSpeechRecognitionLanguage&text=getSpeechRecognitionLanguage\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getSpeechSynthesisLanguage()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getSpeechSynthesisLanguage&text=getSpeechSynthesisLanguage\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getSpeechSynthesisOutputFormat()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getSpeechSynthesisOutputFormat&text=getSpeechSynthesisOutputFormat\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.getSpeechSynthesisVoiceName()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.getSpeechSynthesisVoiceName&text=getSpeechSynthesisVoiceName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.requestWordLevelTimestamps()?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.requestWordLevelTimestamps&text=requestWordLevelTimestamps\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setAuthorizationToken(java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setAuthorizationToken&text=setAuthorizationToken\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setEndpointId(java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setEndpointId&text=setEndpointId\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setOutputFormat(com.microsoft.cognitiveservices.speech.OutputFormat)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setOutputFormat&text=setOutputFormat\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setProfanity(com.microsoft.cognitiveservices.speech.ProfanityOption)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setProfanity&text=setProfanity\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setProperty(com.microsoft.cognitiveservices.speech.PropertyId,java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setProperty&text=setProperty\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setProperty(java.lang.String,java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setProperty&text=setProperty\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setProxy(java.lang.String,int,java.lang.String,java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setProxy&text=setProxy\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setServiceProperty(java.lang.String,java.lang.String,com.microsoft.cognitiveservices.speech.ServicePropertyChannel)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setServiceProperty&text=setServiceProperty\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setSpeechRecognitionLanguage(java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setSpeechRecognitionLanguage&text=setSpeechRecognitionLanguage\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setSpeechSynthesisLanguage(java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setSpeechSynthesisLanguage&text=setSpeechSynthesisLanguage\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setSpeechSynthesisOutputFormat(com.microsoft.cognitiveservices.speech.SpeechSynthesisOutputFormat)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setSpeechSynthesisOutputFormat&text=setSpeechSynthesisOutputFormat\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig.setSpeechSynthesisVoiceName(java.lang.String)?alt=com.microsoft.cognitiveservices.speech.SpeechConfig.setSpeechSynthesisVoiceName&text=setSpeechSynthesisVoiceName\" 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 **SpeechTranslationConfig**</br> extends <xref href=\"com.microsoft.cognitiveservices.speech.SpeechConfig?alt=com.microsoft.cognitiveservices.speech.SpeechConfig&text=SpeechConfig\" data-throw-if-not-resolved=\"False\" /></br> implements <xref href=\"java.lang.AutoCloseable?alt=java.lang.AutoCloseable&text=AutoCloseable\" data-throw-if-not-resolved=\"False\" />"
methods:
- uid: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.addTargetLanguage(java.lang.String)"
fullName: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.addTargetLanguage(String value)"
name: "addTargetLanguage(String value)"
nameWithType: "SpeechTranslationConfig.addTargetLanguage(String value)"
summary: "Adds a (text) target language for translation."
parameters:
- description: "the language identifier in BCP-47 format."
name: "value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void addTargetLanguage(String value)"
desc: "Adds a (text) target language for translation."
- uid: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.close()"
fullName: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.close()"
name: "close()"
nameWithType: "SpeechTranslationConfig.close()"
summary: "Dispose of associated resources."
overridden: "com.microsoft.cognitiveservices.speech.SpeechConfig.close()"
syntax: "public void close()"
desc: "Dispose of associated resources."
- uid: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.fromAuthorizationToken(java.lang.String,java.lang.String)"
fullName: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.fromAuthorizationToken(String authorizationToken, String region)"
name: "fromAuthorizationToken(String authorizationToken, String region)"
nameWithType: "SpeechTranslationConfig.fromAuthorizationToken(String authorizationToken, String region)"
summary: "Static instance of Speech<wbr>Translation<wbr>Config returned by passing authorization token and service region."
modifiers:
- "static"
parameters:
- description: "The authorization token."
name: "authorizationToken"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The region name (see the <a href=\"https://aka.ms/csspeech/region\">region page</a>)."
name: "region"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static SpeechTranslationConfig fromAuthorizationToken(String authorizationToken, String region)"
desc: "Static instance of SpeechTranslationConfig returned by passing authorization token and service region. Note: The caller needs to ensure that the authorization token is valid. Before the authorization token expipres, the caller needs to refresh it by calling this setter with a new valid token. Otherwise, all the recognizers created by this SpeechTranslationConfig instance will encounter errors during recognition."
returns:
description: "The speech config"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig?alt=com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig&text=SpeechTranslationConfig\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.fromEndpoint(java.net.URI)"
fullName: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.fromEndpoint(URI endpoint)"
name: "fromEndpoint(URI endpoint)"
nameWithType: "SpeechTranslationConfig.fromEndpoint(URI endpoint)"
summary: "Creates an instance of the speech translation config with specified endpoint."
modifiers:
- "static"
parameters:
- description: "The service endpoint to connect to."
name: "endpoint"
type: "<xref href=\"java.net.URI?alt=java.net.URI&text=URI\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static SpeechTranslationConfig fromEndpoint(URI endpoint)"
desc: "Creates an instance of the speech translation config with specified endpoint. This method is intended only for users who use a non-standard service endpoint or parameters. Note: The query parameters specified in the endpoint URI are not changed, even if they are set by any other APIs. For example, if the recognition language is defined in URI as query parameter \"language=de-DE\", and also set by setSpeechRecognitionLanguage(\"en-US\"), the language setting in URI takes precedence, and the effective language is \"de-DE\". Only the parameters that are not specified in the endpoint URI can be set by other APIs. Note: if the endpoint requires a subscription key for authentication, please use fromEndpoint(java.net.URI, String) to pass the subscription key as parameter. To use an authorization token with fromEndpoint, please use this method to create a SpeechTranslationConfig instance, and then call setAuthorizationToken() on the created SpeechTranslationConfig instance. Note: Added in version 1.5.0."
returns:
description: "A SpeechTranslationConfig instance."
type: "<xref href=\"com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig?alt=com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig&text=SpeechTranslationConfig\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.fromEndpoint(java.net.URI,java.lang.String)"
fullName: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.fromEndpoint(URI endpoint, String subscriptionKey)"
name: "fromEndpoint(URI endpoint, String subscriptionKey)"
nameWithType: "SpeechTranslationConfig.fromEndpoint(URI endpoint, String subscriptionKey)"
summary: "Creates an instance of the speech translation config with specified endpoint and subscription key."
modifiers:
- "static"
parameters:
- description: "The service endpoint to connect to."
name: "endpoint"
type: "<xref href=\"java.net.URI?alt=java.net.URI&text=URI\" data-throw-if-not-resolved=\"False\" />"
- description: "The subscription key."
name: "subscriptionKey"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static SpeechTranslationConfig fromEndpoint(URI endpoint, String subscriptionKey)"
desc: "Creates an instance of the speech translation config with specified endpoint and subscription key. This method is intended only for users who use a non-standard service endpoint or parameters. Note: The query parameters specified in the endpoint URI are not changed, even if they are set by any other APIs. For example, if the recognition language is defined in URI as query parameter \"language=de-DE\", and also set by setSpeechRecognitionLanguage(\"en-US\"), the language setting in URI takes precedence, and the effective language is \"de-DE\". Only the parameters that are not specified in the endpoint URI can be set by other APIs. Note: To use an authorization token with fromEndpoint, please use fromEndpoint(java.net.URI), and then call setAuthorizationToken() on the created SpeechTranslationConfig instance."
returns:
description: "A SpeechTranslationConfig instance."
type: "<xref href=\"com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig?alt=com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig&text=SpeechTranslationConfig\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.fromHost(java.net.URI)"
fullName: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.fromHost(URI host)"
name: "fromHost(URI host)"
nameWithType: "SpeechTranslationConfig.fromHost(URI host)"
summary: "Creates an instance of the speech translation config with specified host."
modifiers:
- "static"
parameters:
- description: "The service host to connect to. Format is \"protocol://host:port\" where \":port\" is optional."
name: "host"
type: "<xref href=\"java.net.URI?alt=java.net.URI&text=URI\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static SpeechTranslationConfig fromHost(URI host)"
desc: "Creates an instance of the speech translation config with specified host. This method is intended only for users who use a non-default service host. Standard resource path will be assumed. For services with a non-standard resource path or no path at all, use fromEndpoint instead. Note: Query parameters are not allowed in the host URI and must be set by other APIs. Note: If the host requires a subscription key for authentication, use fromHost(java.net.URI, String) to pass the subscription key as parameter. To use an authorization token with fromHost, use this method to create a SpeechTranslationConfig instance, and then call setAuthorizationToken() on the created SpeechTranslationConfig instance. Note: Added in version 1.8.0."
returns:
description: "A SpeechTranslationConfig instance."
type: "<xref href=\"com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig?alt=com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig&text=SpeechTranslationConfig\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.fromHost(java.net.URI,java.lang.String)"
fullName: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.fromHost(URI host, String subscriptionKey)"
name: "fromHost(URI host, String subscriptionKey)"
nameWithType: "SpeechTranslationConfig.fromHost(URI host, String subscriptionKey)"
summary: "Creates an instance of the speech translation config with specified host and subscription key."
modifiers:
- "static"
parameters:
- description: "The service host to connect to. Format is \"protocol://host:port\" where \":port\" is optional."
name: "host"
type: "<xref href=\"java.net.URI?alt=java.net.URI&text=URI\" data-throw-if-not-resolved=\"False\" />"
- description: "The subscription key."
name: "subscriptionKey"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static SpeechTranslationConfig fromHost(URI host, String subscriptionKey)"
desc: "Creates an instance of the speech translation config with specified host and subscription key. This method is intended only for users who use a non-default service host. Standard resource path will be assumed. For services with a non-standard resource path or no path at all, use fromEndpoint instead. Note: Query parameters are not allowed in the host URI and must be set by other APIs. Note: To use an authorization token with fromHost, use fromHost(java.net.URI), and then call setAuthorizationToken() on the created SpeechTranslationConfig instance. Note: Added in version 1.8.0."
returns:
description: "A SpeechTranslationConfig instance."
type: "<xref href=\"com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig?alt=com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig&text=SpeechTranslationConfig\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.fromSubscription(java.lang.String,java.lang.String)"
fullName: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.fromSubscription(String subscriptionKey, String region)"
name: "fromSubscription(String subscriptionKey, String region)"
nameWithType: "SpeechTranslationConfig.fromSubscription(String subscriptionKey, String region)"
summary: "Static instance of Speech<wbr>Translation<wbr>Config returned by passing subscription<wbr>Key and service region."
modifiers:
- "static"
parameters:
- description: "The subscription key."
name: "subscriptionKey"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The region name (see the <a href=\"https://aka.ms/csspeech/region\">region page</a>)."
name: "region"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static SpeechTranslationConfig fromSubscription(String subscriptionKey, String region)"
desc: "Static instance of SpeechTranslationConfig returned by passing subscriptionKey and service region."
returns:
description: "The speech config"
type: "<xref href=\"com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig?alt=com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig&text=SpeechTranslationConfig\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.getImpl()"
fullName: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.getImpl()"
name: "getImpl()"
nameWithType: "SpeechTranslationConfig.getImpl()"
summary: "Returns the speech translation config implementation"
overridden: "com.microsoft.cognitiveservices.speech.SpeechConfig.getImpl()"
syntax: "public SafeHandle getImpl()"
desc: "Returns the speech translation config implementation"
returns:
description: "The implementation of the speech translation config."
type: "<xref href=\"com.microsoft.cognitiveservices.speech.util.SafeHandle?alt=com.microsoft.cognitiveservices.speech.util.SafeHandle&text=SafeHandle\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.getTargetLanguages()"
fullName: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.getTargetLanguages()"
name: "getTargetLanguages()"
nameWithType: "SpeechTranslationConfig.getTargetLanguages()"
summary: "Gets all target languages that have been configured for translation."
syntax: "public ArrayList<String> getTargetLanguages()"
desc: "Gets all target languages that have been configured for translation."
returns:
description: "the list of target languages."
type: "<xref href=\"java.util.ArrayList?alt=java.util.ArrayList&text=ArrayList\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.getVoiceName()"
fullName: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.getVoiceName()"
name: "getVoiceName()"
nameWithType: "SpeechTranslationConfig.getVoiceName()"
summary: "Returns the selected voice name."
syntax: "public String getVoiceName()"
desc: "Returns the selected voice name."
returns:
description: "The voice name."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.removeTargetLanguage(java.lang.String)"
fullName: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.removeTargetLanguage(String value)"
name: "removeTargetLanguage(String value)"
nameWithType: "SpeechTranslationConfig.removeTargetLanguage(String value)"
summary: "Removes a (text) target language for translation."
parameters:
- description: "the language identifier in BCP-47 format."
name: "value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void removeTargetLanguage(String value)"
desc: "Removes a (text) target language for translation. Added in version 1.7.0."
- uid: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.setCustomModelCategoryId(java.lang.String)"
fullName: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.setCustomModelCategoryId(String categoryId)"
name: "setCustomModelCategoryId(String categoryId)"
nameWithType: "SpeechTranslationConfig.setCustomModelCategoryId(String categoryId)"
summary: "Sets a Category Id that will be passed to service."
parameters:
- description: "the category Id."
name: "categoryId"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setCustomModelCategoryId(String categoryId)"
desc: "Sets a Category Id that will be passed to service. Category Id is used to find the custom model."
- uid: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.setVoiceName(java.lang.String)"
fullName: "com.microsoft.cognitiveservices.speech.translation.SpeechTranslationConfig.setVoiceName(String value)"
name: "setVoiceName(String value)"
nameWithType: "SpeechTranslationConfig.setVoiceName(String value)"
summary: "Sets voice of the translated language, enable voice synthesis output."
parameters:
- description: "the voice name of synthesis output"
name: "value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setVoiceName(String value)"
desc: "Sets voice of the translated language, enable voice synthesis output."
type: "class"
desc: "Speech translation configuration. Note: close() must be called in order to release underlying resources held by the object."
implements:
- "<xref href=\"java.lang.AutoCloseable?alt=java.lang.AutoCloseable&text=AutoCloseable\" data-throw-if-not-resolved=\"False\" />"
metadata: {}
package: "com.microsoft.cognitiveservices.speech.translation"
artifact: com.microsoft.cognitiveservices.speech:client-sdk:1.38.0