BeginRenegotiateDescription Method (IEnumerable(SignalingHeader), AsyncCallback, Object)
Renegotiates the media description.
Namespace: Microsoft.Rtc.Signaling
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginRenegotiateDescription ( _
signalingHeaders As IEnumerable(Of SignalingHeader), _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As SignalingSession
Dim signalingHeaders As IEnumerable(Of SignalingHeader)
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginRenegotiateDescription(signalingHeaders, _
userCallback, state)
public IAsyncResult BeginRenegotiateDescription(
IEnumerable<SignalingHeader> signalingHeaders,
AsyncCallback userCallback,
Object state
)
Parameters
- signalingHeaders
Type: System.Collections.Generic..::..IEnumerable<(Of <(<'SignalingHeader>)>)>
Headers required for this renegotiate.
- userCallback
Type: System..::..AsyncCallback
The method to be called when the [RenegotiateDescription] operation is complete.
- 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 | Exceptions thrown by the application while generating media (interface [IMediaNegotiation]) are not handled by the platform. |
| InvalidOperationException | Thrown when called in an invalid state, a renegotiate operation is already outstanding, or a nullNothingnullptrunita null reference (Nothing in Visual Basic) media description is specified using [GetMediaOffer](). |
Remarks
Only one negotiation can be outstanding with any participant at any time. The participant should be part of the session for this method to succeed. The participant cannot be a local participant. A given topology might not allow the exchange of descriptions with certain participants.