14721d314f
* chore: Disable `semi` in Prettier * chore: Format w/o semi * Remove more `;` * Lint example * More ;
32 lines
1.3 KiB
TypeScript
32 lines
1.3 KiB
TypeScript
import { useMemo } from 'react'
|
|
import { CameraDevice, CameraDeviceFormat } from '../CameraDevice'
|
|
import { FormatFilter, getCameraFormat } from '../devices/getCameraFormat'
|
|
|
|
/**
|
|
* Get the best matching Camera format for the given device that satisfies your requirements using a sorting filter. By default, formats are sorted by highest to lowest resolution.
|
|
*
|
|
* The {@linkcode filters | filters} are ranked by priority, from highest to lowest.
|
|
* This means the first item you pass will have a higher priority than the second, and so on.
|
|
*
|
|
* @param device The Camera Device you're currently using
|
|
* @param filter The filter you want to use. The format that matches your filter the closest will be returned
|
|
* @returns The format that matches your filter the closest.
|
|
* @example
|
|
* ```ts
|
|
* const device = useCameraDevice(...)
|
|
* const format = useCameraFormat(device, [
|
|
* { videoResolution: { width: 3048, height: 2160 } },
|
|
* { fps: 60 }
|
|
* ])
|
|
* ```
|
|
*/
|
|
export function useCameraFormat(device: CameraDevice | undefined, filters: FormatFilter[]): CameraDeviceFormat | undefined {
|
|
const format = useMemo(() => {
|
|
if (device == null) return undefined
|
|
return getCameraFormat(device, filters)
|
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
}, [device, JSON.stringify(filters)])
|
|
|
|
return format
|
|
}
|