AudioVideoCall.BeginEstablish Method

Definition

Namespace:

Microsoft.Rtc.Collaboration.AudioVideo

Assembly:

Microsoft.Rtc.Collaboration.dll

Overloads

BeginEstablish(AudioVideoCallEstablishOptions, AsyncCallback, Object)	Establishes an outgoing call using audio-video call specific options.
BeginEstablish(CallOrbit, CallEstablishOptions, AsyncCallback, Object)	Initiates a call retrival request to the provisioned call park server using the given orbit information.

BeginEstablish(AudioVideoCallEstablishOptions, AsyncCallback, Object)

Establishes an outgoing call using audio-video call specific options.

public:
 IAsyncResult ^ BeginEstablish(Microsoft::Rtc::Collaboration::AudioVideo::AudioVideoCallEstablishOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginEstablish (Microsoft.Rtc.Collaboration.AudioVideo.AudioVideoCallEstablishOptions options, AsyncCallback userCallback, object state);

override this.BeginEstablish : Microsoft.Rtc.Collaboration.AudioVideo.AudioVideoCallEstablishOptions * AsyncCallback * obj -> IAsyncResult

Public Function BeginEstablish (options As AudioVideoCallEstablishOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

options

AudioVideoCallEstablishOptions

Optional parameters to establish the call.

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 call is not in valid state to perform this operation or does not have valid media provider to bind to or

Remarks

Applications can use AudioVideoMcuDialInOptions property to set MCU dial-in options if this call established with a MCU.

Setting the UseGeneratedIdentityForTrustedConference property to true is only valid in scenarios where the conversation has joined a conference as a trusted application. See ConferenceJoinOptions.

An application can establish multiple AudioVideoCall instances within the same conversation if that conversation joined the conference as a trusted application. In order to establish multiple calls, the application needs to set UseGeneratedIdentityForTrustedConference to true.

BeginEstablish(CallOrbit, CallEstablishOptions, AsyncCallback, Object)

Initiates a call retrival request to the provisioned call park server using the given orbit information.

public:
 IAsyncResult ^ BeginEstablish(Microsoft::Rtc::Collaboration::CallOrbit ^ orbit, Microsoft::Rtc::Collaboration::CallEstablishOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginEstablish (Microsoft.Rtc.Collaboration.CallOrbit orbit, Microsoft.Rtc.Collaboration.CallEstablishOptions options, AsyncCallback userCallback, object state);

override this.BeginEstablish : Microsoft.Rtc.Collaboration.CallOrbit * Microsoft.Rtc.Collaboration.CallEstablishOptions * AsyncCallback * obj -> IAsyncResult

Public Function BeginEstablish (orbit As CallOrbit, options As CallEstablishOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

orbit

CallOrbit

Orbit information to use retrieve parked call. This parameter value cannot be null.

options

CallEstablishOptions

Call establish options to be used when retrieving call from the park server. This parameter value 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

ArgumentNullException

orbit parameter is null.

ArgumentException

options parameter contains invalid or restricted signaling headers.

InvalidOperationException

Current call is not in a valid state to initiate an establish operation.