R
fn

useDisplayMedia

v0.0.15testeddemo

Reactive `mediaDevices.getDisplayMedia` (screen share) streaming.

Examples

ts
const { stream, enabled, isSupported } = useDisplayMedia();
videoEl.srcObject = stream.value ?? null;
enabled.value = true; // prompts the screen-share picker
ts
const { start, stop } = useDisplayMedia({ audio: true });
await start();

Demo

Loading demo…

Signature

ts
export function useDisplayMedia(options: UseDisplayMediaOptions ={ ... }

Parameters

ParameterTypeDescription
options?UseDisplayMediaOptionsOptions

Returns

UseDisplayMediaReturn`stream`, `start`, `stop`, `enabled` and `isSupported`