No Custom Parameters
Moves a connection into an existing conference.
In most cases,
Hairpin should be set to
true (the default) to use the minimum amount of audio resources for a 2-party conference. Specifically, a hairpinned conference does not use any conference resources. However, a hairpin conference will be 'promoted', or converted to a true media conference, if a 3rd participant is added to the conference or if a voice operation is performed on the conference itself. In either case, this will cause each participant and conferenced voice operation to use one conference resource. True conferences also have a slightly increased latency over a hairpinned conference.
All connections in the conference must be fully connected (Tx and Rx conditions both established on the connection;
CreateConnection and certain
actions in the Call Control API are used to accomplish this. For convenience, a
ConnectionId returned from a
ReserveConnection can be specified along with the
MediaTxCodec parameters, in which case a
CreateConnection does not have to be performed explicitly by the develeoper, since the media engine will automatically fully establish the Tx RTP properties the
ConnectionId as the connection is joined to conference.
Monitor have a similar effect to one another; the participant specified by
ConnectionId can only hear audio and is unable to send audio to the conference. The difference is that each
Mute participant is truly in the conference, and so uses a conference resource; at anytime this participant can be allowed to send audio seamlessly via the use of the
Monitor participants are not truly in the conference from an internal logic standpoint, and can only transmit audio into the conference by removing their connection from conference, and placing back in with
Monitor set to
false. One also saves resources by using
Mute for many participants. Each
Monitor participant shares one conference resource, but
Mute participants each need a conference resource.
Each connection in a conference uses one conference resource. Because this action places one connection into the conference, one conference resource is utilized once this action has succeeded.
|Parameter Name||.NET Type||Default||Description|
|Pupil||Indicates whether this connection can hear audio originating from the coach.|
|MediaTxIP||The IP address that the Tx RTP stream will transmit audio to.
This must be specified if the |
|Coach||Causes this connection to only be audible by a connection marked as the pupil.|
|Mute||The specified connection can hear others in the conference, but can not transmit back to the conference.|
|ConnectionId *||Indicates the connection to add to the existing conference as a new participant. If |
|ConferenceId *||The conference to add the connection to.|
|MediaRxCodec||The codec to use for the RTP stream inbound to the media engine. Valid values are |
|MediaRxFramesize||The framesize (in milliseconds) to use for the RTP stream inbound to the media engine.
If not specified, the |
|MediaTxPort||The port that the Tx RTP stream will transmit audio to.
This must be specified if the |
|MediaTxControlIP||The RTCP IP address of the remote endpoint.|
|MediaTxControlPort||The RTCP port of the remote endpoint.|
|MediaTxCodec||The codec to use for the RTP stream outbound from the media engine. Valid values are |
|MediaTxFramesize||The framesize (in milliseconds) to use for the RTP stream outbound from the media engine.
If not specified and if the connection has not yet had its transmit properties set with |
|CallId||The ID of the call associated with this connection (hairpin only).|
|Hairpin||Indicates that the new conference should be optimized for two parties. A hairpinned conference does not use any conference resources. However, a hairpin conference will be 'promoted', or converted to a true media conference, if a 3rd participant is added to the conference or if a voice operation is performed on the conference itself. In either case, this will cause each participant and conferenced voice operation to use one conference resource. True conferences also have a slightly increased latency over a hairpinned conference.|
|Monitor||Indicates that this participant can only listen to the conference, and does not use a conference resource. All |
|TariffTone||Indicates whether this connection should hear a periodic tone while in a true, on non-hairpinned, conference.|
|Parameter Name||.NET Type||Description|
|MediaRxControlIP||The RTCP IP address of the media engine which is in control of this connection.|
|ResultCode||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.|
|ConnectionId||The same value as the |
|MmsId||Unique identifier used to identify the media engine in control of this conference. 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.|
|MediaRxIP||The IP address that the Rx RTP stream must be sent to for this connection.|
|MediaRxPort||The port that the Rx RTP stream must be sent to for this connection.|
|MediaRxControlPort||The RTCP port of the connection.|