UnbridgeCalls

Metreos.CallControl.UnbridgeCalls

Summary

UnbridgeCalls will cause the two call legs specified to form a peer-to-peer relationship, in the process renegotiating their audio streams to receive and transmit to each other, bypassing the media engine.

Usage

Two calls in a Media Control API-driven conference both stream media to and from the media engine. Each in such a scenario has its own media engine connection. This is advantageous if there is reason to perfom Media Control API operations on the calls or the conference; however, if at some point during the call media control is no longer needed, then UnbridgeCalls is a means to cause both the rcemote endpoints of both calls to renegotiate their audio streams and begin streaming to and from each other. Using this action destroys the two existing media engine connections, minimizing the licensing impact of your application.

Remarks

Using UnbridgeCalls is one way to create a peer-to-peer relationship between two calls. Another way is to use the PeerCallId action parameter of MakeCall, which is appropriate for certain scenarios. In either case, once a peer-to-peer relationship has been created between two call legs, those calls thereafter can only be in a peer-to-peer relationship with each other.

The Call Control API makes every effort to abstract the complexities of the underlying telephony protocol; however, one should consult the Call Control Feature Matrix to understand what Call Control actions and action parameters are valid for each of the four supported protocols. One can set installation and deployment guidelines based on the Call Control actions and action parameters that an application uses; the Call Control Feature Matrix makes developing such guidelines feasible.

Action Parameters
Parameter Name.NET TypeDefaultDescription
CallId *System.StringAn established call leg to become one party of the peer-to-peer call.
PeerCallIdSystem.StringAn established call leg which will be linked to CallId in a peer-to-peer fashion. You do not need to specify this value if a peer relationship has already been established between the two calls previously. Further you cannot use this field to change to a different peer if one has already been established.
TimeoutSystem.Int32The 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.

No Result Data

Branch Conditions 

Success

No description.

Failure

No description.

Timeout

No description.