CameraHandle — Kuito Documentation

Utilisation

Pause and resume a camera preview.

tsx

// Pause and resume a camera preview.
import { Button, Camera, ref, type CameraHandle } from 'kuito';

function Scanner() {
  // A plain ref holds the handle; cameraRef() adds ready and error signals.
  const camera = ref<CameraHandle>();

  return (
    <>
      <Camera ref={camera} flex={1} />
      <Button onPress={() => void camera.current?.pausePreview()}>Pause</Button>
      <Button onPress={() => void camera.current?.resumePreview()}>Resume</Button>
    </>
  );
}

Déclaration du type

export type CameraHandle = NativeViewHandle<CameraMethods>;

Membres 14

Nom	Type	Requis	Description
`id`lecture seule	`string`	Oui	—
`parent`lecture seule	`ElementHandle`	Oui	—
`children`lecture seule	`ElementHandle[]`	Oui	—
`focus`	`() => void`	Oui	—
`blur`	`() => void`	Oui	—
`setProperty`	`<K extends keyof ElementProperties>(key: K, value: ElementProperties[K] \| null) => void`	Oui	Sets a native prop on the view now, until its binding writes it again.
`addEventListener`	`(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean \| { capture?: boolean; once?: boolean; signal?: AbortSignal;}) => void`	Oui	—
`removeEventListener`	`(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean \| { capture?: boolean;}) => void`	Oui	—
`dispatchEvent`	`(event: { type: string; bubbles?: boolean; cancelable?: boolean;}) => boolean`	Oui	Sends an event through the tree, capture to bubble, as a native one travels: a `KuitoCustomEvent`, or any object with a `type`. False when a listener called `preventDefault()` on a cancelable event.
`takePicture`	`(options?: PictureOptions) => Promise<CameraPicture>`	Oui	Takes a picture with the current flash; the view must be ready.
`startRecording`	`(options?: RecordingOptions) => Promise<CameraRecording>`	Oui	Starts recording, in `video` mode. Resolves with the video once the recording ends: `stopRecording`, `maxDuration`, the app leaving the foreground, or the view unmounting.
`stopRecording`	`() => Promise<CameraRecording>`	Oui	Ends the recording, and resolves with the same video `startRecording` does.
`pausePreview`	`() => Promise<void>`	Oui	Freezes the preview and stops the camera, keeping the view.
`resumePreview`	`() => Promise<void>`	Oui	—

focus — signatures de méthode

Signatures

(): void

Paramètres

Aucun paramètre.

Retourne

void

blur — signatures de méthode

Signatures

(): void

Paramètres

Aucun paramètre.

Retourne

void

setProperty — signatures de méthode

Signatures

<K extends keyof ElementProperties>(key: K, value: ElementProperties[K] | null): void

Paramètres de type

Nom	Contrainte	Par défaut
`K`	`keyof ElementProperties`	—

Paramètres

Nom	Type	Requis	Description
`key`	`K`	Oui	—
`value`	`ElementProperties[K]`	Oui	—

Retourne

void

addEventListener — signatures de méthode

Signatures

(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean | { capture?: boolean; once?: boolean; signal?: AbortSignal; }): void

Paramètres

Nom	Type	Requis	Description
`type`	`string`	Oui	—
`fn`	`(e: KuitoNativeEvent) => void`	Oui	—
`options`	`boolean \| { capture?: boolean; once?: boolean; signal?: AbortSignal;}`	Non	—

Retourne

void

removeEventListener — signatures de méthode

Signatures

(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean | { capture?: boolean; }): void

Paramètres

Nom	Type	Requis	Description
`type`	`string`	Oui	—
`fn`	`(e: KuitoNativeEvent) => void`	Oui	—
`options`	`boolean \| { capture?: boolean;}`	Non	—

Retourne

void

dispatchEvent — signatures de méthode

Signatures

(event: { type: string; bubbles?: boolean; cancelable?: boolean; }): boolean

Paramètres

Nom	Type	Requis	Description
`event`	`{ type: string; bubbles?: boolean; cancelable?: boolean;}`	Oui	—

Retourne

boolean

takePicture — signatures de méthode

Signatures

(options?: PictureOptions): Promise<CameraPicture>

Paramètres

Nom	Type	Requis	Description
`options`	`SpecPictureOptions`	Non	—

Retourne

Promise<SpecCameraPicture>

startRecording — signatures de méthode

Signatures

(options?: RecordingOptions): Promise<CameraRecording>

Paramètres

Nom	Type	Requis	Description
`options`	`SpecRecordingOptions`	Non	—

Retourne

Promise<SpecCameraRecording>

stopRecording — signatures de méthode

Signatures

(): Promise<CameraRecording>

Paramètres

Aucun paramètre.

Retourne

Promise<SpecCameraRecording>

pausePreview — signatures de méthode

Signatures

(): Promise<void>

Paramètres

Aucun paramètre.

Retourne

Promise<void>

resumePreview — signatures de méthode

Signatures

(): Promise<void>

Paramètres

Aucun paramètre.

Retourne

Promise<void>

Généré depuis les déclarations TypeScript publiques : signatures, props et valeurs par défaut viennent de la source vérifiée, les descriptions de sa JSDoc. Aucune valeur par défaut n'est inventée.