cisco.uc.cuae.legacy
Class MediaControl.RecordOptions

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

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

MediaControl

public static class MediaControl.RecordOptions
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.
MediaControl.AudioFileFormat	audioFileFormat The format of the audio file: wav or vox.
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	conferenceId The conference to perform the Record on.
java.lang.String	connectionId The connection to perform the Record on.
java.lang.String	state15 Optional user state information which is guaranteed present as the State event parameter in Record_Complete or Record_Failed.
java.lang.String	termCondDigit A specific digit that will cause the Record operation to terminate.
java.lang.Long	termCondMaxTime The amount of time (in milliseconds) that can elapse before terminating the Record operation.
java.lang.Long	termCondNonSilence The amount of non-silence (in milliseconds) to observe before terminating the Record 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.

Constructor Summary

MediaControl.RecordOptions()
Constructs the RecordOptions.

MediaControl.RecordOptions(java.lang.Long termCondNonSilence, java.lang.Long termCondMaxTime, java.lang.String termCondDigit, java.lang.String connectionId, java.lang.String conferenceId, java.lang.Long termCondSilence, java.lang.Integer timeout, java.lang.Long audioFileSampleRate, java.lang.Long audioFileSampleSize, MediaControl.AudioFileEncoding audioFileEncoding, MediaControl.AudioFileFormat audioFileFormat, java.lang.Long commandTimeout, java.lang.String state15)
Constructs the RecordOptions.

Method Summary

MediaControl.AudioFileEncoding	getAudioFileEncoding() Gets the value.
MediaControl.AudioFileFormat	getAudioFileFormat() 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	getConferenceId() Gets the value.
java.lang.String	getConnectionId() Gets the value.
java.lang.String	getState15() Gets the value.
java.lang.String	getTermCondDigit() 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.
void	setAudioFileEncoding(MediaControl.AudioFileEncoding value) Sets the value.
void	setAudioFileFormat(MediaControl.AudioFileFormat 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	setConferenceId(java.lang.String value) Sets the value.
void	setConnectionId(java.lang.String value) Sets the value.
void	setState15(java.lang.String value) Sets the value.
void	setTermCondDigit(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.
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 Record operation. If this condition is met, the Record command will result in the Record_Complete event with a TerminationCondition of nonsilence.

termCondMaxTime

public java.lang.Long termCondMaxTime

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

termCondDigit

public java.lang.String termCondDigit

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

connectionId

public java.lang.String connectionId

The connection to perform the Record on. If specified, ConferenceId must not be specified.

conferenceId

public java.lang.String conferenceId

The conference to perform the Record on. If specified, ConnectionId must not be specified.

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 Record command will result in the Record_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.

audioFileFormat

public MediaControl.AudioFileFormat audioFileFormat

The format of the audio file: wav or vox. If not specified, the media engine configuration file defines the file format to use, which by default is vox.

commandTimeout

public java.lang.Long commandTimeout

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

state15

public java.lang.String state15

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

Constructor Detail

MediaControl.RecordOptions

public MediaControl.RecordOptions()

Constructs the RecordOptions. Don't init any fields.

MediaControl.RecordOptions

public MediaControl.RecordOptions(java.lang.Long termCondNonSilence,
                                  java.lang.Long termCondMaxTime,
                                  java.lang.String termCondDigit,
                                  java.lang.String connectionId,
                                  java.lang.String conferenceId,
                                  java.lang.Long termCondSilence,
                                  java.lang.Integer timeout,
                                  java.lang.Long audioFileSampleRate,
                                  java.lang.Long audioFileSampleSize,
                                  MediaControl.AudioFileEncoding audioFileEncoding,
                                  MediaControl.AudioFileFormat audioFileFormat,
                                  java.lang.Long commandTimeout,
                                  java.lang.String state15)

Constructs the RecordOptions.

Parameters:

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

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

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

connectionId - The connection to perform the Record on. If specified, ConferenceId must connectionId not be specified. connectionId

conferenceId - The conference to perform the Record on. If specified, ConnectionId must conferenceId not be specified. conferenceId

termCondSilence - The amount of silence (in milliseconds) to observe before terminating the termCondSilence Record operation. If this condition is met, the Record command will result termCondSilence in the Record_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

audioFileFormat - The format of the audio file: wav or vox. If not specified, the media audioFileFormat engine configuration file defines the file format to use, which by default audioFileFormat is vox. audioFileFormat

commandTimeout - Indicates a command timeout value (in milliseconds). If this condition is commandTimeout met, the Record command will result in the Record_Complete event with a commandTimeout TerminationCondition of timeout. commandTimeout

state15 - Optional user state information which is guaranteed present as the State state15 event parameter in Record_Complete or Record_Failed. state15

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

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

Parameters:

value - the value.

getTermCondDigit

public java.lang.String getTermCondDigit()

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

Returns:

the value.

setTermCondDigit

public void setTermCondDigit(java.lang.String value)

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

Parameters:

value - the value.

getConnectionId

public java.lang.String getConnectionId()

Gets the value. The connection to perform the Record on. If specified, ConferenceId must not be specified.

Returns:

the value.

setConnectionId

public void setConnectionId(java.lang.String value)

Sets the value. The connection to perform the Record on. If specified, ConferenceId must not be specified.

Parameters:

value - the value.

getConferenceId

public java.lang.String getConferenceId()

Gets the value. The conference to perform the Record on. If specified, ConnectionId must not be specified.

Returns:

the value.

setConferenceId

public void setConferenceId(java.lang.String value)

Sets the value. The conference to perform the Record on. If specified, ConnectionId must not be specified.

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 Record command will result in the Record_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 Record command will result in the Record_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.

getAudioFileFormat

public MediaControl.AudioFileFormat getAudioFileFormat()

Gets the value. The format of the audio file: wav or vox. If not specified, the media engine configuration file defines the file format to use, which by default is vox.

Returns:

the value.

setAudioFileFormat

public void setAudioFileFormat(MediaControl.AudioFileFormat value)

Sets the value. The format of the audio file: wav or vox. If not specified, the media engine configuration file defines the file format to use, which by default is vox.

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 Record command will result in the Record_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 Record command will result in the Record_Complete event with a TerminationCondition of timeout.

Parameters:

value - the value.

getState15

public java.lang.String getState15()

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

Returns:

the value.

setState15

public void setState15(java.lang.String value)

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

Parameters:

value - the value.