Guide
Comment utiliser Camera Preview dans Capacitor
Utiliser @capgo/camera-preview
L’interface principale du plugin CameraPreview.
Installer
bun add @capgo/camera-preview
bunx cap sync
bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.
Importer
import { CameraPreview } from '@capgo/camera-preview';
Aperçu de API
| Méthode | Description |
|---|---|
start |
Lance l'aperçu de la caméra. |
stop |
Arrête l'aperçu de la caméra. |
capture |
Capture une photo avec la caméra. |
captureSample |
Capture une seule image du flux de la preview caméra. |
startBarcodeScanner |
Lance le scan de codes-barres sur l'aperçu caméra actif. |
stopBarcodeScanner |
Arrête le scan de codes-barres tout en gardant l'aperçu caméra actif. |
getSupportedFlashModes |
Récupère les modes de flash supportés par la caméra active. |
setAspectRatio |
Définit le rapport d'aspect de l'aperçu caméra. |
getAspectRatio |
Récupère le rapport d'aspect actuel de l'aperçu caméra. |
setGridMode |
Définit le mode de grille de l'overlay de l'aperçu caméra. |
getGridMode |
Récupère le mode de grille actuel de l'overlay de l'aperçu caméra. |
checkPermissions |
Vérifie l’état actuel de l’autorisation caméra (et microphone le cas échéant) sans afficher la boîte de dialogue système. |
requestPermissions |
Demande les autorisations caméra (et micro optionnel). Si les autorisations sont déjà accordées ou refusées, l’état actuel est renvoyé sans afficher de prompt. Quand showSettingsAlert vaut true et que les autorisations sont refusées, une alerte propre à la plateforme guide l’utilisateur vers les réglages de l’application. |
getHorizontalFov |
Récupère le champ de vision horizontal (FoV) de la caméra active. Remarque : il peut s’agir d’une estimation sur certains appareils. |
getSupportedPictureSizes |
Récupère les tailles d'image prises en charge pour toutes les caméras. |
setFlashMode |
Définit le mode flash de la caméra active. |
flip |
Bascule entre la caméra avant et la caméra arrière. |
setOpacity |
Définit l'opacité de l'aperçu de la caméra. |
stopRecordVideo |
Arrête l'enregistrement vidéo en cours. |
startRecordVideo |
Lance l'enregistrement d'une vidéo. |
setVideoQuality |
Définit la qualité d’enregistrement vidéo de la session caméra active. |
getVideoQuality |
Récupère la qualité d’enregistrement vidéo actuelle. |
getSupportedVideoQualities |
Retourne les qualités vidéo prises en charge par la caméra active. |
setVideoCodec |
Définit le codec vidéo utilisé lors de l’enregistrement. |
getVideoCodec |
Récupère le codec vidéo actuellement utilisé pour l’enregistrement. |
getSupportedVideoCodecs |
Retourne les codecs vidéo pris en charge par la caméra active. |
isVideoStabilizationSupported |
Vérifie si la stabilisation vidéo est prise en charge par la caméra active. |
getSupportedVideoStabilizationModes |
Retourne les modes de stabilisation vidéo pris en charge par la caméra active. |
getVideoStabilizationMode |
Récupère le mode de stabilisation vidéo actuel. |
setVideoStabilizationMode |
Définit le mode de stabilisation vidéo pour l’enregistrement. Ne peut pas être modifié pendant un enregistrement en cours. Vous pouvez également passer videoStabilizationMode dans startRecordVideo() des options. |
isRunning |
Vérifie si l'aperçu de la caméra est actif. |
getAvailableDevices |
Récupère tous les appareils photo disponibles. |
getZoom |
Récupère l'état actuel du zoom, incluant le min/max et les infos sur l'objectif actuel. |
getZoomButtonValues |
Retourne les valeurs des boutons de zoom pour basculer rapidement. - iOS/Android : inclut 0,5 si l’ultra grand-angle est disponible ; 1 et 2 si le grand-angle est disponible ; 3 si le téléobjectif est disponible - Web : non pris en charge. |
setZoom |
Définit le niveau de zoom de la caméra. |
getFlashMode |
Récupère le mode flash actuel. |
setDeviceId |
Bascule la caméra active vers celle dont l'ID est spécifié deviceId. |
getDeviceId |
Récupère l’ID de l’appareil photo actuellement lié. Sur Android, si une requête de lentille physique se rabat sur une caméra logique, cette méthode retourne l’ID de la caméra logique liée. |
getPreviewSize |
Récupère la taille et la position actuelles de l'aperçu. |
setPreviewSize |
Définit la taille et la position de l'aperçu. |
setFocus |
Définit la mise au point de la caméra sur un point précis de l'aperçu. |
deleteFile |
Supprime un fichier à l’emplacement absolu indiqué sur l’appareil. Utilisez cette méthode pour nettoyer rapidement les images temporaires créées avec storeToFile. Sur le web, ce n'est pas pris en charge et lèvera une erreur. |
getSafeAreaInsets |
Récupère les insets de la safe area pour les appareils. Retourne l'inset de l'encoche/découpe caméra adapté à l'orientation, ainsi que l'orientation actuelle. En mode portrait : retourne l'inset du haut (encoche en haut). En mode paysage : retourne l'inset de gauche (encoche déplacée sur le côté). Cela cible spécifiquement la zone de découpe (encoche, punch hole, etc.) présente sur tous les téléphones modernes. |
getOrientation |
Récupère l'orientation actuelle de l'appareil dans un format multiplateforme. |
getExposureModes |
Retourne les modes d'exposition pris en charge par la caméra active. Les modes peuvent inclure : 'locked', 'auto', 'continuous', 'custom'. |
getExposureMode |
Retourne le mode d'exposition actuel. |
setExposureMode |
Définit le mode d'exposition. |
getExposureCompensationRange |
Retourne la plage de compensation d'exposition (biais EV) prise en charge. |
getExposureCompensation |
Retourne la compensation d'exposition actuelle (biais EV). |
setExposureCompensation |
Définit la compensation d'exposition (biais EV). La valeur sera bornée à la plage. |
getWhiteBalanceModes |
Retourne les modes d'équilibre des blancs pris en charge par la caméra active. Les modes peuvent inclure : 'AUTO', 'LOCK', 'CONTINUOUS'. CUSTOM is not listed until manual gains support is implemented. |
getWhiteBalanceMode |
Retourne le mode d'équilibre des blancs actuel. |
setWhiteBalanceMode |
Définit le mode d'équilibre des blancs. CONTINUOUS maintient l'équilibre des blancs automatique (recommandé ; évite une teinte chaude/jaune), LOCK fige les gains actuels, AUTO effectue un ajustement unique. CUSTOM est réservé et rejeté tant que la prise en charge des gains manuels n’est pas implémentée. |
getSupportedVideoFrameRates |
Liste les fréquences d’images vidéo prises en charge par la caméra active pour le format actuel. Les valeurs prises en charge dépendent de la caméra, de l’objectif et de la qualité vidéo sélectionnés. |
getVideoFrameRate |
Retourne la fréquence d’images vidéo configurée pour la caméra active. Sur Android, la fréquence d’enregistrement réelle peut encore varier en cas de faible luminosité ou de contrainte thermique. |
setVideoFrameRate |
Définit la fréquence d’images vidéo cible pour la session caméra active. Il est préférable de passer frameRate vers startRecordVideo() lors du démarrage d’un enregistrement. Rejette les valeurs non prises en charge avec une erreur claire. |
Exemples
start()
Lance l'aperçu de la caméra.
import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.start({ parent: 'parent' });
console.log(result);
stop()
Arrête l'aperçu de la caméra.
import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.stop();
capture()
Capture une photo avec la caméra.
import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.capture({ height: 1920 });
console.log(result);
captureSample()
Capture une seule image du flux de la preview caméra.
import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.captureSample({
quality: 85,
mirrorFrontCamera: false,
});
console.log(result);
startBarcodeScanner()
Lance le scan de codes-barres sur l'aperçu caméra actif.
import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.startBarcodeScanner();
stopBarcodeScanner()
Arrête le scan de codes-barres tout en gardant l'aperçu caméra actif.
import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.stopBarcodeScanner();
Le tableau ci-dessus liste les 56 méthodes principales. Les helpers de version et de listener, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.
Écouter les événements
addListener renvoie un handle. Appelez handle.remove() lors du démontage de l'écran, ou CameraPreview.removeAllListeners() pour supprimer tous les listeners.
Référence complète
Continuer depuis Utiliser @capgo/camera-preview
Si vous utilisez Utiliser @capgo/camera-preview pour planifier le comportement des médias et de l'interface natifs, connectez-l’à @capgo/camera-preview pour les détails d’implémentation dans @capgo/camera-preview, Prise en main pour les détails d'implémentation dans Getting Started Utiliser @capgo/capacitor-live-activities pour la capacité native dans Utiliser @capgo/capacitor-live-activities @capgo/capacitor-live-activities pour les détails d'implémentation dans @capgo/capacitor-live-activities, et Utiliser @capgo/capacitor-video-player pour la fonctionnalité native dans Utilisation de @capgo/capacitor-video-player.