Renegotiates the media description with the
specified participant. 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 may not allow the exchange of
descriptions with certain participants.
Namespace:
Microsoft.Rtc.Signaling
Assembly:
Microsoft.Rtc.Collaboration(in
Microsoft.Rtc.Collaboration.dll)
Syntax
Visual Basic (Declaration) |
Public
Function
BeginRenegotiateDescription ( _
signalingHeaders
As
IEnumerable(
Of
SignalingHeader), _
userCallback
As
AsyncCallback, _
state
As
Object _
)
As
IAsyncResult
|
C# |
public
IAsyncResult
BeginRenegotiateDescription(
IEnumerable<
SignalingHeader>
signalingHeaders,
AsyncCallback
userCallback,
Object
state
)
|
Visual C++ |
public:
IAsyncResult^
BeginRenegotiateDescription(
IEnumerable<
SignalingHeader^>^
signalingHeaders,
AsyncCallback^
userCallback,
Object^
state
)
|
JavaScript |
function
beginRenegotiateDescription(
signalingHeaders,
userCallback,
state);
|
Parameters
-
signalingHeaders
- Type:
IEnumerable
<
(Of
<
(
SignalingHeader
>
)
>
)
Headers required for this renegotiate.
-
userCallback
- Type:
AsyncCallback
The method to be called when the asynchronous operation is
completed.
-
state
- Type:
Object
A user-provided object that distinguishes this particular
asynchronous operation from other asynchronous operations.
Return Value
An IAsyncResult that
references the asynchronous operation.
Remarks
Exceptions
Exception |
Condition |
InvalidOperationException
|
Thrown when called in an invalid state, a renegotiate operation
is already outstanding, or a null media description is specified
via GetMediaOffer(). |
Microsoft.Rtc.Signaling
.
.
::
.
RealTimeInvalidOperationException
|
Thrown when called in a temporary invalid state, and the
operation can be retried. |
Exception
|
Exceptions thrown by the application while generating media
(interface IOfferAnswer) are not handled by the platform. |
See Also