CoreWebView2Frame.ScreenCaptureStarting Event
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
ScreenCaptureStarting event is raised when the Screen Capture API is requested by the user using getDisplayMedia().
public event EventHandler<Microsoft.Web.WebView2.Core.CoreWebView2ScreenCaptureStartingEventArgs> ScreenCaptureStarting;member this.ScreenCaptureStarting : EventHandler<Microsoft.Web.WebView2.Core.CoreWebView2ScreenCaptureStartingEventArgs> Public Custom Event ScreenCaptureStarting As EventHandler(Of CoreWebView2ScreenCaptureStartingEventArgs) Event Type
Remarks
This relates to the ScreenCaptureStarting event on the CoreWebView2. Both these events will be raised in the case of an iframe requesting screen capture. The CoreWebView2Frame's event handlers will be invoked before the event handlers on the CoreWebView2. If the Handled property of the ScreenCaptureStartingEventArgs is set to TRUE within the CoreWebView2Frame event handler, then the event will not be raised on the CoreWebView2, and it's event handlers will not be invoked. In the case of nested iframes, if the ScreenCaptureStarting event is handled in the current nested iframe (i.e., the Handled property of the ScreenCaptureStartingEventArgs is set to TRUE), the event will not be raised on the parent CoreWebView2Frame. However, if the ScreenCaptureStarting event is not handled in that nested iframe, the event will be raised from its nearest tracked parent CoreWebView2Frame. It will iterate through the parent frame chain up to the main frame until a parent frame handles the request. If a deferral is not taken on the event args, the subsequent scripts are blocked until the event handler returns. If a deferral is taken, the scripts are blocked until the deferral is completed.