cisco.uc.cuae.legacy
Class MediaControl.VoiceRecognitionOptions

java.lang.Object
  cisco.uc.cuae.legacy.MediaControl.VoiceRecognitionOptions

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

MediaControl

public static class MediaControl.VoiceRecognitionOptions
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

MediaControl.AudioFileEncoding	audioFileEncoding The encoding of the audio file: ulaw, alaw, pcm, or adpcm.
java.lang.Long	audioFileSampleRate The sample rate of the audio file (in kHz).
java.lang.Long	audioFileSampleSize The sample size used in the audio file (in bits).
java.lang.Long	commandTimeout Indicates a command timeout value (in milliseconds).
java.lang.String[]	grammars Grammars
java.lang.String[]	prompts Prompts
java.lang.Integer	speed The amount by which to modify the speed of audio playback.
java.lang.String	state8 Optional user state information which is guaranteed present as the State event parameter in VoiceRecognition_Complete or VoiceRecognition_Failed.
java.lang.Long	termCondMaxTime The amount of time (in milliseconds) that can elapse before terminating the voice recognition operation.
java.lang.Long	termCondNonSilence The amount of non-silence (in milliseconds) to observe before terminating the voice recognition operation.
java.lang.Long	termCondSilence The amount of silence (in milliseconds) to observe before terminating the record operation.
java.lang.Integer	timeout The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action.
java.lang.Integer	volume The amount by which to modify the volume (in decibels) of audio playback.

Constructor Summary

MediaControl.VoiceRecognitionOptions()
Constructs the VoiceRecognitionOptions.

MediaControl.VoiceRecognitionOptions(java.lang.Long termCondNonSilence, java.lang.String[] grammars, java.lang.Long commandTimeout, java.lang.Integer volume, java.lang.Integer speed, java.lang.String state8, java.lang.Long termCondSilence, java.lang.Long audioFileSampleRate, java.lang.Long audioFileSampleSize, MediaControl.AudioFileEncoding audioFileEncoding, java.lang.String[] prompts, java.lang.Integer timeout, java.lang.Long termCondMaxTime)
Constructs the VoiceRecognitionOptions.

Method Summary

MediaControl.AudioFileEncoding	getAudioFileEncoding() Gets the value.
java.lang.Long	getAudioFileSampleRate() Gets the value.
java.lang.Long	getAudioFileSampleSize() Gets the value.
java.lang.Long	getCommandTimeout() Gets the value.
java.lang.String[]	getGrammars() Gets the value.
java.lang.String[]	getPrompts() Gets the value.
java.lang.Integer	getSpeed() Gets the value.
java.lang.String	getState8() Gets the value.
java.lang.Long	getTermCondMaxTime() Gets the value.
java.lang.Long	getTermCondNonSilence() Gets the value.
java.lang.Long	getTermCondSilence() Gets the value.
java.lang.Integer	getTimeout() Gets the value.
java.lang.Integer	getVolume() Gets the value.
void	setAudioFileEncoding(MediaControl.AudioFileEncoding value) Sets the value.
void	setAudioFileSampleRate(java.lang.Long value) Sets the value.
void	setAudioFileSampleSize(java.lang.Long value) Sets the value.
void	setCommandTimeout(java.lang.Long value) Sets the value.
void	setGrammars(java.lang.String[] value) Sets the value.
void	setPrompts(java.lang.String[] value) Sets the value.
void	setSpeed(java.lang.Integer value) Sets the value.
void	setState8(java.lang.String value) Sets the value.
void	setTermCondMaxTime(java.lang.Long value) Sets the value.
void	setTermCondNonSilence(java.lang.Long value) Sets the value.
void	setTermCondSilence(java.lang.Long value) Sets the value.
void	setTimeout(java.lang.Integer value) Sets the value.
void	setVolume(java.lang.Integer value) Sets the value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

termCondNonSilence

public java.lang.Long termCondNonSilence

The amount of non-silence (in milliseconds) to observe before terminating the voice recognition operation. If this condition is met, the VoiceRecognition command will result in the VoiceRecognition_Complete event.

grammars

public java.lang.String[] grammars

Grammars

commandTimeout

public java.lang.Long commandTimeout

Indicates a command timeout value (in milliseconds).

volume

public java.lang.Integer volume

The amount by which to modify the volume (in decibels) of audio playback. Valid values range from -10 to 10.

speed

public java.lang.Integer speed

The amount by which to modify the speed of audio playback. Valid values range from -10 to 10.

state8

public java.lang.String state8

Optional user state information which is guaranteed present as the State event parameter in VoiceRecognition_Complete or VoiceRecognition_Failed.

termCondSilence

public java.lang.Long termCondSilence

The amount of silence (in milliseconds) to observe before terminating the record operation. If this condition is met, the VoiceRecognition command will result in the >VoiceRecognition_Complete event with a TerminationCondition of silence.

audioFileSampleRate

public java.lang.Long audioFileSampleRate

The sample rate of the audio file (in kHz). Valid values are 6, 8, or 11. 11 should be avoided as it has a higher impact on the media engine. If not specified, the media engine configuration file defines the sample rate to use, which by default is 8.

audioFileSampleSize

public java.lang.Long audioFileSampleSize

The sample size used in the audio file (in bits). Valid values are 4, 8, or 16. 4 and 16 should be avoided as each has a higher impact on the media engine.

audioFileEncoding

public MediaControl.AudioFileEncoding audioFileEncoding

The encoding of the audio file: ulaw, alaw, pcm, or adpcm. Pcm and adpcm should be avoided as each has a higher impact on the media engine. If not specified, the media engine configuration file defines the file encoding to use, which by default is ulaw.

prompts

public java.lang.String[] prompts

Prompts

timeout

public java.lang.Integer timeout

The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.

termCondMaxTime

public java.lang.Long termCondMaxTime

The amount of time (in milliseconds) that can elapse before terminating the voice recognition operation. If this condition is met, the VoiceRecognition command will result in the VoiceRecognition_Complete event.

Constructor Detail

MediaControl.VoiceRecognitionOptions

public MediaControl.VoiceRecognitionOptions()

Constructs the VoiceRecognitionOptions. Don't init any fields.

MediaControl.VoiceRecognitionOptions

public MediaControl.VoiceRecognitionOptions(java.lang.Long termCondNonSilence,
                                            java.lang.String[] grammars,
                                            java.lang.Long commandTimeout,
                                            java.lang.Integer volume,
                                            java.lang.Integer speed,
                                            java.lang.String state8,
                                            java.lang.Long termCondSilence,
                                            java.lang.Long audioFileSampleRate,
                                            java.lang.Long audioFileSampleSize,
                                            MediaControl.AudioFileEncoding audioFileEncoding,
                                            java.lang.String[] prompts,
                                            java.lang.Integer timeout,
                                            java.lang.Long termCondMaxTime)

Constructs the VoiceRecognitionOptions.

Parameters:

termCondNonSilence - The amount of non-silence (in milliseconds) to observe before terminating termCondNonSilence the voice recognition operation. If this condition is met, the termCondNonSilence VoiceRecognition command will result in the VoiceRecognition_Complete termCondNonSilence event. termCondNonSilence

grammars - Grammars grammars

commandTimeout - Indicates a command timeout value (in milliseconds). commandTimeout

volume - The amount by which to modify the volume (in decibels) of audio playback. volume Valid values range from -10 to 10. volume

speed - The amount by which to modify the speed of audio playback. Valid values speed range from -10 to 10. speed

state8 - Optional user state information which is guaranteed present as the State state8 event parameter in VoiceRecognition_Complete or VoiceRecognition_Failed. state8

termCondSilence - The amount of silence (in milliseconds) to observe before terminating the termCondSilence record operation. If this condition is met, the VoiceRecognition command termCondSilence will result in the >VoiceRecognition_Complete event with a termCondSilence TerminationCondition of silence. termCondSilence

audioFileSampleRate - The sample rate of the audio file (in kHz). Valid values are 6, 8, or 11. audioFileSampleRate 11 should be avoided as it has a higher impact on the media engine. If not audioFileSampleRate specified, the media engine configuration file defines the sample rate to audioFileSampleRate use, which by default is 8. audioFileSampleRate

audioFileSampleSize - The sample size used in the audio file (in bits). Valid values are 4, 8, or audioFileSampleSize 16. 4 and 16 should be avoided as each has a higher impact on the media audioFileSampleSize engine. audioFileSampleSize

audioFileEncoding - The encoding of the audio file: ulaw, alaw, pcm, or adpcm. Pcm and adpcm audioFileEncoding should be avoided as each has a higher impact on the media engine. If not audioFileEncoding specified, the media engine configuration file defines the file encoding to audioFileEncoding use, which by default is ulaw. audioFileEncoding

prompts - Prompts prompts

timeout - The Timeout property specifies to the Application Runtime Environment how timeout long to wait for a response from the provider for the current action. The timeout ReturnValue returned in this case is Timeout. The value must be a literal timeout value in milliseconds. timeout

termCondMaxTime - The amount of time (in milliseconds) that can elapse before terminating the termCondMaxTime voice recognition operation. If this condition is met, the VoiceRecognition termCondMaxTime command will result in the VoiceRecognition_Complete event. termCondMaxTime

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTermCondNonSilence

public java.lang.Long getTermCondNonSilence()

Gets the value. The amount of non-silence (in milliseconds) to observe before terminating the voice recognition operation. If this condition is met, the VoiceRecognition command will result in the VoiceRecognition_Complete event.

Returns:

the value.

setTermCondNonSilence

public void setTermCondNonSilence(java.lang.Long value)

Sets the value. The amount of non-silence (in milliseconds) to observe before terminating the voice recognition operation. If this condition is met, the VoiceRecognition command will result in the VoiceRecognition_Complete event.

Parameters:

value - the value.

getGrammars

public java.lang.String[] getGrammars()

Gets the value. Grammars

Returns:

the value.

setGrammars

public void setGrammars(java.lang.String[] value)

Sets the value. Grammars

Parameters:

value - the value.

getCommandTimeout

public java.lang.Long getCommandTimeout()

Gets the value. Indicates a command timeout value (in milliseconds).

Returns:

the value.

setCommandTimeout

public void setCommandTimeout(java.lang.Long value)

Sets the value. Indicates a command timeout value (in milliseconds).

Parameters:

value - the value.

getVolume

public java.lang.Integer getVolume()

Gets the value. The amount by which to modify the volume (in decibels) of audio playback. Valid values range from -10 to 10.

Returns:

the value.

setVolume

public void setVolume(java.lang.Integer value)

Sets the value. The amount by which to modify the volume (in decibels) of audio playback. Valid values range from -10 to 10.

Parameters:

value - the value.

getSpeed

public java.lang.Integer getSpeed()

Gets the value. The amount by which to modify the speed of audio playback. Valid values range from -10 to 10.

Returns:

the value.

setSpeed

public void setSpeed(java.lang.Integer value)

Sets the value. The amount by which to modify the speed of audio playback. Valid values range from -10 to 10.

Parameters:

value - the value.

getState8

public java.lang.String getState8()

Gets the value. Optional user state information which is guaranteed present as the State event parameter in VoiceRecognition_Complete or VoiceRecognition_Failed.

Returns:

the value.

setState8

public void setState8(java.lang.String value)

Sets the value. Optional user state information which is guaranteed present as the State event parameter in VoiceRecognition_Complete or VoiceRecognition_Failed.

Parameters:

value - the value.

getTermCondSilence

public java.lang.Long getTermCondSilence()

Gets the value. The amount of silence (in milliseconds) to observe before terminating the record operation. If this condition is met, the VoiceRecognition command will result in the >VoiceRecognition_Complete event with a TerminationCondition of silence.

Returns:

the value.

setTermCondSilence

public void setTermCondSilence(java.lang.Long value)

Sets the value. The amount of silence (in milliseconds) to observe before terminating the record operation. If this condition is met, the VoiceRecognition command will result in the >VoiceRecognition_Complete event with a TerminationCondition of silence.

Parameters:

value - the value.

getAudioFileSampleRate

public java.lang.Long getAudioFileSampleRate()

Gets the value. The sample rate of the audio file (in kHz). Valid values are 6, 8, or 11. 11 should be avoided as it has a higher impact on the media engine. If not specified, the media engine configuration file defines the sample rate to use, which by default is 8.

Returns:

the value.

setAudioFileSampleRate

public void setAudioFileSampleRate(java.lang.Long value)

Sets the value. The sample rate of the audio file (in kHz). Valid values are 6, 8, or 11. 11 should be avoided as it has a higher impact on the media engine. If not specified, the media engine configuration file defines the sample rate to use, which by default is 8.

Parameters:

value - the value.

getAudioFileSampleSize

public java.lang.Long getAudioFileSampleSize()

Gets the value. The sample size used in the audio file (in bits). Valid values are 4, 8, or 16. 4 and 16 should be avoided as each has a higher impact on the media engine.

Returns:

the value.

setAudioFileSampleSize

public void setAudioFileSampleSize(java.lang.Long value)

Sets the value. The sample size used in the audio file (in bits). Valid values are 4, 8, or 16. 4 and 16 should be avoided as each has a higher impact on the media engine.

Parameters:

value - the value.

getAudioFileEncoding

public MediaControl.AudioFileEncoding getAudioFileEncoding()

Gets the value. The encoding of the audio file: ulaw, alaw, pcm, or adpcm. Pcm and adpcm should be avoided as each has a higher impact on the media engine. If not specified, the media engine configuration file defines the file encoding to use, which by default is ulaw.

Returns:

the value.

setAudioFileEncoding

public void setAudioFileEncoding(MediaControl.AudioFileEncoding value)

Sets the value. The encoding of the audio file: ulaw, alaw, pcm, or adpcm. Pcm and adpcm should be avoided as each has a higher impact on the media engine. If not specified, the media engine configuration file defines the file encoding to use, which by default is ulaw.

Parameters:

value - the value.

getPrompts

public java.lang.String[] getPrompts()

Gets the value. Prompts

Returns:

the value.

setPrompts

public void setPrompts(java.lang.String[] value)

Sets the value. Prompts

Parameters:

value - the value.

getTimeout

public java.lang.Integer getTimeout()

Gets the value. The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.

Returns:

the value.

setTimeout

public void setTimeout(java.lang.Integer value)

Sets the value. The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.

Parameters:

value - the value.

getTermCondMaxTime

public java.lang.Long getTermCondMaxTime()

Gets the value. The amount of time (in milliseconds) that can elapse before terminating the voice recognition operation. If this condition is met, the VoiceRecognition command will result in the VoiceRecognition_Complete event.

Returns:

the value.

setTermCondMaxTime

public void setTermCondMaxTime(java.lang.Long value)

Sets the value. The amount of time (in milliseconds) that can elapse before terminating the voice recognition operation. If this condition is met, the VoiceRecognition command will result in the VoiceRecognition_Complete event.

Parameters:

value - the value.