@euirim/microsoft-cognitiveservices-speech-sdk
Version:
Microsoft Cognitive Services Speech SDK for JavaScript
291 lines (289 loc) • 12.5 kB
JavaScript
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.
import { ForceDictationPropertyName, OutputFormatPropertyName, ServicePropertiesPropertyName } from "../common.speech/Exports";
import { Contracts } from "./Contracts";
import { OutputFormat, ProfanityOption, PropertyCollection, PropertyId, SpeechConfig, } from "./Exports";
/**
* Speech translation configuration.
* @class SpeechTranslationConfig
*/
export class SpeechTranslationConfig extends SpeechConfig {
/**
* Creates an instance of recognizer config.
*/
constructor() {
super();
}
/**
* Static instance of SpeechTranslationConfig returned by passing a subscription key and service region.
* @member SpeechTranslationConfig.fromSubscription
* @function
* @public
* @param {string} subscriptionKey - The subscription key.
* @param {string} region - The region name (see the <a href="https://aka.ms/csspeech/region">region page</a>).
* @returns {SpeechTranslationConfig} The speech translation config.
*/
static fromSubscription(subscriptionKey, region) {
Contracts.throwIfNullOrWhitespace(subscriptionKey, "subscriptionKey");
Contracts.throwIfNullOrWhitespace(region, "region");
const ret = new SpeechTranslationConfigImpl();
ret.properties.setProperty(PropertyId.SpeechServiceConnection_Key, subscriptionKey);
ret.properties.setProperty(PropertyId.SpeechServiceConnection_Region, region);
return ret;
}
/**
* 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
* expires, the caller needs to refresh it by setting the property authorizationToken with a new
* valid token. Otherwise, all the recognizers created by this SpeechTranslationConfig instance
* will encounter errors during recognition.
* As configuration values are copied when creating a new recognizer, the new token value will not apply
* to recognizers that have already been created.
* For recognizers that have been created before, you need to set authorization token of the corresponding recognizer
* to refresh the token. Otherwise, the recognizers will encounter errors during recognition.
* @member SpeechTranslationConfig.fromAuthorizationToken
* @function
* @public
* @param {string} authorizationToken - The authorization token.
* @param {string} region - The region name (see the <a href="https://aka.ms/csspeech/region">region page</a>).
* @returns {SpeechTranslationConfig} The speech translation config.
*/
static fromAuthorizationToken(authorizationToken, region) {
Contracts.throwIfNullOrWhitespace(authorizationToken, "authorizationToken");
Contracts.throwIfNullOrWhitespace(region, "region");
const ret = new SpeechTranslationConfigImpl();
ret.properties.setProperty(PropertyId.SpeechServiceAuthorization_Token, authorizationToken);
ret.properties.setProperty(PropertyId.SpeechServiceConnection_Region, region);
return ret;
}
/**
* 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 paramters.
* Note: The query properties specified in the endpoint URL are not changed, even if they are
* set by any other APIs. For example, if language is defined in the uri as query parameter
* "language=de-DE", and also set by the speechRecognitionLanguage property, the language
* setting in uri takes precedence, and the effective language is "de-DE".
* Only the properties that are not specified in the endpoint URL can be set by other APIs.
* Note: To use authorization token with fromEndpoint, pass an empty string to the subscriptionKey in the
* fromEndpoint method, and then set authorizationToken="token" on the created SpeechConfig instance to
* use the authorization token.
* @member SpeechTranslationConfig.fromEndpoint
* @function
* @public
* @param {URL} endpoint - The service endpoint to connect to.
* @param {string} subscriptionKey - The subscription key.
* @returns {SpeechTranslationConfig} A speech config instance.
*/
static fromEndpoint(endpoint, subscriptionKey) {
Contracts.throwIfNull(endpoint, "endpoint");
Contracts.throwIfNull(subscriptionKey, "subscriptionKey");
const ret = new SpeechTranslationConfigImpl();
ret.properties.setProperty(PropertyId.SpeechServiceConnection_Endpoint, endpoint.href);
ret.properties.setProperty(PropertyId.SpeechServiceConnection_Key, subscriptionKey);
return ret;
}
}
/**
* @private
* @class SpeechTranslationConfigImpl
*/
// tslint:disable-next-line:max-classes-per-file
export class SpeechTranslationConfigImpl extends SpeechTranslationConfig {
constructor() {
super();
this.privSpeechProperties = new PropertyCollection();
this.outputFormat = OutputFormat.Simple;
}
/**
* Gets/Sets the authorization token.
* If this is set, subscription key is ignored.
* User needs to make sure the provided authorization token is valid and not expired.
* @member SpeechTranslationConfigImpl.prototype.authorizationToken
* @function
* @public
* @param {string} value - The authorization token.
*/
set authorizationToken(value) {
Contracts.throwIfNullOrWhitespace(value, "value");
this.privSpeechProperties.setProperty(PropertyId.SpeechServiceAuthorization_Token, value);
}
/**
* Gets/Sets the speech recognition language.
* @member SpeechTranslationConfigImpl.prototype.speechRecognitionLanguage
* @function
* @public
* @param {string} value - The authorization token.
*/
set speechRecognitionLanguage(value) {
Contracts.throwIfNullOrWhitespace(value, "value");
this.privSpeechProperties.setProperty(PropertyId.SpeechServiceConnection_RecoLanguage, value);
}
/**
* @member SpeechTranslationConfigImpl.prototype.subscriptionKey
* @function
* @public
*/
get subscriptionKey() {
return this.privSpeechProperties.getProperty(PropertyId[PropertyId.SpeechServiceConnection_Key]);
}
/**
* Gets the output format
* @member SpeechTranslationConfigImpl.prototype.outputFormat
* @function
* @public
*/
get outputFormat() {
return OutputFormat[this.privSpeechProperties.getProperty(OutputFormatPropertyName, undefined)];
}
/**
* Gets/Sets the output format
* @member SpeechTranslationConfigImpl.prototype.outputFormat
* @function
* @public
*/
set outputFormat(value) {
this.privSpeechProperties.setProperty(OutputFormatPropertyName, OutputFormat[value]);
}
/**
* Gets the endpoint id.
* @member SpeechTranslationConfigImpl.prototype.endpointId
* @function
* @public
*/
get endpointId() {
return this.privSpeechProperties.getProperty(PropertyId.SpeechServiceConnection_EndpointId);
}
/**
* Gets/Sets the endpoint id.
* @member SpeechTranslationConfigImpl.prototype.endpointId
* @function
* @public
*/
set endpointId(value) {
this.privSpeechProperties.setProperty(PropertyId.SpeechServiceConnection_Endpoint, value);
}
/**
* Add a (text) target language to translate into.
* @member SpeechTranslationConfigImpl.prototype.addTargetLanguage
* @function
* @public
* @param {string} value - The language such as de-DE
*/
addTargetLanguage(value) {
Contracts.throwIfNullOrWhitespace(value, "value");
const languages = this.targetLanguages;
languages.push(value);
this.privSpeechProperties.setProperty(PropertyId.SpeechServiceConnection_TranslationToLanguages, languages.join(","));
}
/**
* Gets the (text) target language to translate into.
* @member SpeechTranslationConfigImpl.prototype.targetLanguages
* @function
* @public
* @param {string} value - The language such as de-DE
*/
get targetLanguages() {
if (this.privSpeechProperties.getProperty(PropertyId.SpeechServiceConnection_TranslationToLanguages, undefined) !== undefined) {
return this.privSpeechProperties.getProperty(PropertyId.SpeechServiceConnection_TranslationToLanguages).split(",");
}
else {
return [];
}
}
/**
* Gets the voice name.
* @member SpeechTranslationConfigImpl.prototype.voiceName
* @function
* @public
*/
get voiceName() {
return this.getProperty(PropertyId[PropertyId.SpeechServiceConnection_TranslationVoice]);
}
/**
* Gets/Sets the voice of the translated language, enable voice synthesis output.
* @member SpeechTranslationConfigImpl.prototype.voiceName
* @function
* @public
* @param {string} value - The name of the voice.
*/
set voiceName(value) {
Contracts.throwIfNullOrWhitespace(value, "value");
this.privSpeechProperties.setProperty(PropertyId.SpeechServiceConnection_TranslationVoice, value);
}
/**
* Provides the region.
* @member SpeechTranslationConfigImpl.prototype.region
* @function
* @public
* @returns {string} The region.
*/
get region() {
return this.privSpeechProperties.getProperty(PropertyId.SpeechServiceConnection_Region);
}
setProxy(proxyHostName, proxyPort, proxyUserName, proxyPassword) {
this.setProperty(PropertyId[PropertyId.SpeechServiceConnection_ProxyHostName], proxyHostName);
this.setProperty(PropertyId[PropertyId.SpeechServiceConnection_ProxyPort], proxyPort);
this.setProperty(PropertyId[PropertyId.SpeechServiceConnection_ProxyUserName], proxyUserName);
this.setProperty(PropertyId[PropertyId.SpeechServiceConnection_ProxyPassword], proxyPassword);
}
/**
* Gets an arbitrary property value.
* @member SpeechTranslationConfigImpl.prototype.getProperty
* @function
* @public
* @param {string} name - The name of the property.
* @param {string} def - The default value of the property in case it is not set.
* @returns {string} The value of the property.
*/
getProperty(name, def) {
return this.privSpeechProperties.getProperty(name, def);
}
/**
* Gets/Sets an arbitrary property value.
* @member SpeechTranslationConfigImpl.prototype.setProperty
* @function
* @public
* @param {string} name - The name of the property.
* @param {string} value - The value of the property.
*/
setProperty(name, value) {
this.privSpeechProperties.setProperty(name, value);
}
/**
* Provides access to custom properties.
* @member SpeechTranslationConfigImpl.prototype.properties
* @function
* @public
* @returns {PropertyCollection} The properties.
*/
get properties() {
return this.privSpeechProperties;
}
/**
* Dispose of associated resources.
* @member SpeechTranslationConfigImpl.prototype.close
* @function
* @public
*/
close() {
return;
}
setServiceProperty(name, value, channel) {
const currentProperties = JSON.parse(this.privSpeechProperties.getProperty(ServicePropertiesPropertyName, "{}"));
currentProperties[name] = value;
this.privSpeechProperties.setProperty(ServicePropertiesPropertyName, JSON.stringify(currentProperties));
}
setProfanity(profanity) {
this.privSpeechProperties.setProperty(PropertyId.SpeechServiceResponse_ProfanityOption, ProfanityOption[profanity]);
}
enableAudioLogging() {
this.privSpeechProperties.setProperty(PropertyId.SpeechServiceConnection_EnableAudioLogging, "true");
}
requestWordLevelTimestamps() {
this.privSpeechProperties.setProperty(PropertyId.SpeechServiceResponse_RequestWordLevelTimestamps, "true");
}
enableDictation() {
this.privSpeechProperties.setProperty(ForceDictationPropertyName, "true");
}
}
//# sourceMappingURL=SpeechTranslationConfig.js.map