Interface DisplayCapture

A live share.

interface DisplayCapture {
    Label: string;
    PanelLabel?: string;
    PanelMethod?: PanelCaptureMethod;
    Stream: MediaStream;
    Surface: CapturedDisplaySurface;
    Track: MediaStreamTrack;
    OnEnded(handler: () => void): () => void;
    Stop(): void;
}

Index

Properties

Label PanelLabel? PanelMethod? Stream Surface Track

Methods

Properties

`Readonly`Label

Label: string

The browser's label for the shared surface, such as a window or tab title.

`Optional` `Readonly`PanelLabel

PanelLabel?: string

The shared panel's name, for a panel capture that was given one (DisplayCaptureOptions.PanelLabel).

`Optional` `Readonly`PanelMethod

PanelMethod?: PanelCaptureMethod

How the stream was narrowed, for a panel capture.

`Readonly`Stream

Stream: MediaStream

`Readonly`Surface

Surface: CapturedDisplaySurface

What is being shared now. It can change if the user switches surfaces mid-share.

`Readonly`Track

Track: MediaStreamTrack

The shared video track.

Methods

OnEnded

OnEnded(handler: () => void): () => void
Calls handler once when the share ends: the user pressed the browser's "Stop sharing", the shared surface closed, or DisplayCapture.Stop was called. If the share has already ended, handler is called at once.
Parameters
- handler: () => void
Returns () => void
A function that removes the handler.
- Defined in packages/AI/RealtimeClient/src/media/displayCapture.ts:93

Stop

Stop(): void
Stops sharing. Calling it again does nothing.

Returns void
- Defined in packages/AI/RealtimeClient/src/media/displayCapture.ts:95