AudioVideoFlow.BeginRetrieve Method

Definition

Namespace:

Microsoft.Rtc.Collaboration.AudioVideo

Assembly:

Microsoft.Rtc.Collaboration.dll

Overloads

BeginRetrieve(AsyncCallback, Object)	Begins to retrieve the AudioVideoFlow.
BeginRetrieve(IEnumerable<SignalingHeader>, AsyncCallback, Object)	Begins to retrieve the AudioVideoFlow.

BeginRetrieve(AsyncCallback, Object)

Begins to retrieve the AudioVideoFlow.

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

public IAsyncResult BeginRetrieve (AsyncCallback userCallback, object state);

member this.BeginRetrieve : AsyncCallback * obj -> IAsyncResult

Public Function BeginRetrieve (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 AudioVideoFlow is not in the Active state or when there is already an asynchronous operation in progress.

Examples

The following example retrieves an AudioVideoFlow from a hold state.

C# Retrieving a call.

if (audioVideoFlow.HoldStatus != HoldType.None)
{
    audioVideoFlow.BeginRetrieve(
        new AsyncCallback(delegate(IAsyncResult result)
    {
        try
        {
            audioVideoFlow.EndRetrieve(result);
        }
        catch (RealTimeException e)
        {
            // handle exception
            throw e;
        }

        // audioVideoFlow is now retrieved.
    }),
    this);
}

BeginRetrieve(IEnumerable<SignalingHeader>, AsyncCallback, Object)

Begins to retrieve the AudioVideoFlow.

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

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

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

Public Function BeginRetrieve (headers As IEnumerable(Of SignalingHeader), userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

headers

IEnumerable<SignalingHeader>

The signaling headers.

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 AudioVideoFlow is not in the Active state or when there is already an asynchronous operation in progress.