useMediaQuality
Custom hook to manage video stream quality by applying constraints (resolution and frame rate) to a MediaStream track.
Installation
npx sse-tool add use-media-quality
npm install sse-hooks
Usage
import { useMediaQuality } from "./{hooks file}";
const { quality, setQuality, isChanging } = useMediaQuality(userVideoStream);
const handleHDClick = () => {
setQuality("high"); // Switches to 1280x720
};
import { useMediaQuality } from "sse-hooks";
const { quality, setQuality, isChanging } = useMediaQuality(userVideoStream);
const handleHDClick = () => {
setQuality("high"); // Switches to 1280x720
};
API
Parameters
| Name | Type | Description |
| :----- | :----------- | :---------- | ----------------------------------------------------- |
| stream | MediaStream | any | The MediaStream containing the video track to adjust. |
Return Value
Returns UseMediaQualityReturn.
The current quality state and a setter function.
Changelog
31af5 — Refactor useBattery hook and remove utility functions
c165d — feat: enhance useRoleGuard and useSSR hooks with additional options and documentation
30da4 — feat: add new hooks and their metadata
2f161 — feat: add useConferenceSystem, useKbd, useMediaQuality, useNetworkInformation, usePortal, useRoleGuard, useScreenShare, useSymbol hooks