Member Junction
    Preparing search index...
    interface DisplayCaptureOptions {
        IncludeAudio?: boolean;
        Panel?: Element;
        PanelLabel?: string;
        PreferredSurface?: DisplayCaptureSurface;
    }
    Index

    Properties

    IncludeAudio?: boolean

    Also capture the shared surface's audio, where the browser offers it (Chromium: tab or system audio). Defaults to false: the agent already hears the microphone.

    Panel?: Element

    Share only this element of the page. Needs Element or Region Capture (see GetDisplayCaptureSupport); Element Capture is used where the browser has it. Element Capture emits frames only while the element is its own stacking context, so unless it already is one, the element's inline style gets isolation: isolate while it is shared and its own inline value back when the share ends. Meanwhile its descendants stack inside it: one with a high z-index no longer paints over content outside the panel.

    PanelLabel?: string

    The panel's name, such as "Whiteboard", carried on the capture (DisplayCapture.PanelLabel) so the UI and the agent can name what is shared. Read only with Panel.

    PreferredSurface?: DisplayCaptureSurface

    The kind of surface the picker offers first. A hint: the user can still pick another kind, and only Chromium browsers read it. Ignored for a panel capture, which asks for this tab.