Share via


RenegotiateDescription Method

Renegotiates the media description synchronously.

Namespace:  Microsoft.Rtc.Signaling
Assembly:  Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)

Syntax

'Declaration
Public Function RenegotiateDescription As SipResponseData
'Usage
Dim instance As SignalingSession
Dim returnValue As SipResponseData

returnValue = instance.RenegotiateDescription()
public SipResponseData RenegotiateDescription()

Return Value

Type: Microsoft.Rtc.Signaling..::..SipResponseData
A SipMessageData object containing the SIP message data associated with the operation.

Exceptions

Exception Condition
ArgumentNullException

Thrown when a non-nullNothingnullptrunita null reference (Nothing in Visual Basic) is expected for an argument. The argument name for which a non-nullNothingnullptrunita null reference (Nothing in Visual Basic) is expected is part of the exception message.

RealTimeException

Thrown when the server or remote participant returns an error or encompasses SIP error or failure cases encountered while trying to enter the session - SIP Transport error, SIP Authentication, and credential-related errors.

ArgumentException

Thrown when invalid arguments are passed.

InvalidOperationException

Thrown when the session is not in a valid state to renegotiate.

Remarks

This method waits until the media description is renegotiated. It is not recommended for a UI thread.

See Also

Reference

SignalingSession Class

SignalingSession Members

RenegotiateDescription Overload

Microsoft.Rtc.Signaling Namespace