usePreviewDevice
function usePreviewDevice<T>(
deviceId,
enabled,
kind): {
selectedDevice: MediaDeviceInfo | undefined;
localTrack: T | undefined;
deviceError: Error | null;
};Defined in: packages/react/src/hooks/device/usePreviewDevice.ts:28
Caution This API is deprecated: use usePreviewTracks instead
Type Parameters
| Type Parameter | Default type |
|---|---|
T | TrackSource |
Parameters
| Parameter | Type |
|---|---|
deviceId | string |
enabled | boolean |
kind | "audioinput" | "videoinput" |
Returns
{
selectedDevice: MediaDeviceInfo | undefined;
localTrack: T | undefined;
deviceError: Error | null;
}selectedDevice
selectedDevice: MediaDeviceInfo | undefined;localTrack
localTrack: T | undefined;deviceError
deviceError: Error | null;Example
// Basic — preview one selected input device.
const { selectedDevice, localTrack, deviceError } = usePreviewDevice(deviceId, true, "videoinput");
// Advanced — show device status while a preview is enabled.
function CameraPreview({ deviceId }: { deviceId: string }) {
const { selectedDevice, localTrack, deviceError } = usePreviewDevice(deviceId, true, "videoinput");
if (deviceError) return <p>{deviceError.message}</p>;
return (
<section>
<span>{selectedDevice?.label ?? "Camera preview"}</span>
<strong>{localTrack ? "Preview ready" : "Starting preview..."}</strong>
</section>
);
}