cisco.uc.cuae.legacy
Class CallControl.BargeResult

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

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

CallControl

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

See Also:

Serialized Form

Field Summary

java.lang.String	callId Unique identifier used to identify this call in all subsequent Call Control operations.
java.lang.String	connectionId Unique identifier used to identify this connection in all subsequent Media Control API operations.
java.lang.String	mediaRxCodec The codec that the Rx RTP stream is using for this connection.
java.lang.Long	mediaRxFramesize The framesize that the Rx RTP stream is using for this connection.
java.lang.String	mediaRxIP Unique identifier used to identify this connection in all subsequent Media Control API operations.
java.lang.Long	mediaRxPort The IP address that the Rx RTP stream must be sent to for this connection.
java.lang.String	mediaTxCodec The codec that the barging in party should use.
java.lang.Long	mediaTxFramesize The framesize that the barging in party should use.
java.lang.String	mediaTxIP The IP address that the barging in party should send audio to.
java.lang.Long	mediaTxPort The port that the barging in party 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.BargeResult()
Constructs the BargeResult.

CallControl.BargeResult(CuaeCommon.CuaeResult returnValue, java.lang.String callId, java.lang.Long mmsId, java.lang.String connectionId, 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 BargeResult.

Method Summary

java.lang.String	getCallId() 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	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

Unique identifier used to identify this call in all subsequent Call Control operations.

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. A value is returned only if MediaRxIP and MediaRxPort were not specified.

mediaTxIP

public java.lang.String mediaTxIP

The IP address that the barging in party should send audio to. If a connection was created by this action, this value is already associated with that connection.

mediaTxPort

public java.lang.Long mediaTxPort

The port that the barging in party should send audio to. If a connection was created by this action, this value is already associated with that connection.

mediaTxCodec

public java.lang.String mediaTxCodec

The codec that the barging in party should use. If a connection was created by this action, this value is already associated with that connection.

mediaTxFramesize

public java.lang.Long mediaTxFramesize

The framesize that the barging in party should use. If a connection was created by this action, this value is already associated with that connection.

mediaRxIP

public java.lang.String mediaRxIP

Unique identifier used to identify this connection in all subsequent Media Control API operations. A value is returned only if MediaRxIP and MediaRxPort were not specified.

mediaRxPort

public java.lang.Long mediaRxPort

The IP address that the Rx RTP stream must be sent to for this connection. A value is returned only if MediaRxIP and MediaRxPort were not specified.

mediaRxCodec

public java.lang.String mediaRxCodec

The codec that the Rx RTP stream is using for this connection.

mediaRxFramesize

public java.lang.Long mediaRxFramesize

The framesize that the Rx RTP stream is using for this connection.

Constructor Detail

CallControl.BargeResult

public CallControl.BargeResult()

Constructs the BargeResult. Don't init any fields.

CallControl.BargeResult

public CallControl.BargeResult(CuaeCommon.CuaeResult returnValue,
                               java.lang.String callId,
                               java.lang.Long mmsId,
                               java.lang.String connectionId,
                               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 BargeResult.

Parameters:

callId - Unique identifier used to identify this call in all subsequent Call callId Control operations. 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. A value is returned only if MediaRxIP and connectionId MediaRxPort were not specified. connectionId

mediaTxIP - The IP address that the barging in party should send audio to. If a mediaTxIP connection was created by this action, this value is already associated mediaTxIP with that connection. mediaTxIP

mediaTxPort - The port that the barging in party should send audio to. If a connection mediaTxPort was created by this action, this value is already associated with that mediaTxPort connection. mediaTxPort

mediaTxCodec - The codec that the barging in party should use. If a connection was mediaTxCodec created by this action, this value is already associated with that mediaTxCodec connection. mediaTxCodec

mediaTxFramesize - The framesize that the barging in party should use. If a connection was mediaTxFramesize created by this action, this value is already associated with that mediaTxFramesize connection. mediaTxFramesize

mediaRxIP - Unique identifier used to identify this connection in all subsequent mediaRxIP Media Control API operations. A value is returned only if MediaRxIP and mediaRxIP MediaRxPort were not specified. mediaRxIP

mediaRxPort - The IP address that the Rx RTP stream must be sent to for this mediaRxPort connection. A value is returned only if MediaRxIP and MediaRxPort were mediaRxPort not specified. mediaRxPort

mediaRxCodec - The codec that the Rx RTP stream is using for this connection. mediaRxCodec

mediaRxFramesize - The framesize that the Rx RTP stream is using for this connection. 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. Unique identifier used to identify this call in all subsequent Call Control operations.

Returns:

the value.

setCallId

public void setCallId(java.lang.String value)

Sets the value. Unique identifier used to identify this call in all subsequent Call Control operations.

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. A value is returned only if MediaRxIP and MediaRxPort were not specified.

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. A value is returned only if MediaRxIP and MediaRxPort were not specified.

Parameters:

value - the value.

getMediaTxIP

public java.lang.String getMediaTxIP()

Gets the value. The IP address that the barging in party should send audio to. If a connection was created by this action, this value is already associated with that connection.

Returns:

the value.

setMediaTxIP

public void setMediaTxIP(java.lang.String value)

Sets the value. The IP address that the barging in party should send audio to. If a connection was created by this action, this value is already associated with that connection.

Parameters:

value - the value.

getMediaTxPort

public java.lang.Long getMediaTxPort()

Gets the value. The port that the barging in party should send audio to. If a connection was created by this action, this value is already associated with that connection.

Returns:

the value.

setMediaTxPort

public void setMediaTxPort(java.lang.Long value)

Sets the value. The port that the barging in party should send audio to. If a connection was created by this action, this value is already associated with that connection.

Parameters:

value - the value.

getMediaTxCodec

public java.lang.String getMediaTxCodec()

Gets the value. The codec that the barging in party should use. If a connection was created by this action, this value is already associated with that connection.

Returns:

the value.

setMediaTxCodec

public void setMediaTxCodec(java.lang.String value)

Sets the value. The codec that the barging in party should use. If a connection was created by this action, this value is already associated with that connection.

Parameters:

value - the value.

getMediaTxFramesize

public java.lang.Long getMediaTxFramesize()

Gets the value. The framesize that the barging in party should use. If a connection was created by this action, this value is already associated with that connection.

Returns:

the value.

setMediaTxFramesize

public void setMediaTxFramesize(java.lang.Long value)

Sets the value. The framesize that the barging in party should use. If a connection was created by this action, this value is already associated with that connection.

Parameters:

value - the value.

getMediaRxIP

public java.lang.String getMediaRxIP()

Gets the value. Unique identifier used to identify this connection in all subsequent Media Control API operations. A value is returned only if MediaRxIP and MediaRxPort were not specified.

Returns:

the value.

setMediaRxIP

public void setMediaRxIP(java.lang.String value)

Sets the value. Unique identifier used to identify this connection in all subsequent Media Control API operations. A value is returned only if MediaRxIP and MediaRxPort were not specified.

Parameters:

value - the value.

getMediaRxPort

public java.lang.Long getMediaRxPort()

Gets the value. The IP address that the Rx RTP stream must be sent to for this connection. A value is returned only if MediaRxIP and MediaRxPort were not specified.

Returns:

the value.

setMediaRxPort

public void setMediaRxPort(java.lang.Long value)

Sets the value. The IP address that the Rx RTP stream must be sent to for this connection. A value is returned only if MediaRxIP and MediaRxPort were not specified.

Parameters:

value - the value.

getMediaRxCodec

public java.lang.String getMediaRxCodec()

Gets the value. The codec that the Rx RTP stream is using for this connection.

Returns:

the value.

setMediaRxCodec

public void setMediaRxCodec(java.lang.String value)

Sets the value. The codec that the Rx RTP stream is using for this connection.

Parameters:

value - the value.

getMediaRxFramesize

public java.lang.Long getMediaRxFramesize()

Gets the value. The framesize that the Rx RTP stream is using for this connection.

Returns:

the value.

setMediaRxFramesize

public void setMediaRxFramesize(java.lang.Long value)

Sets the value. The framesize that the Rx RTP stream is using for this connection.

Parameters:

value - the value.