SignalingSession.BeginRenegotiateDescription Method

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Definition

Namespace:

Microsoft.Rtc.Signaling

Assembly:

Microsoft.Rtc.Collaboration.dll

Overloads

BeginRenegotiateDescription(AsyncCallback, Object)	Renegotiates the media description. Only one negotiation can be outstanding at any time. The session should be in the Connected state for this method to work.
BeginRenegotiateDescription(IEnumerable<SignalingHeader>, AsyncCallback, Object)	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.
BeginRenegotiateDescription(SipDialogContext, IEnumerable<SignalingHeader>, AsyncCallback, Object)	Renegotiates the media description. Only one negotiation can be outstanding at any time. The session should be in the Connected state for this method to work.

BeginRenegotiateDescription(AsyncCallback, Object)

Renegotiates the media description. Only one negotiation can be outstanding at any time. The session should be in the Connected state for this method to work.

public:
 IAsyncResult ^ BeginRenegotiateDescription(AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginRenegotiateDescription (AsyncCallback userCallback, object state);

member this.BeginRenegotiateDescription : AsyncCallback * obj -> IAsyncResult

Public Function BeginRenegotiateDescription (userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

InvalidOperationException

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

RealTimeInvalidOperationException

Thrown when called in a temporary invalid state, and the operation can be retried.

RealTimeException

Thrown when there is no media description available.

Exception

Thrown by the application when generating media (interface IOfferAnswer) is not handled by the platform.

Remarks

In an early dialog, BeginRenegotiateDescription is intended to send only SDP-bearing messages. As such, this method does not differentiate between a call to BeginRenegotiateDescription with a provided SDP session description and a call without an SDP session description. Both will conflict with incoming SDP-bearing UPDATE messages.

BeginRenegotiateDescription(IEnumerable<SignalingHeader>, AsyncCallback, Object)

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.

public:
 IAsyncResult ^ BeginRenegotiateDescription(System::Collections::Generic::IEnumerable<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ signalingHeaders, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginRenegotiateDescription (System.Collections.Generic.IEnumerable<Microsoft.Rtc.Signaling.SignalingHeader> signalingHeaders, AsyncCallback userCallback, object state);

member this.BeginRenegotiateDescription : seq<Microsoft.Rtc.Signaling.SignalingHeader> * AsyncCallback * obj -> IAsyncResult

Public Function BeginRenegotiateDescription (signalingHeaders As IEnumerable(Of SignalingHeader), userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

signalingHeaders

IEnumerable<SignalingHeader>

Headers required for this renegotiate. Can be null.

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

InvalidOperationException

Thrown when called in an invalid state, a renegotiate operation is already outstanding, or a null media description is specified via GetMediaOffer().

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.

Remarks

In an early dialog, BeginRenegotiateDescription is intended to send only SDP-bearing messages. As such, this method does not differentiate between a call to BeginRenegotiateDescription with a provided SDP session description and a call without an SDP session description. Both will conflict with incoming SDP-bearing UPDATE messages.

BeginRenegotiateDescription(SipDialogContext, IEnumerable<SignalingHeader>, AsyncCallback, Object)

Renegotiates the media description. Only one negotiation can be outstanding at any time. The session should be in the Connected state for this method to work.

public:
 IAsyncResult ^ BeginRenegotiateDescription(Microsoft::Rtc::Signaling::SipDialogContext ^ dialogContext, System::Collections::Generic::IEnumerable<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ signalingHeaders, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginRenegotiateDescription (Microsoft.Rtc.Signaling.SipDialogContext dialogContext, System.Collections.Generic.IEnumerable<Microsoft.Rtc.Signaling.SignalingHeader> signalingHeaders, AsyncCallback userCallback, object state);

member this.BeginRenegotiateDescription : Microsoft.Rtc.Signaling.SipDialogContext * seq<Microsoft.Rtc.Signaling.SignalingHeader> * AsyncCallback * obj -> IAsyncResult

Public Function BeginRenegotiateDescription (dialogContext As SipDialogContext, signalingHeaders As IEnumerable(Of SignalingHeader), userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

dialogContext

SipDialogContext

The dialog to renegotiate on.

signalingHeaders

IEnumerable<SignalingHeader>

Headers to include in the renegotiation request. Can be null.

userCallback

AsyncCallback

The method to be called when the asynchronous operation is completed.

state

Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

InvalidOperationException

Thrown when the session is not in a valid state to renegotiate or the dialog context has been used in a previous transaction.

RealTimeInvalidOperationException

Thrown when called in a temporary invalid state, and the operation can be retried.

RealTimeException

Thrown when there is no media description available.

Exception

Thrown by the application when generating media (interface IOfferAnswer) is not handled by the platform.

Remarks

In an early dialog, BeginRenegotiateDescription is intended to send only SDP-bearing messages. As such, this method does not differentiate between a call to BeginRenegotiateDescription with a provided SDP session description and a call without an SDP session description. Both will conflict with incoming SDP-bearing UPDATE messages.