Package com.vonage.client.voice.ncco

Class SpeechSettings

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.voice.ncco.SpeechSettings

All Implemented Interfaces:

Jsonable

public class SpeechSettings
extends JsonableBaseObject

ASR (Automatic Speech Recognition) settings for Input Actions that will be added to a NCCO object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SpeechSettings.Builder	Builder for customising SpeechSettings parameters.
static enum	SpeechSettings.Language

Constructor Summary

Constructors

Constructor	Description
SpeechSettings()	Deprecated. This will be made private in a future release.

Method Summary

Modifier and Type	Method	Description
static SpeechSettings.Builder	builder()	Entry point for constructing an instance of this class.
Collection<String>	getContext()
Double	getEndOnSilence()
SpeechSettings.Language	getLanguage()
Integer	getMaxDuration()
Boolean	getSaveAudio()
Integer	getSensitivity()
Integer	getStartTimeout()
Collection<String>	getUuid()
void	setContext(Collection<String> context)	Deprecated. Use SpeechSettings.Builder.context(Collection).
void	setEndOnSilence(Integer endOnSilence)	Deprecated. Use SpeechSettings.Builder.endOnSilence(double).
void	setLanguage(SpeechSettings.Language language)	Deprecated. Use SpeechSettings.Builder.language(Language).
void	setMaxDuration(Integer maxDuration)	Deprecated. Use SpeechSettings.Builder.maxDuration(int).
void	setStartTimeout(Integer startTimeout)	Deprecated. Use SpeechSettings.Builder.startTimeout(int).
void	setUuid(Collection<String> uuid)	Deprecated. Use SpeechSettings.Builder.uuid(String).

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Constructor Details

SpeechSettings

@Deprecated
public SpeechSettings()

Deprecated.

This will be made private in a future release. Use builder().

Method Details

getUuid

public Collection<String> getUuid()

getLanguage

public SpeechSettings.Language getLanguage()

getContext

public Collection<String> getContext()

getEndOnSilence

public Double getEndOnSilence()

getStartTimeout

public Integer getStartTimeout()

getMaxDuration

public Integer getMaxDuration()

getSensitivity

public Integer getSensitivity()

getSaveAudio

public Boolean getSaveAudio()

setLanguage

@Deprecated
public void setLanguage(SpeechSettings.Language language)

Deprecated.

Use SpeechSettings.Builder.language(Language). This will be removed in a future release.

Parameters:

language - expected language of the user's speech. If empty, default value is en-US.

setUuid

@Deprecated
public void setUuid(Collection<String> uuid)

Deprecated.

Use SpeechSettings.Builder.uuid(String). This will be removed in a future release.

Parameters:

uuid - The unique ID of the Call leg for the user to capture the speech of, wrapped in a collection.

setContext

@Deprecated
public void setContext(Collection<String> context)

Deprecated.

Use SpeechSettings.Builder.context(Collection). This will be removed in a future release.

List of hints to improve recognition quality if certain words are expected from the user.

Parameters:

context - list of hints

setEndOnSilence

@Deprecated
public void setEndOnSilence(Integer endOnSilence)

Deprecated.

Use SpeechSettings.Builder.endOnSilence(double). This will be removed in a future release.

Controls how long the system will wait after user stops speaking to decide the input is completed. Timeout range 1-10 seconds. If empty,Default value is 2

Parameters:

endOnSilence - wait time for voice input to complete

setStartTimeout

@Deprecated
public void setStartTimeout(Integer startTimeout)

Deprecated.

Use SpeechSettings.Builder.startTimeout(int). This will be removed in a future release.

Controls how long the system will wait for the user to start speaking. Timeout range 1-10 seconds.

Parameters:

startTimeout - timeout for voice input initiation

setMaxDuration

@Deprecated
public void setMaxDuration(Integer maxDuration)

Deprecated.

Use SpeechSettings.Builder.maxDuration(int). This will be removed in a future release.

Controls maximum speech duration from the moment user starts speaking. Default value is 60

Parameters:

maxDuration - speech duration starting from user's initiation of speech

builder

public static SpeechSettings.Builder builder()

Entry point for constructing an instance of this class.

Returns:

A new Builder.

Since:

8.2.0