Package com.microsoft.cognitiveservices.speech.dialog

Class DialogServiceConfig

java.lang.Object

com.microsoft.cognitiveservices.speech.SpeechConfig

com.microsoft.cognitiveservices.speech.dialog.DialogServiceConfig

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

BotFrameworkConfig, CustomCommandsConfig

public class DialogServiceConfig
extends SpeechConfig
implements AutoCloseable

Class that defines base configurations for dialog service connector. Note: close() must be called in order to release underlying resources held by the object.

Field Summary

Fields inherited from class com.microsoft.cognitiveservices.speech.SpeechConfig

speechConfigClass

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DialogServiceConfig(long handleValue)	Creates an instance of dialog service config.

Method Summary

Modifier and Type	Method	Description
void	close()	Dispose of associated resources.
SafeHandle	getImpl()	Returns the dialog service configuration.
String	getLanguage()	Gets the language
String	getProperty(PropertyId id)	Gets the property by propertyId.
String	getProperty(String name)	Gets a named property as value.
void	setLanguage(String value)	Sets the language
void	setProperty(PropertyId id, String value)	Sets the property by propertyId.
void	setProperty(String name, String value)	Sets a named property as value.
void	setProxy(String proxyHostName, int proxyPort, String proxyUserName, String proxyPassword)	Sets proxy configuration Note: Proxy functionality is not available on macOS.
void	setServiceProperty(String name, String value, ServicePropertyChannel channel)	Sets a property value that will be passed to service using the specified channel.

Methods inherited from class com.microsoft.cognitiveservices.speech.SpeechConfig

enableAudioLogging, enableDictation, fromAuthorizationToken, fromEndpoint, fromEndpoint, fromHost, fromHost, fromSubscription, getAuthorizationToken, getEndpointId, getOutputFormat, getSpeechRecognitionLanguage, getSpeechSynthesisLanguage, getSpeechSynthesisOutputFormat, getSpeechSynthesisVoiceName, requestWordLevelTimestamps, setAuthorizationToken, setEndpointId, setOutputFormat, setProfanity, setSpeechRecognitionLanguage, setSpeechSynthesisLanguage, setSpeechSynthesisOutputFormat, setSpeechSynthesisVoiceName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DialogServiceConfig

protected DialogServiceConfig(long handleValue)

Creates an instance of dialog service config.

Parameters:

handleValue - The native handle

Method Detail

setProxy

public void setProxy(String proxyHostName,
                     int proxyPort,
                     String proxyUserName,
                     String proxyPassword)

Sets proxy configuration Note: Proxy functionality is not available on macOS. This function will have no effect on this platform.

Overrides:

setProxy in class SpeechConfig

Parameters:

proxyHostName - the host name of the proxy server, without the protocol scheme (http://)

proxyPort - the port number of the proxy server.

proxyUserName - the user name of the proxy server. Use empty string if no user name is needed.

proxyPassword - the password of the proxy server. Use empty string if no user password is needed.

setProperty

public void setProperty(String name,
                        String value)

Sets a named property as value.

Overrides:

setProperty in class SpeechConfig

Parameters:

name - the name of the property.

value - the value.

setProperty

public void setProperty(PropertyId id,
                        String value)

Sets the property by propertyId.

Overrides:

setProperty in class SpeechConfig

Parameters:

id - PropertyId of the property.

value - The value.

getProperty

public String getProperty(String name)

Gets a named property as value.

Overrides:

getProperty in class SpeechConfig

Parameters:

name - the name of the property.

Returns:

The value.

getProperty

public String getProperty(PropertyId id)

Gets the property by propertyId.

Overrides:

getProperty in class SpeechConfig

Parameters:

id - PropertyId of the property.

Returns:

The value.

setServiceProperty

public void setServiceProperty(String name,
                               String value,
                               ServicePropertyChannel channel)

Sets a property value that will be passed to service using the specified channel.

Overrides:

setServiceProperty in class SpeechConfig

Parameters:

name - the property name.

value - the property value.

channel - the channel used to pass the specified property to service.

setLanguage

public void setLanguage(String value)

Sets the language

Parameters:

value - the language identifier in BCP-47 format.

getLanguage

public String getLanguage()

Gets the language

Returns:

Returns the language.

close

public void close()

Dispose of associated resources.

Specified by:

close in interface AutoCloseable

Overrides:

close in class SpeechConfig

getImpl

public SafeHandle getImpl()

Returns the dialog service configuration.

Overrides:

getImpl in class SpeechConfig

Returns:

The implementation of the config.