Zum Inhalt springen

Erste Schritte

GitHub

Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:

Terminalfenster
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Nutze dann diesen Prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/camera-preview` plugin in my project.

Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:

Terminalfenster
bun add @capgo/camera-preview
bunx cap sync
import { CameraPreview } from '@capgo/camera-preview';

Starte eine Vorschau der Rückkamera hinter deiner UI, mache ein Standbild und stoppe dann, um die Kamera freizugeben.

import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.start({
position: 'rear',
parent: 'cameraPreview',
toBack: true,
});
const { value } = await CameraPreview.capture({ quality: 90 });
console.log('Photo base64', value);
await CameraPreview.stop();

Binde ein Vollbild-Element mit id="cameraPreview" in dein HTML ein und stelle den Hintergrund der Route oder App transparent ein, damit die native Vorschau hinter dem WebView sichtbar ist (z. B. ion-content { --background: transparent; } bei Ionic-Routen).

await CameraPreview.start({ position: 'rear', toBack: true });
await CameraPreview.startBarcodeScanner({
formats: ['qr_code', 'code_128'],
detectionInterval: 400,
});
let handled = false;
const barcodeListener = await CameraPreview.addListener('barcodeScanned', async (event) => {
if (handled) return;
const code = event.barcodes[0]?.value;
if (!code) return;
handled = true;
await CameraPreview.stopBarcodeScanner();
await handleScan(code);
});
// When leaving the screen:
await barcodeListener.remove();
await CameraPreview.flip();
await CameraPreview.setFlashMode({ flashMode: 'torch' });
  • Berechtigungen: Kamera (und Mikrofon, falls Sie Video aufnehmen) anfordern, bevor start.
  • Lebenszyklus: aufrufen stop() wenn die Route verlassen oder der nächste Screen geöffnet wird, kann das Öffnen der Kamera fehlschlagen.
  • Web: Prüfe die unterstützten APIs im Plugin-README, bevor du dich auf die Vorschau in mobilen Browsern verlässt.

Startet die Kamera-Vorschau.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.start({ parent: 'parent' });
console.log(result);

Stoppt die Kamera-Vorschau.

import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.stop();

Macht ein Foto mit der Kamera.

Wenn storeToFile wurde auf true beim Starten der Vorschau, der zurückgegebene value ist ein absoluter Dateipfad auf dem Gerät statt einer base64-Zeichenfolge. Verwenden Sie getBase64FromFilePath, um die base64-Zeichenfolge aus dem Dateipfad zu erhalten.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.capture({ height: 1920 });
console.log(result);

Erfasst einen einzelnen Frame aus dem Kamera-Preview-Stream.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.captureSample({
quality: 85,
mirrorFrontCamera: false,
});
console.log(result);

Ruft die von der aktiven Kamera unterstützten Blitzmodi ab.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getSupportedFlashModes();
console.log(result);

Setzt das Seitenverhältnis der Kamera-Vorschau.

import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.setAspectRatio({} as { aspectRatio: '4:3' | '16:9'; x?: number; y?: number });

Ruft das aktuelle Seitenverhältnis der Kamera-Vorschau ab.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getAspectRatio();
console.log(result);

Legt den Rastermodus der Kamera-Vorschau-Überlagerung fest.

import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.setGridMode({ gridMode: 'none' });

Ruft den aktuellen Rastermodus des Kamera-Vorschau-Overlays ab.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getGridMode();
console.log(result);

Prüft den aktuellen Berechtigungsstatus für Kamera (und optional Mikrofon), ohne den Systemdialog auszulösen.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.checkPermissions();
// The result holds sensitive values: use it without logging it.

Fordert die Berechtigungen für die Kamera (und optional das Mikrofon) an. Wenn die Berechtigungen bereits erteilt oder verweigert wurden, wird der aktuelle Status zurückgegeben, ohne eine Abfrage anzuzeigen. Wenn showSettingsAlert true ist und die Berechtigungen verweigert wurden, wird eine plattformspezifische Warnung angezeigt, die den Benutzer zu den App-Einstellungen führt.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.requestPermissions();
// The result holds sensitive values: use it without logging it.

Ruft den horizontalen Sichtfeldwinkel der aktiven Kamera ab. Hinweis: Dies kann auf einigen Geräten ein Schätzwert sein.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getHorizontalFov();
console.log(result);

Gibt die unterstützten Bildgrößen für alle Kameras zurück.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getSupportedPictureSizes();
console.log(result);

Legt den Blitzmodus für die aktive Kamera fest.

import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.setFlashMode({ flashMode: 'off' });

Wechselt zwischen der Front- und Rückkamera.

import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.flip();

Legt die Deckkraft der Kamera-Vorschau fest.

import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.setOpacity({ opacity: 1.0 });

Stoppt eine laufende Videoaufnahme.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.stopRecordVideo();
console.log(result);

Startet die Videoaufnahme.

import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.startRecordVideo({ parent: 'parent' });

Prüft, ob die Kamera-Vorschau gerade läuft.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.isRunning();
console.log(result);

Gibt alle verfügbaren Kamera-Geräte zurück.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getAvailableDevices();
console.log(result);

Ruft den aktuellen Zoom-Status ab, inklusive Min/Max und Infos zur aktuellen Linse.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getZoom();
console.log(result);

Gibt Zoom-Button-Werte für das schnelle Umschalten zurück.

  • iOS/Android: enthält 0.5, wenn Ultra-Weitwinkel verfügbar ist; 1 und 2, wenn Weitwinkel verfügbar ist; 3, wenn Teleobjektiv verfügbar ist
  • Web: nicht unterstützt
import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getZoomButtonValues();
console.log(result);

Setzt die Zoomstufe der Kamera.

import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.setZoom({ level: 1 });

Ruft den aktuellen Blitzmodus ab.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getFlashMode();
console.log(result);

Wechselt die aktive Kamera zur Kamera mit der angegebenen deviceId.

import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.setDeviceId({ deviceId: 'device-id-123' });

Gibt die ID des aktuell gebundenen Kamerageräts zurück. Unter Android wird die ID der gebundenen logischen Kamera zurückgegeben, wenn eine Anfrage für eine physische Linse per Fallback auf eine logische Kamera geht.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getDeviceId();
console.log(result);

Ruft die aktuelle Vorschaugröße und -position ab.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getPreviewSize();
console.log(result);

Setzt die Vorschaugröße und -position.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.setPreviewSize({
width: 1080,
height: 1920,
});
console.log(result);

Setzt den Kamerafokus auf einen bestimmten Punkt in der Vorschau.

Hinweis: Das Plugin bindet keine nativen Tap-to-Focus-Gesten-Handler ein. Verarbeite Taps in deinem HTML/JS (z. B. in der darüberliegenden UI) und übergib hier die normalisierten Koordinaten.

import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.setFocus({
x: 1,
y: 1,
});

Löscht eine Datei am angegebenen absoluten Pfad auf dem Gerät. Nutze dies, um temporäre Bilder schnell aufzuräumen, die mit storeToFile. Im Web wird das nicht unterstützt und wirft einen Fehler.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.deleteFile({ path: 'path/to/file' });
console.log(result);

Ruft die Safe-Area-Insets für Geräte ab. Gibt das ausrichtungsabhängige Inset der Notch-/Kamera-Aussparung und die aktuelle Ausrichtung zurück. Im Hochformat: gibt das obere Inset zurück (Notch oben). Im Querformat: gibt das linke Inset zurück (Notch an der Seite). Dies zielt speziell auf den Aussparungsbereich (Notch, Punch Hole usw.) ab, den alle modernen Smartphones haben.

Android: Werte werden in dp (logische Pixel) zurückgegeben. iOS: Werte werden in physischen Pixeln zurückgegeben, ohne Statusleiste (nur reine Notch-/Aussparungsgröße).

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getSafeAreaInsets();
console.log(result);

Gibt die aktuelle Geräteorientierung in einem plattformübergreifenden Format zurück.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getOrientation();
console.log(result);

Gibt die von der aktiven Kamera unterstützten Belichtungsmodi zurück. Mögliche Modi: ‚locked‘, ‚auto‘, ‚continuous‘, ‚custom‘.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getExposureModes();
console.log(result);

Gibt den aktuellen Belichtungsmodus zurück.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getExposureMode();
console.log(result);

Legt den Belichtungsmodus fest.

import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.setExposureMode({ mode: 'AUTO' });

Gibt den unterstützten Bereich für die Belichtungskorrektur (EV-Bias) zurück.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getExposureCompensationRange();
console.log(result);

Gibt die aktuelle Belichtungskorrektur (EV-Bias) zurück.

import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.getExposureCompensation();
console.log(result);

Legt die Belichtungskorrektur (EV-Bias) fest. Der Wert wird auf den Bereich begrenzt.

import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.setExposureCompensation({ value: 1 });

Definiert die Konfigurationsoptionen zum Starten der Camera Preview.

export interface CameraPreviewOptions {
/**
* The parent element to attach the video preview to.
* @platform web
*/
parent?: string;
/**
* A CSS class name to add to the preview element.
* @platform web
*/
className?: string;
/**
* The width of the preview in pixels. Defaults to the screen width.
* @platform android, ios, web
*/
width?: number;
/**
* The height of the preview in pixels. Defaults to the screen height.
* @platform android, ios, web
*/
height?: number;
/**
* The horizontal origin of the preview, in pixels.
* @platform android, ios
*/
x?: number;
/**
* The vertical origin of the preview, in pixels.
* @platform android, ios
*/
y?: number;
/**
* The aspect ratio of the camera preview, '4:3' or '16:9' or 'fill'.
* Cannot be set if width or height is provided, otherwise the call will be rejected.
* Use setPreviewSize to adjust size after starting.
*
* @since 2.0.0
*/
aspectRatio?: '4:3' | '16:9';
/**
* Controls how the camera preview fills the available space.
* - 'contain': Fits the entire preview within the space, may show letterboxing (default).
* - 'cover': Fills the entire space, may crop edges of the preview.
* @default "contain"
* @platform android, ios, web
*/
aspectMode?: 'cover' | 'contain';
/**
* The grid overlay to display on the camera preview.
* @default "none"
* @since 2.1.0
*/
gridMode?: GridMode;
/**
* Adjusts the y-position to account for safe areas (e.g., notches).
* @platform ios
* @default false
*/
includeSafeAreaInsets?: boolean;
/**
* If true, places the preview behind the webview.
* @platform android
* @default true
*/
toBack?: boolean;
/**
* Bottom padding for the preview, in pixels.
* @platform android, ios
*/
paddingBottom?: number;
/**
* Whether to rotate the preview when the device orientation changes.
* @platform ios
* @default true
*/
rotateWhenOrientationChanged?: boolean;
/**
* The camera to use.
* @default "rear"
*/
position?: CameraPosition | string;
/**
* If true, saves the captured image to a file and returns the file path.
* If false, returns a base64 encoded string.
* @default false
*/
storeToFile?: boolean;
/**
* If true, prevents the plugin from rotating the image based on EXIF data.
* @platform android
* @default false
*/
disableExifHeaderStripping?: boolean;
/**
* If true, disables the audio stream, preventing audio permission requests.
* @default true
*/
disableAudio?: boolean;
/**
* If true, locks the device orientation while the camera is active.
* @platform android
* @default false
*/
lockAndroidOrientation?: boolean;
/**
* If true, allows the camera preview's opacity to be changed.
* @platform android, web
* @default false
*/
enableOpacity?: boolean;
/**
* If true, disables the visual focus indicator when tapping to focus.
* @platform android, ios
* @default false
*/
disableFocusIndicator?: boolean;
/**
* The `deviceId` of the camera to use. If provided, `position` is ignored.
* @platform ios
*/
deviceId?: string;
/**
* On Android, attempts to bind a physical camera directly when `deviceId` refers to a physical lens.
* Disabled by default because OEM support is inconsistent; when false, Android keeps the current logical-camera fallback behavior.
* @default false
* @platform android
*/
enablePhysicalDeviceSelection?: boolean;
/**
* The initial zoom level when starting the camera preview.
* If the requested zoom level is not available, the native plugin will reject.
* @default 1.0
* @platform android, ios
* @since 2.2.0
*/
initialZoomLevel?: number;
/**
* The vertical positioning of the camera preview.
* @default "center"
* @platform android, ios, web
* @since 2.3.0
*/
positioning?: CameraPositioning;
/**
* If true, enables video capture capabilities when the camera starts.
* @default false
* @platform android
* @since 7.11.0
*/
enableVideoMode?: boolean;
/**
* If true, forces the camera to start/restart even if it's already running or busy.
* This will kill the current camera session and start a new one, ignoring all state checks.
* @default false
* @platform android, ios, web
*/
force?: boolean;
/**
* Sets the quality of video for recording.
* Options: 'low', 'medium', 'high'
* @note On Android requires 'enableVideoMode' to be true
* @note Will affect the entire preview stream for iOS
* @platform ios, android
* @default "high"
*/
videoQuality?: 'low' | 'medium' | 'high';
}

Definiert die Optionen zum Aufnehmen eines Fotos.

export interface CameraPreviewPictureOptions {
/**
* The maximum height of the picture in pixels. The image will be resized to fit within this height while maintaining aspect ratio.
* If not specified the captured image will match the preview's visible area.
*/
height?: number;
/**
* The maximum width of the picture in pixels. The image will be resized to fit within this width while maintaining aspect ratio.
* If not specified the captured image will match the preview's visible area.
*/
width?: number;
/**
* The quality of the captured image, from 0 to 100.
* Does not apply to `.png` format.
* @default 85
*/
quality?: number;
/**
* The format of the captured image.
* @default "jpeg"
*/
format?: PictureFormat;
/**
* If true, the captured image will be saved to the user's gallery.
* @default false
* @since 7.5.0
*/
saveToGallery?: boolean;
/**
* If true, the plugin will attempt to add GPS location data to the image's EXIF metadata.
* This may prompt the user for location permissions.
* @default false
* @since 7.6.0
*/
withExifLocation?: boolean;
/**
* If true, the plugin will embed a timestamp in the top-right corner of the image.
* @default false
* @since 7.17.0
*/
embedTimestamp?: boolean;
/**
* If true, the plugin will embed the current location in the top-right corner of the image.
* Requires `withExifLocation` to be enabled.
* @default false
* @since 7.18.0
*/
embedLocation?: boolean;
/**
* Sets the priority for photo quality vs. capture speed.
* - "speed": Prioritizes faster capture times, may reduce image quality.
* - "balanced": Aims for a balance between quality and speed.
* - "quality": Prioritizes image quality, may reduce capture speed.
* See https://developer.apple.com/documentation/avfoundation/avcapturephotosettings/photoqualityprioritization for details.
*
* @since 7.21.0
* @platform ios
* @default "speed"
*/
photoQualityPrioritization?: 'speed' | 'balanced' | 'quality';
}

Stellt die aus einem Bild extrahierten EXIF-Daten dar.

export interface ExifData {
[key: string]: any;
}

Definiert die Optionen zum Erfassen eines Sample-Frames aus der Camera Preview.

export interface CameraSampleOptions {
/**
* The quality of the captured sample, from 0 to 100.
* @default 85
*/
quality?: number;
}

Die verfügbaren Blitzmodi der Kamera. 'torch' ist ein kontinuierlicher Lichtmodus.

export type CameraPreviewFlashMode = 'off' | 'on' | 'auto' | 'torch';
export type GridMode = 'none' | '3x3' | '4x4';
export interface PermissionRequestOptions {
disableAudio?: boolean;
showSettingsAlert?: boolean;
title?: string;
message?: string;
openSettingsButtonTitle?: string;
cancelButtonTitle?: string;
}
export interface CameraPermissionStatus {
camera: PermissionState;
microphone?: PermissionState;
}

Stellt die unterstützten Bildgrößen für eine Kamera in eine bestimmte Richtung dar.

export interface SupportedPictureSizes {
/** The camera direction ("front" or "rear"). */
facing: string;
/** A list of supported picture sizes for this camera. */
supportedPictureSizes: PictureSize[];
}

Definiert die Optionen zum Einstellen der Deckkraft der Kameravorschau.

export interface CameraOpacityOptions {
/**
* The opacity percentage, from 0.0 (fully transparent) to 1.0 (fully opaque).
* @default 1.0
*/
opacity?: number;
}

Stellt eine physische Kamera auf dem Gerät dar (z. B. die Frontkamera).

export interface CameraDevice {
/** A unique identifier for the camera device. */
deviceId: string;
/** A human-readable name for the camera device. */
label: string;
/** The physical position of the camera on the device. */
position: CameraPosition;
/** A list of all available lenses for this camera device. */
lenses: CameraLens[];
/** The overall minimum zoom factor available across all lenses on this device. */
minZoom: number;
/** The overall maximum zoom factor available across all lenses on this device. */
maxZoom: number;
/** Identifies whether the device is a logical camera (composed of multiple physical lenses). */
isLogical: boolean;
}

Stellt die detaillierten Informationen der aktuell aktiven Linse dar.

export interface LensInfo {
/** The focal length of the active lens in millimeters. */
focalLength: number;
/** The device type of the active lens. */
deviceType: DeviceType;
/** The base zoom ratio of the active lens (e.g., 0.5x, 1.0x). */
baseZoomRatio: number;
/** The current digital zoom factor applied on top of the base zoom. */
digitalZoom: number;
}

Diese Seite wird aus dem Plugin generiert src/definitions.ts. Führe den Sync erneut aus, wenn sich das öffentliche API upstream ändert.

Wenn du es nutzt Erste Schritte , um natives Media- und Interface-Verhalten zu planen, verbinde es mit Mit @capgo/camera-preview arbeiten für die native Funktion in Using @capgo/camera-preview, @capgo/capacitor-live-activities verwenden für die native Funktion in „@capgo/capacitor-live-activities verwenden“, @capgo/capacitor-live-activities für die Implementierungsdetails in @capgo/capacitor-live-activities, Verwendung von @capgo/capacitor-video-player für die native Funktion in „@capgo/capacitor-video-player verwenden“, und @capgo/capacitor-video-player für das Implementierungsdetail in @capgo/capacitor-video-player.