cisco.uc.cuae.legacy
Class MediaControl.RecordResult

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

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

MediaControl

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

See Also:

Serialized Form

Field Summary

java.lang.String	connectionId In the case of a Record to a connection, the value of the ConnectionId result data is the same as that specified as an action parameter.
java.lang.Integer	elapsedTime The amount of time taken to perform the Record (in milliseconds).
java.lang.String	filename The filename used to save the recording.
java.lang.String	operationId A unique identifier to this Record operation.
java.lang.String	resultCode A numeric code indicating the result status of the operation.
CuaeCommon.CuaeResult	returnValue
MediaControl.TerminationCondition	terminationCondition The condition which caused the Record to stop.
java.lang.String	url The URL to the recorded audio file.

Constructor Summary

MediaControl.RecordResult()
Constructs the RecordResult.

MediaControl.RecordResult(CuaeCommon.CuaeResult returnValue, java.lang.String operationId, java.lang.String url, java.lang.String resultCode, java.lang.String connectionId, java.lang.String filename, java.lang.Integer elapsedTime, MediaControl.TerminationCondition terminationCondition)
Constructs the RecordResult.

Method Summary

java.lang.String	getConnectionId() Gets the value.
java.lang.Integer	getElapsedTime() Gets the value.
java.lang.String	getFilename() Gets the value.
java.lang.String	getOperationId() Gets the value.
java.lang.String	getResultCode() Gets the value.
CuaeCommon.CuaeResult	getReturnValue() Gets the value.
MediaControl.TerminationCondition	getTerminationCondition() Gets the value.
java.lang.String	getUrl() Gets the value.
void	setConnectionId(java.lang.String value) Sets the value.
void	setElapsedTime(java.lang.Integer value) Sets the value.
void	setFilename(java.lang.String value) Sets the value.
void	setOperationId(java.lang.String value) Sets the value.
void	setResultCode(java.lang.String value) Sets the value.
void	setReturnValue(CuaeCommon.CuaeResult value) Sets the value.
void	setTerminationCondition(MediaControl.TerminationCondition value) Sets the value.
void	setUrl(java.lang.String 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

returnValue

public CuaeCommon.CuaeResult returnValue

operationId

public java.lang.String operationId

A unique identifier to this Record operation. This identifier can later be used by the StopMediaOperation action to stop just this particular operation on a connection, even if multiple media operations are concurrently executing on that connection. In the case that the Record was specified to a conference, there is no reason to store OperationId, since the ConnectionId returned as a result data will only ever have this Record action operating on it.

url

public java.lang.String url

The URL to the recorded audio file.

resultCode

public java.lang.String resultCode

A numeric code indicating the result status of the operation. A '0' indicates success; a positive number indicates an error. Please reference the Media Control Error Codes table for descriptions on specific error codes.

connectionId

public java.lang.String connectionId

In the case of a Record to a connection, the value of the ConnectionId result data is the same as that specified as an action parameter. In the case of a Record to a conference, the value of the ConnectionId result data is the value of the new connection added to conference. In either case, this ConnectionId is what one would later specify in StopMediaOperation if one were to abort the command programmatically.

filename

public java.lang.String filename

The filename used to save the recording. The filename is relative to the root of the media engine audio path.

elapsedTime

public java.lang.Integer elapsedTime

The amount of time taken to perform the Record (in milliseconds). This is a parameter from asyncCallback event "Metreos.MediaControl.Record_Complete".

terminationCondition

public MediaControl.TerminationCondition terminationCondition

The condition which caused the Record to stop. Possible values for termination condition are as follows: maxtime - The amount of time specified by TermCondMaxTime has elapsed (in milliseconds). digit - The digit specified by TermCondDigit has occurred. silence - The amount of continuous silence specified by TermCondSilence has elapsed (in milliseconds). nonsilence - The amount of continuous non-silence specified by TermCondNonSilence has elapsed (in milliseconds). userstop - The StopMediaOperation was used on operation to abort it. autostop - The Call Control API ended the operation due to the call ending that was associated with the connection. The normal reasons a call may end are Hangup or BlindTransfer. timeout - The amount of time specified by CommandTimeout has elapsed (in milliseconds). This is a parameter from asyncCallback event "Metreos.MediaControl.Record_Complete".

Constructor Detail

MediaControl.RecordResult

public MediaControl.RecordResult()

Constructs the RecordResult. Don't init any fields.

MediaControl.RecordResult

public MediaControl.RecordResult(CuaeCommon.CuaeResult returnValue,
                                 java.lang.String operationId,
                                 java.lang.String url,
                                 java.lang.String resultCode,
                                 java.lang.String connectionId,
                                 java.lang.String filename,
                                 java.lang.Integer elapsedTime,
                                 MediaControl.TerminationCondition terminationCondition)

Constructs the RecordResult.

Parameters:

operationId - A unique identifier to this Record operation. This identifier can later operationId be used by the StopMediaOperation action to stop just this particular operationId operation on a connection, even if multiple media operations are operationId concurrently executing on that connection. In the case that the Record operationId was specified to a conference, there is no reason to store OperationId, operationId since the ConnectionId returned as a result data will only ever have this operationId Record action operating on it. operationId

url - The URL to the recorded audio file. url

resultCode - A numeric code indicating the result status of the operation. A '0' resultCode indicates success; a positive number indicates an error. Please reference resultCode the Media Control Error Codes table for descriptions on specific error resultCode codes. resultCode

connectionId - In the case of a Record to a connection, the value of the ConnectionId connectionId result data is the same as that specified as an action parameter. In the connectionId case of a Record to a conference, the value of the ConnectionId result connectionId data is the value of the new connection added to conference. In either connectionId case, this ConnectionId is what one would later specify in connectionId StopMediaOperation if one were to abort the command programmatically. connectionId

filename - The filename used to save the recording. The filename is relative to the filename root of the media engine audio path. filename

elapsedTime - The amount of time taken to perform the Record (in milliseconds). elapsedTime elapsedTime This is a parameter from asyncCallback event "Metreos.MediaControl.Record_Complete".

terminationCondition - The condition which caused the Record to stop. Possible values for terminationCondition termination condition are as follows: terminationCondition terminationCondition maxtime - The amount of time specified by TermCondMaxTime has elapsed (in terminationCondition milliseconds). terminationCondition digit - The digit specified by TermCondDigit has occurred. terminationCondition silence - The amount of continuous silence specified by TermCondSilence terminationCondition has elapsed (in milliseconds). terminationCondition nonsilence - The amount of continuous non-silence specified by terminationCondition TermCondNonSilence has elapsed (in milliseconds). terminationCondition userstop - The StopMediaOperation was used on operation to abort it. terminationCondition autostop - The Call Control API ended the operation due to the call terminationCondition ending that was associated with the connection. The normal terminationCondition reasons a call may end are Hangup or BlindTransfer. terminationCondition timeout - The amount of time specified by CommandTimeout has elapsed (in terminationCondition milliseconds). terminationCondition terminationCondition This is a parameter from asyncCallback event "Metreos.MediaControl.Record_Complete".

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getReturnValue

public CuaeCommon.CuaeResult getReturnValue()

Gets the value.

Returns:

the value.

setReturnValue

public void setReturnValue(CuaeCommon.CuaeResult value)

Sets the value.

Parameters:

value - the value.

getOperationId

public java.lang.String getOperationId()

Gets the value. A unique identifier to this Record operation. This identifier can later be used by the StopMediaOperation action to stop just this particular operation on a connection, even if multiple media operations are concurrently executing on that connection. In the case that the Record was specified to a conference, there is no reason to store OperationId, since the ConnectionId returned as a result data will only ever have this Record action operating on it.

Returns:

the value.

setOperationId

public void setOperationId(java.lang.String value)

Sets the value. A unique identifier to this Record operation. This identifier can later be used by the StopMediaOperation action to stop just this particular operation on a connection, even if multiple media operations are concurrently executing on that connection. In the case that the Record was specified to a conference, there is no reason to store OperationId, since the ConnectionId returned as a result data will only ever have this Record action operating on it.

Parameters:

value - the value.

getUrl

public java.lang.String getUrl()

Gets the value. The URL to the recorded audio file.

Returns:

the value.

setUrl

public void setUrl(java.lang.String value)

Sets the value. The URL to the recorded audio file.

Parameters:

value - the value.

getResultCode

public java.lang.String getResultCode()

Gets the value. A numeric code indicating the result status of the operation. A '0' indicates success; a positive number indicates an error. Please reference the Media Control Error Codes table for descriptions on specific error codes.

Returns:

the value.

setResultCode

public void setResultCode(java.lang.String value)

Sets the value. A numeric code indicating the result status of the operation. A '0' indicates success; a positive number indicates an error. Please reference the Media Control Error Codes table for descriptions on specific error codes.

Parameters:

value - the value.

getConnectionId

public java.lang.String getConnectionId()

Gets the value. In the case of a Record to a connection, the value of the ConnectionId result data is the same as that specified as an action parameter. In the case of a Record to a conference, the value of the ConnectionId result data is the value of the new connection added to conference. In either case, this ConnectionId is what one would later specify in StopMediaOperation if one were to abort the command programmatically.

Returns:

the value.

setConnectionId

public void setConnectionId(java.lang.String value)

Sets the value. In the case of a Record to a connection, the value of the ConnectionId result data is the same as that specified as an action parameter. In the case of a Record to a conference, the value of the ConnectionId result data is the value of the new connection added to conference. In either case, this ConnectionId is what one would later specify in StopMediaOperation if one were to abort the command programmatically.

Parameters:

value - the value.

getFilename

public java.lang.String getFilename()

Gets the value. The filename used to save the recording. The filename is relative to the root of the media engine audio path.

Returns:

the value.

setFilename

public void setFilename(java.lang.String value)

Sets the value. The filename used to save the recording. The filename is relative to the root of the media engine audio path.

Parameters:

value - the value.

getElapsedTime

public java.lang.Integer getElapsedTime()

Gets the value. The amount of time taken to perform the Record (in milliseconds). This is a parameter from asyncCallback event "Metreos.MediaControl.Record_Complete".

Returns:

the value.

setElapsedTime

public void setElapsedTime(java.lang.Integer value)

Sets the value. The amount of time taken to perform the Record (in milliseconds). This is a parameter from asyncCallback event "Metreos.MediaControl.Record_Complete".

Parameters:

value - the value.

getTerminationCondition

public MediaControl.TerminationCondition getTerminationCondition()

Gets the value. The condition which caused the Record to stop. Possible values for termination condition are as follows: maxtime - The amount of time specified by TermCondMaxTime has elapsed (in milliseconds). digit - The digit specified by TermCondDigit has occurred. silence - The amount of continuous silence specified by TermCondSilence has elapsed (in milliseconds). nonsilence - The amount of continuous non-silence specified by TermCondNonSilence has elapsed (in milliseconds). userstop - The StopMediaOperation was used on operation to abort it. autostop - The Call Control API ended the operation due to the call ending that was associated with the connection. The normal reasons a call may end are Hangup or BlindTransfer. timeout - The amount of time specified by CommandTimeout has elapsed (in milliseconds). This is a parameter from asyncCallback event "Metreos.MediaControl.Record_Complete".

Returns:

the value.

setTerminationCondition

public void setTerminationCondition(MediaControl.TerminationCondition value)

Sets the value. The condition which caused the Record to stop. Possible values for termination condition are as follows: maxtime - The amount of time specified by TermCondMaxTime has elapsed (in milliseconds). digit - The digit specified by TermCondDigit has occurred. silence - The amount of continuous silence specified by TermCondSilence has elapsed (in milliseconds). nonsilence - The amount of continuous non-silence specified by TermCondNonSilence has elapsed (in milliseconds). userstop - The StopMediaOperation was used on operation to abort it. autostop - The Call Control API ended the operation due to the call ending that was associated with the connection. The normal reasons a call may end are Hangup or BlindTransfer. timeout - The amount of time specified by CommandTimeout has elapsed (in milliseconds). This is a parameter from asyncCallback event "Metreos.MediaControl.Record_Complete".

Parameters:

value - the value.