MediaProvider.BeginTerminateMedia Method
Begins the asynchronous operation to terminate media session for a given CallDialogContext.
Namespace: Microsoft.Rtc.Collaboration.ComponentModel
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Protected MustOverride Function BeginTerminateMedia ( _
callDialogContext As CallDialogContext, _
isTerminatingSignalingSession As Boolean, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim callDialogContext As CallDialogContext
Dim isTerminatingSignalingSession As Boolean
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = Me.BeginTerminateMedia(callDialogContext, _
isTerminatingSignalingSession, _
userCallback, state)
protected abstract IAsyncResult BeginTerminateMedia(
CallDialogContext callDialogContext,
bool isTerminatingSignalingSession,
AsyncCallback userCallback,
Object state
)
Parameters
- callDialogContext
Type: Microsoft.Rtc.Collaboration.CallDialogContext
The signaling context for the session on which media should be terminated.
- isTerminatingSignalingSession
Type: System.Boolean
A Boolean flag that indicates whether the underlying SignalingSession will be terminated after terminating the media session.
- 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.
Remarks
This method terminates the MediaSession on the call.