cisco.uc.cuae.legacy
Class MediaControl.ReserveConnectionResult

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

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

MediaControl

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

See Also:

Serialized Form

Field Summary

java.lang.String	connectionId Unique identifier used to identify this connection in all subsequent Media Control API operations.
java.lang.String	mediaRxControlIP The RTCP IP address of the media engine which is in control of this connection.
java.lang.Long	mediaRxControlPort The RTCP port of the connection.
java.lang.String	mediaRxIP The IP address that the Rx RTP stream must be sent to for this connection.
java.lang.Long	mediaRxPort The port that the Rx RTP stream must be sent to for this connection.
java.lang.Long	mmsId Unique identifier used to identify the media engine in control of this new connection.
java.lang.String	resultCode A numeric code indicating the result status of the operation.
CuaeCommon.CuaeResult	returnValue

Constructor Summary

MediaControl.ReserveConnectionResult()
Constructs the ReserveConnectionResult.

MediaControl.ReserveConnectionResult(CuaeCommon.CuaeResult returnValue, java.lang.String connectionId, java.lang.String mediaRxControlIP, java.lang.String mediaRxIP, java.lang.Long mediaRxPort, java.lang.Long mmsId, java.lang.Long mediaRxControlPort, java.lang.String resultCode)
Constructs the ReserveConnectionResult.

Method Summary

java.lang.String	getConnectionId() Gets the value.
java.lang.String	getMediaRxControlIP() Gets the value.
java.lang.Long	getMediaRxControlPort() Gets the value.
java.lang.String	getMediaRxIP() Gets the value.
java.lang.Long	getMediaRxPort() Gets the value.
java.lang.Long	getMmsId() Gets the value.
java.lang.String	getResultCode() Gets the value.
CuaeCommon.CuaeResult	getReturnValue() Gets the value.
void	setConnectionId(java.lang.String value) Sets the value.
void	setMediaRxControlIP(java.lang.String value) Sets the value.
void	setMediaRxControlPort(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	setMmsId(java.lang.Long value) Sets the value.
void	setResultCode(java.lang.String 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

connectionId

public java.lang.String connectionId

Unique identifier used to identify this connection in all subsequent Media Control API operations. Before using with most Media Control actions, this connection must still be fully connected with CreateConnection.

mediaRxControlIP

public java.lang.String mediaRxControlIP

The RTCP IP address of the media engine which is in control of this connection.

mediaRxIP

public java.lang.String mediaRxIP

The IP address that the Rx RTP stream must be sent to for this connection.

mediaRxPort

public java.lang.Long mediaRxPort

The port that the Rx RTP stream must be sent to for this connection.

mmsId

public java.lang.Long mmsId

Unique identifier used to identify the media engine in control of this new 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.

mediaRxControlPort

public java.lang.Long mediaRxControlPort

The RTCP port of the connection.

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.

Constructor Detail

MediaControl.ReserveConnectionResult

public MediaControl.ReserveConnectionResult()

Constructs the ReserveConnectionResult. Don't init any fields.

MediaControl.ReserveConnectionResult

public MediaControl.ReserveConnectionResult(CuaeCommon.CuaeResult returnValue,
                                            java.lang.String connectionId,
                                            java.lang.String mediaRxControlIP,
                                            java.lang.String mediaRxIP,
                                            java.lang.Long mediaRxPort,
                                            java.lang.Long mmsId,
                                            java.lang.Long mediaRxControlPort,
                                            java.lang.String resultCode)

Constructs the ReserveConnectionResult.

Parameters:

connectionId - Unique identifier used to identify this connection in all subsequent connectionId Media Control API operations. Before using with most Media Control connectionId actions, this connection must still be fully connected with connectionId CreateConnection. connectionId

mediaRxControlIP - The RTCP IP address of the media engine which is in control of this mediaRxControlIP connection. mediaRxControlIP

mediaRxIP - The IP address that the Rx RTP stream must be sent to for this mediaRxIP connection. mediaRxIP

mediaRxPort - The port that the Rx RTP stream must be sent to for this connection. mediaRxPort

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

mediaRxControlPort - The RTCP port of the connection. mediaRxControlPort

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

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.

getConnectionId

public java.lang.String getConnectionId()

Gets the value. Unique identifier used to identify this connection in all subsequent Media Control API operations. Before using with most Media Control actions, this connection must still be fully connected with CreateConnection.

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. Before using with most Media Control actions, this connection must still be fully connected with CreateConnection.

Parameters:

value - the value.

getMediaRxControlIP

public java.lang.String getMediaRxControlIP()

Gets the value. The RTCP IP address of the media engine which is in control of this connection.

Returns:

the value.

setMediaRxControlIP

public void setMediaRxControlIP(java.lang.String value)

Sets the value. The RTCP IP address of the media engine which is in control of this connection.

Parameters:

value - the value.

getMediaRxIP

public java.lang.String getMediaRxIP()

Gets the value. The IP address that the Rx RTP stream must be sent to for this connection.

Returns:

the value.

setMediaRxIP

public void setMediaRxIP(java.lang.String value)

Sets the value. The IP address that the Rx RTP stream must be sent to for this connection.

Parameters:

value - the value.

getMediaRxPort

public java.lang.Long getMediaRxPort()

Gets the value. The port that the Rx RTP stream must be sent to for this connection.

Returns:

the value.

setMediaRxPort

public void setMediaRxPort(java.lang.Long value)

Sets the value. The port that the Rx RTP stream must be sent to for this connection.

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 new 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 new 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.

getMediaRxControlPort

public java.lang.Long getMediaRxControlPort()

Gets the value. The RTCP port of the connection.

Returns:

the value.

setMediaRxControlPort

public void setMediaRxControlPort(java.lang.Long value)

Sets the value. The RTCP port of the connection.

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.