cisco.uc.cuae.legacy
Class CallControl.GetRemoteMediaResult

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

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

CallControl

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

See Also:

Serialized Form

Field Summary

java.lang.String	callId Indicates the call for which remote media inforamtion is retrieved.
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.
CuaeCommon.CuaeResult	returnValue

Constructor Summary

CallControl.GetRemoteMediaResult()
Constructs the GetRemoteMediaResult.

CallControl.GetRemoteMediaResult(CuaeCommon.CuaeResult returnValue, java.lang.String callId, java.lang.String mediaTxIP, java.lang.Long mediaTxPort, java.lang.String mediaTxCodec, java.lang.Long mediaTxFramesize)
Constructs the GetRemoteMediaResult.

Method Summary

java.lang.String	getCallId() 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.
CuaeCommon.CuaeResult	getReturnValue() Gets the value.
void	setCallId(java.lang.String 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	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 for which remote media inforamtion is retrieved. This is always the same value passed in as the CallId action parameter.

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.

Constructor Detail

CallControl.GetRemoteMediaResult

public CallControl.GetRemoteMediaResult()

Constructs the GetRemoteMediaResult. Don't init any fields.

CallControl.GetRemoteMediaResult

public CallControl.GetRemoteMediaResult(CuaeCommon.CuaeResult returnValue,
                                        java.lang.String callId,
                                        java.lang.String mediaTxIP,
                                        java.lang.Long mediaTxPort,
                                        java.lang.String mediaTxCodec,
                                        java.lang.Long mediaTxFramesize)

Constructs the GetRemoteMediaResult.

Parameters:

callId - Indicates the call for which remote media inforamtion is retrieved. This callId is always the same value passed in as the CallId action parameter. callId

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

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 for which remote media inforamtion is retrieved. 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 for which remote media inforamtion is retrieved. This is always the same value passed in as the CallId action parameter.

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.