import { OutputFormat, ProfanityOption, PropertyCollection, PropertyId, ServicePropertyChannel } from "./Exports";
/**
* Speech configuration.
* @class SpeechConfig
*/
export declare abstract class SpeechConfig {
/**
* Creates and initializes an instance.
* @constructor
*/
protected constructor();
/**
* Static instance of SpeechConfig returned by passing subscriptionKey and service region.
* Note: Please use your LanguageUnderstanding subscription key in case you want to use the Intent recognizer.
* @member SpeechConfig.fromSubscription
* @function
* @public
* @param {string} subscriptionKey - The subscription key.
* @param {string} region - The region name (see the region page).
* @returns {SpeechConfig} The speech factory
*/
static fromSubscription(subscriptionKey: string, region: string): SpeechConfig;
/**
* Creates an instance of the speech config with specified endpoint and subscription key.
* This method is intended only for users who use a non-standard service endpoint or parameters.
* Note: Please use your LanguageUnderstanding subscription key in case you want to use the Intent recognizer.
* Note: The query parameters 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
* SpeechConfig.speechRecognitionLanguage = "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 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 SpeechConfig.fromEndpoint
* @function
* @public
* @param {URL} endpoint - The service endpoint to connect to.
* @param {string} subscriptionKey - The subscription key. If a subscription key is not specified, an authorization token must be set.
* @returns {SpeechConfig} A speech factory instance.
*/
static fromEndpoint(endpoint: URL, subscriptionKey?: string): SpeechConfig;
/**
* Creates an instance of the speech factory with specified initial authorization token and 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 calling this setter with a new valid token.
* Note: Please use a token derived from your LanguageUnderstanding subscription key in case you want
* to use the Intent recognizer. 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 SpeechConfig.fromAuthorizationToken
* @function
* @public
* @param {string} authorizationToken - The initial authorization token.
* @param {string} region - The region name (see the region page).
* @returns {SpeechConfig} A speech factory instance.
*/
static fromAuthorizationToken(authorizationToken: string, region: string): SpeechConfig;
/**
* Sets the proxy configuration.
* Only relevant in Node.js environments.
* Added in version 1.4.0.
* @param proxyHostName The host name of the proxy server.
* @param proxyPort The port number of the proxy server.
*/
abstract setProxy(proxyHostName: string, proxyPort: number): void;
/**
* Sets the proxy configuration.
* Only relevant in Node.js environments.
* Added in version 1.4.0.
* @param proxyHostName The host name of the proxy server, without the protocol scheme (http://)
* @param porxyPort The port number of the proxy server.
* @param proxyUserName The user name of the proxy server.
* @param proxyPassword The password of the proxy server.
*/
abstract setProxy(proxyHostName: string, proxyPort: number, proxyUserName: string, proxyPassword: string): void;
/**
* Gets the authorization token.
* @member SpeechConfig.prototype.authorizationToken
* @function
* @public
*/
/**
* Gets/Sets the authorization token.
* 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.
* @member SpeechConfig.prototype.authorizationToken
* @function
* @public
* @param {string} value - The authorization token.
*/
abstract authorizationToken: string;
/**
* Returns the configured language.
* @member SpeechConfig.prototype.speechRecognitionLanguage
* @function
* @public
*/
/**
* Gets/Sets the input language.
* @member SpeechConfig.prototype.speechRecognitionLanguage
* @function
* @public
* @param {string} value - The authorization token.
*/
abstract speechRecognitionLanguage: string;
/**
* Sets an arbitrary property.
* @member SpeechConfig.prototype.setProperty
* @function
* @public
* @param {string} name - The name of the property to set.
* @param {string} value - The new value of the property.
*/
abstract setProperty(name: string, value: string): void;
/**
* Returns the current value of an arbitrary property.
* @member SpeechConfig.prototype.getProperty
* @function
* @public
* @param {string} name - The name of the property to query.
* @param {string} def - The value to return in case the property is not known.
* @returns {string} The current value, or provided default, of the given property.
*/
abstract getProperty(name: string, def?: string): string;
/**
* Gets output format.
* @member SpeechConfig.prototype.outputFormat
* @function
* @public
* @returns {OutputFormat} Returns the output format.
*/
/**
* Gets/Sets the output format.
* @member SpeechConfig.prototype.outputFormat
* @function
* @public
*/
abstract outputFormat: OutputFormat;
/**
* Gets the endpoint ID of a customized speech model that is used for speech recognition.
* @member SpeechConfig.prototype.endpointId
* @function
* @public
* @return {string} The endpoint ID
*/
/**
* Gets/Sets the endpoint ID of a customized speech model that is used for speech recognition.
* @member SpeechConfig.prototype.endpointId
* @function
* @public
* @param {string} value - The endpoint ID
*/
abstract endpointId: string;
/**
* Closes the configuration.
* @member SpeechConfig.prototype.close
* @function
* @public
*/
close(): void;
/**
* @member SpeechConfig.prototype.subscriptionKey
* @function
* @public
* @return {SubscriptionKey} The subscription key set on the config.
*/
abstract readonly subscriptionKey: string;
/**
* @member SpeechConfig.prototype.region
* @function
* @public
* @return {region} The region set on the config.
*/
abstract readonly region: string;
/**
* @member SpeechConfig.prototype.setServiceProperty
* @function
* @public
* @param {name} The name of the property.
* @param {value} Value to set.
* @param {channel} The channel used to pass the specified property to service.
* @summary Sets a property value that will be passed to service using the specified channel.
* Added in version 1.7.0.
*/
abstract setServiceProperty(name: string, value: string, channel: ServicePropertyChannel): void;
/**
* @member SpeechConfig.prototype.setProfanity
* @function
* @public
* @param {profanity} Profanity option to set.
* @summary Sets profanity option.
* Added in version 1.7.0.
*/
abstract setProfanity(profanity: ProfanityOption): void;
/**
* @member SpeechConfig.prototype.enableAudioLogging
* @function
* @public
* @summary Enable audio logging in service.
* Added in version 1.7.0.
*/
abstract enableAudioLogging(): void;
/**
* @member SpeechConfig.prototype.requestWordLevelTimestamps
* @function
* @public
* @summary Includes word-level timestamps.
* Added in version 1.7.0.
*/
abstract requestWordLevelTimestamps(): void;
/**
* @member SpeechConfig.prototype.enableDictation
* @function
* @public
* @summary Enable dictation. Only supported in speech continuous recognition.
* Added in version 1.7.0.
*/
abstract enableDictation(): void;
}
/**
* @public
* @class SpeechConfigImpl
*/
export declare class SpeechConfigImpl extends SpeechConfig {
private privProperties;
constructor();
readonly properties: PropertyCollection;
readonly endPoint: URL;
readonly subscriptionKey: string;
readonly region: string;
authorizationToken: string;
speechRecognitionLanguage: string;
outputFormat: OutputFormat;
endpointId: string;
setProperty(name: string | PropertyId, value: string): void;
getProperty(name: string | PropertyId, def?: string): string;
setProxy(proxyHostName: string, proxyPort: number): void;
setProxy(proxyHostName: string, proxyPort: number, proxyUserName: string, proxyPassword: string): void;
setServiceProperty(name: string, value: string, channel: ServicePropertyChannel): void;
setProfanity(profanity: ProfanityOption): void;
enableAudioLogging(): void;
requestWordLevelTimestamps(): void;
enableDictation(): void;
clone(): SpeechConfigImpl;
}