cisco.uc.cuae.legacy
Class CallControl.StartRxOptions

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

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

CallControl

public static class CallControl.StartRxOptions
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 the application server has designated receive information for.
java.lang.String	connectionId Unique identifier used to identify this connection in all Media Control operations.
java.lang.String	mediaRxCodec The codec that the remote endpoint should use when sending audio to the media engine.
java.lang.Long	mediaRxFramesize The framesize that the remote endpoint should use when sending audio to the media engine.
java.lang.String	mediaRxIP The IP address that the media engine should receive audio on.
java.lang.Long	mediaRxPort The port that the media engine should receive audio on.
java.lang.Long	mmsId Unique identifier used to identify the media engine in control of this connection.

Constructor Summary

CallControl.StartRxOptions()
Constructs the StartRxOptions.

CallControl.StartRxOptions(java.lang.String callId, java.lang.Long mmsId, java.lang.String connectionId, java.lang.String mediaRxIP, java.lang.Long mediaRxPort, java.lang.String mediaRxCodec, java.lang.Long mediaRxFramesize)
Constructs the StartRxOptions.

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.Long	getMmsId() 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	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 the application server has designated receive information for.

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 Media Control operations.

mediaRxIP

public java.lang.String mediaRxIP

The IP address that the media engine should receive audio on. This value is already associated with the connection associated with the call.

mediaRxPort

public java.lang.Long mediaRxPort

The port that the media engine should receive audio on. This value is already associated with the connection associated with the call.

mediaRxCodec

public java.lang.String mediaRxCodec

The codec that the remote endpoint should use when sending audio to the media engine. This value is already associated with the connection associated with the call.

mediaRxFramesize

public java.lang.Long mediaRxFramesize

The framesize that the remote endpoint should use when sending audio to the media engine. This value is already associated with the connection associated with the call.

Constructor Detail

CallControl.StartRxOptions

public CallControl.StartRxOptions()

Constructs the StartRxOptions. Don't init any fields.

CallControl.StartRxOptions

public CallControl.StartRxOptions(java.lang.String callId,
                                  java.lang.Long mmsId,
                                  java.lang.String connectionId,
                                  java.lang.String mediaRxIP,
                                  java.lang.Long mediaRxPort,
                                  java.lang.String mediaRxCodec,
                                  java.lang.Long mediaRxFramesize)

Constructs the StartRxOptions.

Parameters:

callId - Unique identifier used to identify the call leg that the application server callId has designated receive information for. 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 Media Control connectionId operations. connectionId

mediaRxIP - The IP address that the media engine should receive audio on. This value is mediaRxIP already associated with the connection associated with the call. mediaRxIP

mediaRxPort - The port that the media engine should receive audio on. This value is mediaRxPort already associated with the connection associated with the call. mediaRxPort

mediaRxCodec - The codec that the remote endpoint should use when sending audio to the mediaRxCodec media engine. This value is already associated with the connection mediaRxCodec associated with the call. mediaRxCodec

mediaRxFramesize - The framesize that the remote endpoint should use when sending audio to the mediaRxFramesize media engine. This value is already associated with the connection mediaRxFramesize associated with the call. mediaRxFramesize

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 the application server has designated receive information for.

Returns:

the value.

setCallId

public void setCallId(java.lang.String value)

Sets the value. Unique identifier used to identify the call leg that the application server has designated receive information for.

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 Media Control operations.

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

Parameters:

value - the value.

getMediaRxIP

public java.lang.String getMediaRxIP()

Gets the value. The IP address that the media engine should receive audio on. This value is already associated with the connection associated with the call.

Returns:

the value.

setMediaRxIP

public void setMediaRxIP(java.lang.String value)

Sets the value. The IP address that the media engine should receive audio on. This value is already associated with the connection associated with the call.

Parameters:

value - the value.

getMediaRxPort

public java.lang.Long getMediaRxPort()

Gets the value. The port that the media engine should receive audio on. This value is already associated with the connection associated with the call.

Returns:

the value.

setMediaRxPort

public void setMediaRxPort(java.lang.Long value)

Sets the value. The port that the media engine should receive audio on. This value is already associated with the connection associated with the call.

Parameters:

value - the value.

getMediaRxCodec

public java.lang.String getMediaRxCodec()

Gets the value. The codec that the remote endpoint should use when sending audio to the media engine. This value is already associated with the connection associated with the call.

Returns:

the value.

setMediaRxCodec

public void setMediaRxCodec(java.lang.String value)

Sets the value. The codec that the remote endpoint should use when sending audio to the media engine. This value is already associated with the connection associated with the call.

Parameters:

value - the value.

getMediaRxFramesize

public java.lang.Long getMediaRxFramesize()

Gets the value. The framesize that the remote endpoint should use when sending audio to the media engine. This value is already associated with the connection associated with the call.

Returns:

the value.

setMediaRxFramesize

public void setMediaRxFramesize(java.lang.Long value)

Sets the value. The framesize that the remote endpoint should use when sending audio to the media engine. This value is already associated with the connection associated with the call.

Parameters:

value - the value.