cisco.uc.cuae.legacy
Class CallControl.AnswerCallResult

java.lang.Object
  cisco.uc.cuae.legacy.CallControl.AnswerCallResult

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

CallControl

public static class CallControl.AnswerCallResult
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

java.lang.String	callId Indicates the call that was accepted.
java.lang.String	conferenceId Unique identifier for the conference that this connection was placed in.
java.lang.String	connectionId Unique identifier used to identify this connection in all subsequent Media Control API operations.
java.lang.String	mediaRxCodec The codec chosen by the application server for the Rx RTP stream for this connection.
java.lang.Long	mediaRxFramesize The framesize chosen by the application server for the Rx RTP stream for this connection.
java.lang.String	mediaRxIP The IP address chosen by the application server for the Rx RTP stream for this connection.
java.lang.Long	mediaRxPort The port chosen by the application server for the Rx RTP stream for this connection.
java.lang.String	mediaTxCodec The codec that the media engine connection should use when sending audio.
java.lang.Long	mediaTxFramesize The framesize that the media engine connection should use when sending audio.
java.lang.String	mediaTxIP The IP address that the media engine connection should send audio to.
java.lang.Long	mediaTxPort The port that the media engine connection should send audio to.
java.lang.Long	mmsId Unique identifier used to identify the media engine in control of this connection.
CuaeCommon.CuaeResult	returnValue

Constructor Summary

CallControl.AnswerCallResult()
Constructs the AnswerCallResult.

CallControl.AnswerCallResult(CuaeCommon.CuaeResult returnValue, java.lang.String callId, java.lang.Long mmsId, java.lang.String connectionId, java.lang.String conferenceId, java.lang.String mediaTxIP, java.lang.Long mediaTxPort, java.lang.String mediaTxCodec, java.lang.Long mediaTxFramesize, java.lang.String mediaRxIP, java.lang.Long mediaRxPort, java.lang.String mediaRxCodec, java.lang.Long mediaRxFramesize)
Constructs the AnswerCallResult.

Method Summary

java.lang.String	getCallId() Gets the value.
java.lang.String	getConferenceId() Gets the value.
java.lang.String	getConnectionId() Gets the value.
java.lang.String	getMediaRxCodec() Gets the value.
java.lang.Long	getMediaRxFramesize() Gets the value.
java.lang.String	getMediaRxIP() Gets the value.
java.lang.Long	getMediaRxPort() Gets the value.
java.lang.String	getMediaTxCodec() Gets the value.
java.lang.Long	getMediaTxFramesize() Gets the value.
java.lang.String	getMediaTxIP() Gets the value.
java.lang.Long	getMediaTxPort() Gets the value.
java.lang.Long	getMmsId() Gets the value.
CuaeCommon.CuaeResult	getReturnValue() Gets the value.
void	setCallId(java.lang.String value) Sets the value.
void	setConferenceId(java.lang.String value) Sets the value.
void	setConnectionId(java.lang.String value) Sets the value.
void	setMediaRxCodec(java.lang.String value) Sets the value.
void	setMediaRxFramesize(java.lang.Long value) Sets the value.
void	setMediaRxIP(java.lang.String value) Sets the value.
void	setMediaRxPort(java.lang.Long value) Sets the value.
void	setMediaTxCodec(java.lang.String value) Sets the value.
void	setMediaTxFramesize(java.lang.Long value) Sets the value.
void	setMediaTxIP(java.lang.String value) Sets the value.
void	setMediaTxPort(java.lang.Long value) Sets the value.
void	setMmsId(java.lang.Long value) Sets the value.
void	setReturnValue(CuaeCommon.CuaeResult 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

callId

public java.lang.String callId

Indicates the call that was accepted. This is always the same value passed in as the CallId action parameter.

mmsId

public java.lang.Long mmsId

Unique identifier used to identify the media engine in control of this connection. A common use for this ID is to ensure that other connections which will ultimately be conferenced with this connection are all created on the same media engine. This correlation is necessary because all connections in a single conference must all reside on the same media engine.

connectionId

public java.lang.String connectionId

Unique identifier used to identify this connection in all subsequent Media Control API operations. This connection may not be fully connected, and therefore not ready to use in most Media Control API by the time it is returned to the script if WaitForMedia is not the default TxRx.

conferenceId

public java.lang.String conferenceId

Unique identifier for the conference that this connection was placed in. This field is valid only if Conference was specified as true in the action. In the case that Conference was set to true, and if the ConferenceId action parameter was specified, this event parameter will be that same value. If the ConferenceId action parameter was not specified, then this will be a new ID for the new conference.

mediaTxIP

public java.lang.String mediaTxIP

The IP address that the media engine connection should send audio to. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

mediaTxPort

public java.lang.Long mediaTxPort

The port that the media engine connection should send audio to. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

mediaTxCodec

public java.lang.String mediaTxCodec

The codec that the media engine connection should use when sending audio. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

mediaTxFramesize

public java.lang.Long mediaTxFramesize

The framesize that the media engine connection should use when sending audio. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

mediaRxIP

public java.lang.String mediaRxIP

The IP address chosen by the application server for the Rx RTP stream for this connection. This field can only be relied on if WaitForMedia has been set to a value of Rx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

mediaRxPort

public java.lang.Long mediaRxPort

The port chosen by the application server for the Rx RTP stream for this connection. This field can only be relied on if WaitForMedia has been set to a value of Rx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

mediaRxCodec

public java.lang.String mediaRxCodec

The codec chosen by the application server for the Rx RTP stream for this connection. This field can only be relied on if WaitForMedia has been set to a value of Rx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

mediaRxFramesize

public java.lang.Long mediaRxFramesize

The framesize chosen by the application server for the Rx RTP stream for this connection. This field can only be relied on if WaitForMedia has been set to a value of Rx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Constructor Detail

CallControl.AnswerCallResult

public CallControl.AnswerCallResult()

Constructs the AnswerCallResult. Don't init any fields.

CallControl.AnswerCallResult

public CallControl.AnswerCallResult(CuaeCommon.CuaeResult returnValue,
                                    java.lang.String callId,
                                    java.lang.Long mmsId,
                                    java.lang.String connectionId,
                                    java.lang.String conferenceId,
                                    java.lang.String mediaTxIP,
                                    java.lang.Long mediaTxPort,
                                    java.lang.String mediaTxCodec,
                                    java.lang.Long mediaTxFramesize,
                                    java.lang.String mediaRxIP,
                                    java.lang.Long mediaRxPort,
                                    java.lang.String mediaRxCodec,
                                    java.lang.Long mediaRxFramesize)

Constructs the AnswerCallResult.

Parameters:

callId - Indicates the call that was accepted. This is always the same value callId passed in as the CallId action parameter. callId

mmsId - Unique identifier used to identify the media engine in control of this mmsId connection. A common use for this ID is to ensure that other connections mmsId which will ultimately be conferenced with this connection are all created mmsId on the same media engine. This correlation is necessary because all mmsId connections in a single conference must all reside on the same media mmsId engine. mmsId

connectionId - Unique identifier used to identify this connection in all subsequent connectionId Media Control API operations. This connection may not be fully connected, connectionId and therefore not ready to use in most Media Control API by the time it connectionId is returned to the script if WaitForMedia is not the default TxRx. connectionId

conferenceId - Unique identifier for the conference that this connection was placed in. conferenceId This field is valid only if Conference was specified as true in the conferenceId action. In the case that Conference was set to true, and if the conferenceId ConferenceId action parameter was specified, this event parameter will be conferenceId that same value. If the ConferenceId action parameter was not specified, conferenceId then this will be a new ID for the new conference. conferenceId

mediaTxIP - The IP address that the media engine connection should send audio to. mediaTxIP This field can only be relied on if WaitForMedia has been set to a value mediaTxIP of Tx or TxRx. However, regardless if this field is available as a result mediaTxIP data parameter, the application server will associate the correct value mediaTxIP for this parameter to the connection created for this call when it mediaTxIP becomes available at the protocol layer. mediaTxIP

mediaTxPort - The port that the media engine connection should send audio to. This mediaTxPort field can only be relied on if WaitForMedia has been set to a value of Tx mediaTxPort or TxRx. However, regardless if this field is available as a result data mediaTxPort parameter, the application server will associate the correct value for mediaTxPort this parameter to the connection created for this call when it becomes mediaTxPort available at the protocol layer. mediaTxPort

mediaTxCodec - The codec that the media engine connection should use when sending audio. mediaTxCodec This field can only be relied on if WaitForMedia has been set to a value mediaTxCodec of Tx or TxRx. However, regardless if this field is available as a result mediaTxCodec data parameter, the application server will associate the correct value mediaTxCodec for this parameter to the connection created for this call when it mediaTxCodec becomes available at the protocol layer. mediaTxCodec

mediaTxFramesize - The framesize that the media engine connection should use when sending mediaTxFramesize audio. This field can only be relied on if WaitForMedia has been set to a mediaTxFramesize value of Tx or TxRx. However, regardless if this field is available as a mediaTxFramesize result data parameter, the application server will associate the correct mediaTxFramesize value for this parameter to the connection created for this call when it mediaTxFramesize becomes available at the protocol layer. mediaTxFramesize

mediaRxIP - The IP address chosen by the application server for the Rx RTP stream for mediaRxIP this connection. This field can only be relied on if WaitForMedia has mediaRxIP been set to a value of Rx or TxRx. However, regardless if this field is mediaRxIP available as a result data parameter, the application server will mediaRxIP associate the correct value for this parameter to the connection created mediaRxIP for this call when it becomes available at the protocol layer. mediaRxIP

mediaRxPort - The port chosen by the application server for the Rx RTP stream for this mediaRxPort connection. This field can only be relied on if WaitForMedia has been set mediaRxPort to a value of Rx or TxRx. However, regardless if this field is available mediaRxPort as a result data parameter, the application server will associate the mediaRxPort correct value for this parameter to the connection created for this call mediaRxPort when it becomes available at the protocol layer. mediaRxPort

mediaRxCodec - The codec chosen by the application server for the Rx RTP stream for this mediaRxCodec connection. This field can only be relied on if WaitForMedia has been set mediaRxCodec to a value of Rx or TxRx. However, regardless if this field is available mediaRxCodec as a result data parameter, the application server will associate the mediaRxCodec correct value for this parameter to the connection created for this call mediaRxCodec when it becomes available at the protocol layer. mediaRxCodec

mediaRxFramesize - The framesize chosen by the application server for the Rx RTP stream for mediaRxFramesize this connection. This field can only be relied on if WaitForMedia has mediaRxFramesize been set to a value of Rx or TxRx. However, regardless if this field is mediaRxFramesize available as a result data parameter, the application server will mediaRxFramesize associate the correct value for this parameter to the connection created mediaRxFramesize for this call when it becomes available at the protocol layer. mediaRxFramesize

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.

getCallId

public java.lang.String getCallId()

Gets the value. Indicates the call that was accepted. This is always the same value passed in as the CallId action parameter.

Returns:

the value.

setCallId

public void setCallId(java.lang.String value)

Sets the value. Indicates the call that was accepted. This is always the same value passed in as the CallId action parameter.

Parameters:

value - the value.

getMmsId

public java.lang.Long getMmsId()

Gets the value. Unique identifier used to identify the media engine in control of this connection. A common use for this ID is to ensure that other connections which will ultimately be conferenced with this connection are all created on the same media engine. This correlation is necessary because all connections in a single conference must all reside on the same media engine.

Returns:

the value.

setMmsId

public void setMmsId(java.lang.Long value)

Sets the value. Unique identifier used to identify the media engine in control of this connection. A common use for this ID is to ensure that other connections which will ultimately be conferenced with this connection are all created on the same media engine. This correlation is necessary because all connections in a single conference must all reside on the same media engine.

Parameters:

value - the value.

getConnectionId

public java.lang.String getConnectionId()

Gets the value. Unique identifier used to identify this connection in all subsequent Media Control API operations. This connection may not be fully connected, and therefore not ready to use in most Media Control API by the time it is returned to the script if WaitForMedia is not the default TxRx.

Returns:

the value.

setConnectionId

public void setConnectionId(java.lang.String value)

Sets the value. Unique identifier used to identify this connection in all subsequent Media Control API operations. This connection may not be fully connected, and therefore not ready to use in most Media Control API by the time it is returned to the script if WaitForMedia is not the default TxRx.

Parameters:

value - the value.

getConferenceId

public java.lang.String getConferenceId()

Gets the value. Unique identifier for the conference that this connection was placed in. This field is valid only if Conference was specified as true in the action. In the case that Conference was set to true, and if the ConferenceId action parameter was specified, this event parameter will be that same value. If the ConferenceId action parameter was not specified, then this will be a new ID for the new conference.

Returns:

the value.

setConferenceId

public void setConferenceId(java.lang.String value)

Sets the value. Unique identifier for the conference that this connection was placed in. This field is valid only if Conference was specified as true in the action. In the case that Conference was set to true, and if the ConferenceId action parameter was specified, this event parameter will be that same value. If the ConferenceId action parameter was not specified, then this will be a new ID for the new conference.

Parameters:

value - the value.

getMediaTxIP

public java.lang.String getMediaTxIP()

Gets the value. The IP address that the media engine connection should send audio to. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Returns:

the value.

setMediaTxIP

public void setMediaTxIP(java.lang.String value)

Sets the value. The IP address that the media engine connection should send audio to. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Parameters:

value - the value.

getMediaTxPort

public java.lang.Long getMediaTxPort()

Gets the value. The port that the media engine connection should send audio to. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Returns:

the value.

setMediaTxPort

public void setMediaTxPort(java.lang.Long value)

Sets the value. The port that the media engine connection should send audio to. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Parameters:

value - the value.

getMediaTxCodec

public java.lang.String getMediaTxCodec()

Gets the value. The codec that the media engine connection should use when sending audio. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Returns:

the value.

setMediaTxCodec

public void setMediaTxCodec(java.lang.String value)

Sets the value. The codec that the media engine connection should use when sending audio. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Parameters:

value - the value.

getMediaTxFramesize

public java.lang.Long getMediaTxFramesize()

Gets the value. The framesize that the media engine connection should use when sending audio. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Returns:

the value.

setMediaTxFramesize

public void setMediaTxFramesize(java.lang.Long value)

Sets the value. The framesize that the media engine connection should use when sending audio. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Parameters:

value - the value.

getMediaRxIP

public java.lang.String getMediaRxIP()

Gets the value. The IP address chosen by the application server for the Rx RTP stream for this connection. This field can only be relied on if WaitForMedia has been set to a value of Rx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Returns:

the value.

setMediaRxIP

public void setMediaRxIP(java.lang.String value)

Sets the value. The IP address chosen by the application server for the Rx RTP stream for this connection. This field can only be relied on if WaitForMedia has been set to a value of Rx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Parameters:

value - the value.

getMediaRxPort

public java.lang.Long getMediaRxPort()

Gets the value. The port chosen by the application server for the Rx RTP stream for this connection. This field can only be relied on if WaitForMedia has been set to a value of Rx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Returns:

the value.

setMediaRxPort

public void setMediaRxPort(java.lang.Long value)

Sets the value. The port chosen by the application server for the Rx RTP stream for this connection. This field can only be relied on if WaitForMedia has been set to a value of Rx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Parameters:

value - the value.

getMediaRxCodec

public java.lang.String getMediaRxCodec()

Gets the value. The codec chosen by the application server for the Rx RTP stream for this connection. This field can only be relied on if WaitForMedia has been set to a value of Rx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Returns:

the value.

setMediaRxCodec

public void setMediaRxCodec(java.lang.String value)

Sets the value. The codec chosen by the application server for the Rx RTP stream for this connection. This field can only be relied on if WaitForMedia has been set to a value of Rx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Parameters:

value - the value.

getMediaRxFramesize

public java.lang.Long getMediaRxFramesize()

Gets the value. The framesize chosen by the application server for the Rx RTP stream for this connection. This field can only be relied on if WaitForMedia has been set to a value of Rx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Returns:

the value.

setMediaRxFramesize

public void setMediaRxFramesize(java.lang.Long value)

Sets the value. The framesize chosen by the application server for the Rx RTP stream for this connection. This field can only be relied on if WaitForMedia has been set to a value of Rx or TxRx. However, regardless if this field is available as a result data parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer.

Parameters:

value - the value.