Edit

SignalingSession.RenegotiateDescription Method

  • Reference

Definition

Namespace:
Microsoft.Rtc.Signaling
Assembly:
Microsoft.Rtc.Collaboration.dll

Overloads

RenegotiateDescription()

Synchronously renegotiates the media description. This method will wait until the media description is renegotiated. It is not recommended for a UI thread.
RenegotiateDescription(IEnumerable<SignalingHeader>)

Synchronously renegotiates the media description. This method will wait until the media description is renegotiated. It is not recommended for a UI thread.

RenegotiateDescription()

Synchronously renegotiates the media description. This method will wait until the media description is renegotiated. It is not recommended for a UI thread.

public:
 Microsoft::Rtc::Signaling::SipResponseData ^ RenegotiateDescription();
public Microsoft.Rtc.Signaling.SipResponseData RenegotiateDescription ();
member this.RenegotiateDescription : unit -> Microsoft.Rtc.Signaling.SipResponseData
Public Function RenegotiateDescription () As SipResponseData

Returns

SipResponseData

Returns the SIP response data associated with the operation.

Exceptions

InvalidOperationException

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

ArgumentException

Thrown when invalid arguments are passed.

ArgumentNullException

Thrown when null is supplied for a required argument. The argument name which is required is is part of the exception message.

RealTimeException

Thrown when the server or remote participant returns an error.

Applies to

RenegotiateDescription(IEnumerable<SignalingHeader>)

Synchronously renegotiates the media description. This method will wait until the media description is renegotiated. It is not recommended for a UI thread.

public:
 Microsoft::Rtc::Signaling::SipResponseData ^ RenegotiateDescription(System::Collections::Generic::IEnumerable<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ signalingHeaders);
public Microsoft.Rtc.Signaling.SipResponseData RenegotiateDescription (System.Collections.Generic.IEnumerable<Microsoft.Rtc.Signaling.SignalingHeader> signalingHeaders);
member this.RenegotiateDescription : seq<Microsoft.Rtc.Signaling.SignalingHeader> -> Microsoft.Rtc.Signaling.SipResponseData
Public Function RenegotiateDescription (signalingHeaders As IEnumerable(Of SignalingHeader)) As SipResponseData

Parameters

signalingHeaders
IEnumerable<SignalingHeader>

Headers required for this renegotiate. Can be null.

Returns

SipResponseData

Returns the SIP response data associated with the operation.

Exceptions

InvalidOperationException

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

RealTimeException

Thrown when there is no media description available.

Exception

Exceptions thrown by the application while generating media (interface IOfferAnswer) are not handled by the platform.

Applies to