BeginRenegotiateDescription Method (AsyncCallback, Object)
Renegotiates the media description.
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 [Renegotiate] operation has completed.
- state
Type: System..::..Object
The state to be passed back to the callback.
Return Value
Type: System..::..IAsyncResult
An [IAsyncResult] that references this operation.
Exceptions
Exception | Condition |
---|---|
Exception | Thrown by the application when generating media (interface [IMediaNegotiation]) is not handled by the platform. |
RealTimeException | Thrown when there is no media description available. |
InvalidOperationException | Thrown when the session is not in a valid state to renegotiate. |
Remarks
Only one negotiation can be outstanding at any time. The session should be in the Connected state for this method to work.