fargo
1a822493ba
963 markdown files reformatted with the repository's pinned prettier so pnpm format:check covers the folded tree like every other repo file. The formatter's embedded-language pass also normalized code fences (TS semicolons, closed HTML tags in examples, lowercased CSS hex colors, one renumbered list that skipped an index). Alphanumeric token deltas vs the fold commit were audited file-by-file; all are formatter-equivalent markup normalizations plus the four sanitized skills.
1.6 KiB
1.6 KiB
category, related
| category | related |
|---|---|
| Sensors | useUserMedia |
useDisplayMedia
Reactive mediaDevices.getDisplayMedia streaming.
Usage
<script setup lang="ts">
import { useDisplayMedia } from '@vueuse/core';
import { useTemplateRef } from 'vue';
const { stream, start } = useDisplayMedia();
// start streaming
start();
const videoRef = useTemplateRef('video');
watchEffect(() => {
// preview on a video element
videoRef.value.srcObject = stream.value;
});
</script>
<template>
<video ref="video" />
</template>
Type Declarations
export interface UseDisplayMediaOptions extends ConfigurableNavigator {
/**
* If the stream is enabled
* @default false
*/
enabled?: MaybeRef<boolean>;
/**
* If the stream video media constraints
*/
video?: boolean | MediaTrackConstraints | undefined;
/**
* If the stream audio media constraints
*/
audio?: boolean | MediaTrackConstraints | undefined;
}
/**
* Reactive `mediaDevices.getDisplayMedia` streaming
*
* @see https://vueuse.org/useDisplayMedia
* @param options
*/
export declare function useDisplayMedia(options?: UseDisplayMediaOptions): {
isSupported: ComputedRef<boolean>;
stream: ShallowRef<MediaStream | undefined, MediaStream | undefined>;
start: () => Promise<MediaStream | undefined>;
stop: () => void;
enabled:
| Ref<boolean, boolean>
| ShallowRef<boolean, boolean>
| WritableComputedRef<boolean, boolean>
| ShallowRef<true, true>
| ShallowRef<false, false>;
};
export type UseDisplayMediaReturn = ReturnType<typeof useDisplayMedia>;