cisco.uc.cuae.legacy
Class CallControl.StartTxOptions

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

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

CallControl

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

See Also:

Serialized Form

Field Summary

java.lang.String	callId Unique identifier used to identify the call leg that has received transmit information from the remote endpoint.
java.lang.String	connectionId Unique identifier used to identify this connection in all Media Control API operations.
java.lang.String	mediaTxCodec The codec that the application server should use when sending audio.
java.lang.Long	mediaTxFramesize The framesize that the application server should use when sending audio.
java.lang.String	mediaTxIP The IP address that the application server should send audio to.
java.lang.Long	mediaTxPort The port that the application server should send audio to.
java.lang.Long	mmsId Unique identifier used to identify the media engine in control of this connection.

Constructor Summary

CallControl.StartTxOptions()
Constructs the StartTxOptions.

CallControl.StartTxOptions(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)
Constructs the StartTxOptions.

Method Summary

java.lang.String	getCallId() Gets the value.
java.lang.String	getConnectionId() 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.
void	setCallId(java.lang.String value) Sets the value.
void	setConnectionId(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	setMmsId(java.lang.Long 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

callId

public java.lang.String callId

Unique identifier used to identify the call leg that has received transmit information from the remote endpoint.

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. This event parameter will not be populated if the call is in a peer-to-peer relationship.

connectionId

public java.lang.String connectionId

Unique identifier used to identify this connection in all Media Control API operations. This event parameter will not be populated if the call is in a peer-to-peer relationship.

mediaTxIP

public java.lang.String mediaTxIP

The IP address that the application server should send audio to. If a connection is associated with this call, this value is already associated with that connection.

mediaTxPort

public java.lang.Long mediaTxPort

The port that the application server should send audio to. If a connection is associated with this call, this value is already associated with that connection.

mediaTxCodec

public java.lang.String mediaTxCodec

The codec that the application server should use when sending audio. If a connection is associated with this call, this value is already associated with that connection.

mediaTxFramesize

public java.lang.Long mediaTxFramesize

The framesize that the application server should use when sending audio. If a connection is associated with this call, this value is already associated with that connection.

Constructor Detail

CallControl.StartTxOptions

public CallControl.StartTxOptions()

Constructs the StartTxOptions. Don't init any fields.

CallControl.StartTxOptions

public CallControl.StartTxOptions(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)

Constructs the StartTxOptions.

Parameters:

callId - Unique identifier used to identify the call leg that has received transmit callId information from the remote endpoint. 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. This event parameter will not be populated if the call is in a mmsId peer-to-peer relationship. mmsId

connectionId - Unique identifier used to identify this connection in all Media Control API connectionId operations. This event parameter will not be populated if the call is in a connectionId peer-to-peer relationship. connectionId

mediaTxIP - The IP address that the application server should send audio to. If a mediaTxIP connection is associated with this call, this value is already associated mediaTxIP with that connection. mediaTxIP

mediaTxPort - The port that the application server should send audio to. If a connection mediaTxPort is associated with this call, this value is already associated with that mediaTxPort connection. mediaTxPort

mediaTxCodec - The codec that the application server should use when sending audio. If a mediaTxCodec connection is associated with this call, this value is already associated mediaTxCodec with that connection. mediaTxCodec

mediaTxFramesize - The framesize that the application server should use when sending audio. If mediaTxFramesize a connection is associated with this call, this value is already associated mediaTxFramesize with that connection. mediaTxFramesize

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCallId

public java.lang.String getCallId()

Gets the value. Unique identifier used to identify the call leg that has received transmit information from the remote endpoint.

Returns:

the value.

setCallId

public void setCallId(java.lang.String value)

Sets the value. Unique identifier used to identify the call leg that has received transmit information from the remote endpoint.

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. This event parameter will not be populated if the call is in a peer-to-peer relationship.

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. This event parameter will not be populated if the call is in a peer-to-peer relationship.

Parameters:

value - the value.

getConnectionId

public java.lang.String getConnectionId()

Gets the value. Unique identifier used to identify this connection in all Media Control API operations. This event parameter will not be populated if the call is in a peer-to-peer relationship.

Returns:

the value.

setConnectionId

public void setConnectionId(java.lang.String value)

Sets the value. Unique identifier used to identify this connection in all Media Control API operations. This event parameter will not be populated if the call is in a peer-to-peer relationship.

Parameters:

value - the value.

getMediaTxIP

public java.lang.String getMediaTxIP()

Gets the value. The IP address that the application server should send audio to. If a connection is associated with this call, 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 application server should send audio to. If a connection is associated with this call, 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 application server should send audio to. If a connection is associated with this call, 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 application server should send audio to. If a connection is associated with this call, 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 application server should use when sending audio. If a connection is associated with this call, 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 application server should use when sending audio. If a connection is associated with this call, 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 application server should use when sending audio. If a connection is associated with this call, 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 application server should use when sending audio. If a connection is associated with this call, this value is already associated with that connection.

Parameters:

value - the value.