CoreWebView2ScreenCaptureStartingEventArgs Class

Definition

Namespace:

Microsoft.Web.WebView2.Core

Assembly:

Microsoft.Web.WebView2.Core.dll

Package:

Microsoft.Web.WebView2 v1.0.2895-prerelease

public class CoreWebView2ScreenCaptureStartingEventArgs : EventArgs

type CoreWebView2ScreenCaptureStartingEventArgs = class
    inherit EventArgs

Public Class CoreWebView2ScreenCaptureStartingEventArgs
Inherits EventArgs

Inheritance

EventArgs

CoreWebView2ScreenCaptureStartingEventArgs

Properties

Cancel	The host may set this flag to cancel the screen capture. If canceled, the screen capture UI is not displayed regardless of the Handled property. On the script side, it will return with a NotAllowedError as Permission denied.
Handled	By default, both the ScreenCaptureStarting event handlers on the CoreWebView2Frame and the CoreWebView2 will be invoked, with the CoreWebView2Frame event handlers invoked first. The host may set this flag to TRUE within the CoreWebView2Frame event handlers to prevent the remaining CoreWebView2 event handlers from being invoked. If the flag is set to FALSE within the CoreWebView2Frame event handlers, downstream handlers can update the Cancel property. If a deferral is taken on the event args, then you must synchronously set Handled to TRUE prior to taking your deferral to prevent the CoreWebView2Frames event handlers from being invoked.
OriginalSourceFrameInfo	The associated frame information that requests the screen capture permission. This can be used to get the frame source, name, frameId, and parent frame information.

Methods

GetDeferral()

Gets a Deferral object. Use this deferral to defer the decision to show the Screen Capture UI. getDisplayMedia() won't call its callbacks until the deferral is completed.