Provider
Synchronous
No Custom Parameters
Provisions a connection on a media engine without establishing the transmit RTP stream.
ReserveConnection is a means to provision a connection on the media engine without specifying transmit information to a remote endpoint.
Because the ReserveConnection action does not specify the transmit information,
the Tx RTP stream associated with this connection is not operational after the action has successfully completed.
Therefore, ReserveConnection is virtually always followed by CreateConnection,
which one can use to specify the transmit properties on the connection returned by ReserveConnection.
Once CreateConnection has been used successfully,
both Rx and Tx have been defined on the connection and audio is flowing between the media engine and the remote endpoint.
If 300 seconds elapse and CreateConnection has not been performed on a connection created by ReserveConnection,
then the connection will be destroyed automatically by the media engine.
For the lifetime of a connection created via ReserveConnection, one RTP resource is used. If a low bitrate codec is used for this connection, then one Enhanced RTP resource is also used in conjuction with the RTP resource for the lifetime of the connection.
| Parameter Name | .NET Type | Default | Description |
|---|---|---|---|
| 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. | |
| 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. | |
| MmsId | System.UInt32 | The ID of the media engine to reserve the connection on. If no MmsId is specified when using ReserveConnection, 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 ReserveConnection is invoked. | |
| 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. |
| Parameter Name | .NET Type | Description |
|---|---|---|
| ConnectionId | System.String | 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 | System.String | The RTCP IP address of the media engine which is in control of this connection. |
| MediaRxIP | System.String | The IP address that the Rx RTP stream must be sent to for this connection. |
| MediaRxPort | System.UInt32 | The port that the Rx RTP stream must be sent to for this connection. |
| MmsId | System.UInt32 | 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 | 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. |
Branch Conditions
No description.
No description.
No description.