SignalingSession.BeginRenegotiateDescription Method (AsyncCallback, Object)
Renegotiates the media description. Only one negotiation can be outstanding at any time. The session should be in the Connected state for this method to work.
Namespace: Microsoft.Rtc.Signaling
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginRenegotiateDescription ( _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As SignalingSession
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginRenegotiateDescription(userCallback, _
state)
public IAsyncResult BeginRenegotiateDescription(
AsyncCallback userCallback,
Object state
)
Parameters
- userCallback
Type: System.AsyncCallback
The method to be called when the asynchronous operation is completed.
- state
Type: System.Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.
Return Value
Type: System.IAsyncResult
An IAsyncResult that references the asynchronous operation.
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | Thrown when the session is not in a valid state to renegotiate. |
| RealTimeInvalidOperationException | Thrown when called in a temporary invalid state, and the operation can be retried. |
| RealTimeException | Thrown when there is no media description available. |
| Exception | Thrown by the application when generating media (interface IOfferAnswer) is not handled by the platform. |
Remarks
In an early dialog, BeginRenegotiateDescription is intended to send only SDP-bearing messages. As such, this method does not differentiate between a call to BeginRenegotiateDescription with a provided SDP session description and a call without an SDP session description. Both will conflict with incoming SDP-bearing UPDATE messages.