AudioVideoFlow.BeginRetrieve Method (IEnumerable<SignalingHeader>, AsyncCallback, Object)
Begins to retrieve the AudioVideoFlow.
Namespace: Microsoft.Rtc.Collaboration.AudioVideo
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginRetrieve ( _
headers As IEnumerable(Of SignalingHeader), _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As AudioVideoFlow
Dim headers As IEnumerable(Of SignalingHeader)
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginRetrieve(headers, _
userCallback, state)
public IAsyncResult BeginRetrieve(
IEnumerable<SignalingHeader> headers,
AsyncCallback userCallback,
Object state
)
Parameters
- headers
Type: System.Collections.Generic.IEnumerable<SignalingHeader>
The signaling headers.
- userCallback
Type: System.AsyncCallback
The method to be called when the asynchronous operation is completed.
- state
Type: System.Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.
Return Value
Type: System.IAsyncResult
An IAsyncResult that references the asynchronous operation.
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | Thrown when the AudioVideoFlow is not in the Active state or when there is already an asynchronous operation in progress. |