cisco.uc.cuae.legacy
Class MediaControl.CreateConnectionOptions

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

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

MediaControl

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

See Also:

Serialized Form

Field Summary

java.lang.Long	callId The CallId of the call associated with this connection (hairpin only).
MediaControl.MediaRxCodec	mediaRxCodec The codec to use for the RTP stream inbound to the media engine.
java.lang.Long	mediaRxFramesize The framesize (in milliseconds) to use for the RTP stream inbound to the media engine.
MediaControl.MediaRxCodec	mediaTxCodec The codec to use for the RTP stream outbound from the media engine.
java.lang.String	mediaTxControlIP The RTCP IP address of the remote endpoint.
java.lang.Long	mediaTxControlPort The RTCP port of the remote endpoint.
java.lang.Long	mediaTxFramesize The framesize (in milliseconds) to use for the RTP stream outbound from the media engine.
java.lang.Long	mmsId The ID of the media engine to create the connection on.
java.lang.Integer	timeout The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action.

Constructor Summary

MediaControl.CreateConnectionOptions()
Constructs the CreateConnectionOptions.

MediaControl.CreateConnectionOptions(MediaControl.MediaRxCodec mediaTxCodec, java.lang.Long mmsId, java.lang.String mediaTxControlIP, java.lang.Long mediaTxControlPort, MediaControl.MediaRxCodec mediaRxCodec, java.lang.Long mediaRxFramesize, java.lang.Integer timeout, java.lang.Long mediaTxFramesize, java.lang.Long callId)
Constructs the CreateConnectionOptions.

Method Summary

java.lang.Long	getCallId() Gets the value.
MediaControl.MediaRxCodec	getMediaRxCodec() Gets the value.
java.lang.Long	getMediaRxFramesize() Gets the value.
MediaControl.MediaRxCodec	getMediaTxCodec() Gets the value.
java.lang.String	getMediaTxControlIP() Gets the value.
java.lang.Long	getMediaTxControlPort() Gets the value.
java.lang.Long	getMediaTxFramesize() Gets the value.
java.lang.Long	getMmsId() Gets the value.
java.lang.Integer	getTimeout() Gets the value.
void	setCallId(java.lang.Long value) Sets the value.
void	setMediaRxCodec(MediaControl.MediaRxCodec value) Sets the value.
void	setMediaRxFramesize(java.lang.Long value) Sets the value.
void	setMediaTxCodec(MediaControl.MediaRxCodec value) Sets the value.
void	setMediaTxControlIP(java.lang.String value) Sets the value.
void	setMediaTxControlPort(java.lang.Long value) Sets the value.
void	setMediaTxFramesize(java.lang.Long value) Sets the value.
void	setMmsId(java.lang.Long value) Sets the value.
void	setTimeout(java.lang.Integer 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

mediaTxCodec

public MediaControl.MediaRxCodec mediaTxCodec

The codec to use for the RTP stream outbound from the media engine. Valid values are G711u, G711a, G723, and G729. If not specified, the media engine configuration file defines the codec to use, which by default is G711u.

mmsId

public java.lang.Long mmsId

The ID of the media engine to create the connection on. This field is only relevant if CreateConnection is being used to create a new connection; not if being used to fully establish a connection that was previously created by ReserveConnection. If no MmsId is specified when using CreateConnection, a media engine with the most available resources is dynamically selected from the Media Resource Group associated with the partition of the script instance from which CreateConnection is invoked.

mediaTxControlIP

public java.lang.String mediaTxControlIP

The RTCP IP address of the remote endpoint.

mediaTxControlPort

public java.lang.Long mediaTxControlPort

The RTCP port of the remote endpoint.

mediaRxCodec

public MediaControl.MediaRxCodec mediaRxCodec

The codec to use for the RTP stream inbound to the media engine. Valid values are G711u, G711a, G723, and G729. If not specified, the media engine configuration file defines the codec to use, which by default is G711u.

mediaRxFramesize

public java.lang.Long mediaRxFramesize

The framesize (in milliseconds) to use for the RTP stream inbound to the media engine. If not specified, the media engine configuration file defines the framesize to use, which by default is 20ms.

timeout

public java.lang.Integer timeout

The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.

mediaTxFramesize

public java.lang.Long mediaTxFramesize

The framesize (in milliseconds) to use for the RTP stream outbound from the media engine. If not specified, the media engine configuration file defines the framesize to use, which by default is 20ms.

callId

public java.lang.Long callId

The CallId of the call associated with this connection (hairpin only).

Constructor Detail

MediaControl.CreateConnectionOptions

public MediaControl.CreateConnectionOptions()

Constructs the CreateConnectionOptions. Don't init any fields.

MediaControl.CreateConnectionOptions

public MediaControl.CreateConnectionOptions(MediaControl.MediaRxCodec mediaTxCodec,
                                            java.lang.Long mmsId,
                                            java.lang.String mediaTxControlIP,
                                            java.lang.Long mediaTxControlPort,
                                            MediaControl.MediaRxCodec mediaRxCodec,
                                            java.lang.Long mediaRxFramesize,
                                            java.lang.Integer timeout,
                                            java.lang.Long mediaTxFramesize,
                                            java.lang.Long callId)

Constructs the CreateConnectionOptions.

Parameters:

mediaTxCodec - The codec to use for the RTP stream outbound from the media engine. Valid mediaTxCodec values are G711u, G711a, G723, and G729. If not specified, the media engine mediaTxCodec configuration file defines the codec to use, which by default is G711u. mediaTxCodec

mmsId - The ID of the media engine to create the connection on. This field is only mmsId relevant if CreateConnection is being used to create a new connection; not mmsId if being used to fully establish a connection that was previously created mmsId by ReserveConnection. If no MmsId is specified when using CreateConnection, mmsId a media engine with the most available resources is dynamically selected mmsId from the Media Resource Group associated with the partition of the script mmsId instance from which CreateConnection is invoked. mmsId

mediaTxControlIP - The RTCP IP address of the remote endpoint. mediaTxControlIP

mediaTxControlPort - The RTCP port of the remote endpoint. mediaTxControlPort

mediaRxCodec - The codec to use for the RTP stream inbound to the media engine. Valid mediaRxCodec values are G711u, G711a, G723, and G729. If not specified, the media engine mediaRxCodec configuration file defines the codec to use, which by default is G711u. mediaRxCodec

mediaRxFramesize - The framesize (in milliseconds) to use for the RTP stream inbound to the mediaRxFramesize media engine. If not specified, the media engine configuration file defines mediaRxFramesize the framesize to use, which by default is 20ms. mediaRxFramesize

timeout - The Timeout property specifies to the Application Runtime Environment how timeout long to wait for a response from the provider for the current action. The timeout ReturnValue returned in this case is Timeout. The value must be a literal timeout value in milliseconds. timeout

mediaTxFramesize - The framesize (in milliseconds) to use for the RTP stream outbound from the mediaTxFramesize media engine. If not specified, the media engine configuration file defines mediaTxFramesize the framesize to use, which by default is 20ms. mediaTxFramesize

callId - The CallId of the call associated with this connection (hairpin only). callId

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMediaTxCodec

public MediaControl.MediaRxCodec getMediaTxCodec()

Gets the value. The codec to use for the RTP stream outbound from the media engine. Valid values are G711u, G711a, G723, and G729. If not specified, the media engine configuration file defines the codec to use, which by default is G711u.

Returns:

the value.

setMediaTxCodec

public void setMediaTxCodec(MediaControl.MediaRxCodec value)

Sets the value. The codec to use for the RTP stream outbound from the media engine. Valid values are G711u, G711a, G723, and G729. If not specified, the media engine configuration file defines the codec to use, which by default is G711u.

Parameters:

value - the value.

getMmsId

public java.lang.Long getMmsId()

Gets the value. The ID of the media engine to create the connection on. This field is only relevant if CreateConnection is being used to create a new connection; not if being used to fully establish a connection that was previously created by ReserveConnection. If no MmsId is specified when using CreateConnection, a media engine with the most available resources is dynamically selected from the Media Resource Group associated with the partition of the script instance from which CreateConnection is invoked.

Returns:

the value.

setMmsId

public void setMmsId(java.lang.Long value)

Sets the value. The ID of the media engine to create the connection on. This field is only relevant if CreateConnection is being used to create a new connection; not if being used to fully establish a connection that was previously created by ReserveConnection. If no MmsId is specified when using CreateConnection, a media engine with the most available resources is dynamically selected from the Media Resource Group associated with the partition of the script instance from which CreateConnection is invoked.

Parameters:

value - the value.

getMediaTxControlIP

public java.lang.String getMediaTxControlIP()

Gets the value. The RTCP IP address of the remote endpoint.

Returns:

the value.

setMediaTxControlIP

public void setMediaTxControlIP(java.lang.String value)

Sets the value. The RTCP IP address of the remote endpoint.

Parameters:

value - the value.

getMediaTxControlPort

public java.lang.Long getMediaTxControlPort()

Gets the value. The RTCP port of the remote endpoint.

Returns:

the value.

setMediaTxControlPort

public void setMediaTxControlPort(java.lang.Long value)

Sets the value. The RTCP port of the remote endpoint.

Parameters:

value - the value.

getMediaRxCodec

public MediaControl.MediaRxCodec getMediaRxCodec()

Gets the value. The codec to use for the RTP stream inbound to the media engine. Valid values are G711u, G711a, G723, and G729. If not specified, the media engine configuration file defines the codec to use, which by default is G711u.

Returns:

the value.

setMediaRxCodec

public void setMediaRxCodec(MediaControl.MediaRxCodec value)

Sets the value. The codec to use for the RTP stream inbound to the media engine. Valid values are G711u, G711a, G723, and G729. If not specified, the media engine configuration file defines the codec to use, which by default is G711u.

Parameters:

value - the value.

getMediaRxFramesize

public java.lang.Long getMediaRxFramesize()

Gets the value. The framesize (in milliseconds) to use for the RTP stream inbound to the media engine. If not specified, the media engine configuration file defines the framesize to use, which by default is 20ms.

Returns:

the value.

setMediaRxFramesize

public void setMediaRxFramesize(java.lang.Long value)

Sets the value. The framesize (in milliseconds) to use for the RTP stream inbound to the media engine. If not specified, the media engine configuration file defines the framesize to use, which by default is 20ms.

Parameters:

value - the value.

getTimeout

public java.lang.Integer getTimeout()

Gets the value. The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.

Returns:

the value.

setTimeout

public void setTimeout(java.lang.Integer value)

Sets the value. The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds.

Parameters:

value - the value.

getMediaTxFramesize

public java.lang.Long getMediaTxFramesize()

Gets the value. The framesize (in milliseconds) to use for the RTP stream outbound from the media engine. If not specified, the media engine configuration file defines the framesize to use, which by default is 20ms.

Returns:

the value.

setMediaTxFramesize

public void setMediaTxFramesize(java.lang.Long value)

Sets the value. The framesize (in milliseconds) to use for the RTP stream outbound from the media engine. If not specified, the media engine configuration file defines the framesize to use, which by default is 20ms.

Parameters:

value - the value.

getCallId

public java.lang.Long getCallId()

Gets the value. The CallId of the call associated with this connection (hairpin only).

Returns:

the value.

setCallId

public void setCallId(java.lang.Long value)

Sets the value. The CallId of the call associated with this connection (hairpin only).

Parameters:

value - the value.