cisco.uc.cuae.legacy
Class MediaControl.PlayOptions

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

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

MediaControl

public static class MediaControl.PlayOptions
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[]	prompts Promopts
java.lang.Integer	speed The amount by which to modify the speed of audio playback.
java.lang.String	state7 Arbitrary, user-defined state information which is passed back as the State event parameter in Play_Complete or Play_Failed.
java.lang.String	termCondDigit A specific digit that will cause the play operation to terminate.
java.lang.String	termCondDigitList A list of digits that will cause the play operation to terminate, if any one of the digits in the list is inputted.
java.lang.Long	termCondMaxDigits The number of digits that will cause the play operation to terminate.
java.lang.Long	termCondMaxTime The amount of time (in milliseconds) that can elapse before terminating the play operation.
java.lang.Long	termCondNonSilence The amount of non-silence (in milliseconds) to observe before terminating the Play operation.
java.lang.Long	termCondSilence The amount of silence (in milliseconds) to observe before terminating the Play 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.PlayOptions()
Constructs the PlayOptions.

MediaControl.PlayOptions(java.lang.Long termCondNonSilence, java.lang.String[] prompts, java.lang.Long commandTimeout, java.lang.Integer volume, java.lang.Integer speed, java.lang.String state7, java.lang.Long termCondMaxTime, java.lang.Long termCondMaxDigits, java.lang.String termCondDigit, java.lang.String termCondDigitList, java.lang.Long termCondSilence, java.lang.Integer timeout, java.lang.Long audioFileSampleRate, java.lang.Long audioFileSampleSize, MediaControl.AudioFileEncoding audioFileEncoding)
Constructs the PlayOptions.

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[]	getPrompts() Gets the value.
java.lang.Integer	getSpeed() Gets the value.
java.lang.String	getState7() Gets the value.
java.lang.String	getTermCondDigit() Gets the value.
java.lang.String	getTermCondDigitList() Gets the value.
java.lang.Long	getTermCondMaxDigits() 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	setPrompts(java.lang.String[] value) Sets the value.
void	setSpeed(java.lang.Integer value) Sets the value.
void	setState7(java.lang.String value) Sets the value.
void	setTermCondDigit(java.lang.String value) Sets the value.
void	setTermCondDigitList(java.lang.String value) Sets the value.
void	setTermCondMaxDigits(java.lang.Long 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 Play operation. If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of nonsilence.

prompts

public java.lang.String[] prompts

Promopts

commandTimeout

public java.lang.Long commandTimeout

Indicates a command timeout value (in milliseconds). If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of timeout.

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.

state7

public java.lang.String state7

Arbitrary, user-defined state information which is passed back as the State event parameter in Play_Complete or Play_Failed.

termCondMaxTime

public java.lang.Long termCondMaxTime

The amount of time (in milliseconds) that can elapse before terminating the play operation. If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of maxtime.

termCondMaxDigits

public java.lang.Long termCondMaxDigits

The number of digits that will cause the play operation to terminate. If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of maxdigits. Note that this termination condition is only valid if one is playing to a ConnectionId.

termCondDigit

public java.lang.String termCondDigit

A specific digit that will cause the play operation to terminate. If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of digit. If you wish to know what digit or digits were pushed, use GatherDigits after Play_Complete, which will process the digits collected into the digit buffer as the Play command was executing. Note that this termination condition is only valid if one is playing to a ConnectionId.

termCondDigitList

public java.lang.String termCondDigitList

A list of digits that will cause the play operation to terminate, if any one of the digits in the list is inputted. The list has no delimiters. If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of digitlist. Note that this termination condition is only valid if one is playing to a ConnectionId.

termCondSilence

public java.lang.Long termCondSilence

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

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.

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 both have a higher impact on the media engine. If not specified, the media engine configuration file defines the sample size to use, which by default is 8.

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.

Constructor Detail

MediaControl.PlayOptions

public MediaControl.PlayOptions()

Constructs the PlayOptions. Don't init any fields.

MediaControl.PlayOptions

public MediaControl.PlayOptions(java.lang.Long termCondNonSilence,
                                java.lang.String[] prompts,
                                java.lang.Long commandTimeout,
                                java.lang.Integer volume,
                                java.lang.Integer speed,
                                java.lang.String state7,
                                java.lang.Long termCondMaxTime,
                                java.lang.Long termCondMaxDigits,
                                java.lang.String termCondDigit,
                                java.lang.String termCondDigitList,
                                java.lang.Long termCondSilence,
                                java.lang.Integer timeout,
                                java.lang.Long audioFileSampleRate,
                                java.lang.Long audioFileSampleSize,
                                MediaControl.AudioFileEncoding audioFileEncoding)

Constructs the PlayOptions.

Parameters:

termCondNonSilence - The amount of non-silence (in milliseconds) to observe before terminating termCondNonSilence the Play operation. If this condition is met, the Play command will result termCondNonSilence in the Play_Complete event with a TerminationCondition of nonsilence. termCondNonSilence

prompts - Promopts prompts

commandTimeout - Indicates a command timeout value (in milliseconds). If this condition is commandTimeout met, the Play command will result in the Play_Complete event with a commandTimeout TerminationCondition of timeout. 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

state7 - Arbitrary, user-defined state information which is passed back as the State state7 event parameter in Play_Complete or Play_Failed. state7

termCondMaxTime - The amount of time (in milliseconds) that can elapse before terminating the termCondMaxTime play operation. If this condition is met, the Play command will result in termCondMaxTime the Play_Complete event with a TerminationCondition of maxtime. termCondMaxTime

termCondMaxDigits - The number of digits that will cause the play operation to terminate. If termCondMaxDigits this condition is met, the Play command will result in the Play_Complete termCondMaxDigits event with a TerminationCondition of maxdigits. Note that this termination termCondMaxDigits condition is only valid if one is playing to a ConnectionId. termCondMaxDigits

termCondDigit - A specific digit that will cause the play operation to terminate. If this termCondDigit condition is met, the Play command will result in the Play_Complete event termCondDigit with a TerminationCondition of digit. If you wish to know what digit or termCondDigit digits were pushed, use GatherDigits after Play_Complete, which will termCondDigit process the digits collected into the digit buffer as the Play command was termCondDigit executing. Note that this termination condition is only valid if one is termCondDigit playing to a ConnectionId. termCondDigit

termCondDigitList - A list of digits that will cause the play operation to terminate, if any termCondDigitList one of the digits in the list is inputted. The list has no delimiters. If termCondDigitList this condition is met, the Play command will result in the Play_Complete termCondDigitList event with a TerminationCondition of digitlist. Note that this termination termCondDigitList condition is only valid if one is playing to a ConnectionId. termCondDigitList

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

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

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 both have a higher impact on the media audioFileSampleSize engine. If not specified, the media engine configuration file defines the audioFileSampleSize sample size to use, which by default is 8. 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

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 Play operation. If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of nonsilence.

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 Play operation. If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of nonsilence.

Parameters:

value - the value.

getPrompts

public java.lang.String[] getPrompts()

Gets the value. Promopts

Returns:

the value.

setPrompts

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

Sets the value. Promopts

Parameters:

value - the value.

getCommandTimeout

public java.lang.Long getCommandTimeout()

Gets the value. Indicates a command timeout value (in milliseconds). If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of timeout.

Returns:

the value.

setCommandTimeout

public void setCommandTimeout(java.lang.Long value)

Sets the value. Indicates a command timeout value (in milliseconds). If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of timeout.

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.

getState7

public java.lang.String getState7()

Gets the value. Arbitrary, user-defined state information which is passed back as the State event parameter in Play_Complete or Play_Failed.

Returns:

the value.

setState7

public void setState7(java.lang.String value)

Sets the value. Arbitrary, user-defined state information which is passed back as the State event parameter in Play_Complete or Play_Failed.

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 play operation. If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of maxtime.

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 play operation. If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of maxtime.

Parameters:

value - the value.

getTermCondMaxDigits

public java.lang.Long getTermCondMaxDigits()

Gets the value. The number of digits that will cause the play operation to terminate. If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of maxdigits. Note that this termination condition is only valid if one is playing to a ConnectionId.

Returns:

the value.

setTermCondMaxDigits

public void setTermCondMaxDigits(java.lang.Long value)

Sets the value. The number of digits that will cause the play operation to terminate. If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of maxdigits. Note that this termination condition is only valid if one is playing to a ConnectionId.

Parameters:

value - the value.

getTermCondDigit

public java.lang.String getTermCondDigit()

Gets the value. A specific digit that will cause the play operation to terminate. If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of digit. If you wish to know what digit or digits were pushed, use GatherDigits after Play_Complete, which will process the digits collected into the digit buffer as the Play command was executing. Note that this termination condition is only valid if one is playing to a ConnectionId.

Returns:

the value.

setTermCondDigit

public void setTermCondDigit(java.lang.String value)

Sets the value. A specific digit that will cause the play operation to terminate. If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of digit. If you wish to know what digit or digits were pushed, use GatherDigits after Play_Complete, which will process the digits collected into the digit buffer as the Play command was executing. Note that this termination condition is only valid if one is playing to a ConnectionId.

Parameters:

value - the value.

getTermCondDigitList

public java.lang.String getTermCondDigitList()

Gets the value. A list of digits that will cause the play operation to terminate, if any one of the digits in the list is inputted. The list has no delimiters. If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of digitlist. Note that this termination condition is only valid if one is playing to a ConnectionId.

Returns:

the value.

setTermCondDigitList

public void setTermCondDigitList(java.lang.String value)

Sets the value. A list of digits that will cause the play operation to terminate, if any one of the digits in the list is inputted. The list has no delimiters. If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of digitlist. Note that this termination condition is only valid if one is playing to a ConnectionId.

Parameters:

value - the value.

getTermCondSilence

public java.lang.Long getTermCondSilence()

Gets the value. The amount of silence (in milliseconds) to observe before terminating the Play operation. If this condition is met, the Play command will result in the Play_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 Play operation. If this condition is met, the Play command will result in the Play_Complete event with a TerminationCondition of silence.

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.

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 both have a higher impact on the media engine. If not specified, the media engine configuration file defines the sample size to use, which by default is 8.

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 both have a higher impact on the media engine. If not specified, the media engine configuration file defines the sample size to use, which by default is 8.

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.