Provider
Synchronous
No Custom Parameters
Modifies the properties of an existing connection on a media engine.
ModifyConnection is used to modify the properties of a connection previously established by
CreateConnection or by the
Call Control API via AnswerCall
and MakeCall.
If an optional action parameter is not required and you do not specify a value for the parameter,
then that property of the connection is left unmodified.
ModifyConnection can not be used on a connection that has been created by
ReserveConnection but has not yet been established with
CreateConnection.
ModifyConnection is automatically invoked on a connection created by the Call Control API whenever the media properties of a call change, such as when the call is placed on on hold or resumed from hold. This is not true if the call is in a peer-to-peer relationship.
| Parameter Name | .NET Type | Default | Description |
|---|---|---|---|
| ConnectionId * | System.String | A ConnectionId returned by a previously executed CreateConnection action. | |
| MediaTxControlIP | System.String | The RTCP IP address of the remote endpoint. | |
| MediaTxIP * | System.String | The IP address that the Tx RTP stream will transmit audio to. | |
| MediaTxPort * | System.UInt32 | The port that the Tx RTP stream will transmit audio to. | |
| Timeout | System.Int32 | 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. | |
| MediaTxControlPort | System.UInt32 | The RTCP port of the remote endpoint. | |
| MediaRxCodec | System.String | 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 | System.UInt32 | 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. | |
| MediaTxCodec | System.String | 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. | |
| MediaTxFramesize | System.UInt32 | 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 | System.Int64 | The ID of the call associated with this connection (hairpin only). |
| Parameter Name | .NET Type | Description |
|---|---|---|
| MediaRxPort | System.UInt32 | The port that the Rx RTP stream must be sent to for this connection. |
| MediaRxControlPort | System.UInt32 | The RTCP port of the connection. |
| ResultCode | System.String | 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. |
| MediaRxIP | System.String | The IP address that the Rx RTP stream must be sent to for this connection. |
| MediaRxControlIP | System.String | The RTCP IP address of the media engine which is in control of this connection. |
| ConnectionId | System.String | Unique identifier used to identify this connection in all subsequent Media Control operations.
This will always be same as the supplied action parameter ConnectionId. |
| MmsId | System.UInt32 | 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. |
Branch Conditions
No description.
No description.
No description.