Aller au contenu

@capgo/camera-preview

Aperçu caméra en direct, capture, zoom et lecture de codes-barres via votre WebView.

@capgo/camera-preview affiche un couche caméra native derrière ou au-dessus de votre WebView avec aperçu continu, capture d'image, contrôle du flash, ratio d'aspect et option de lecture de codes-barres. Créez des scans pour paiement, des overlays de style RA, une UX d'obturateur personnalisée et des workflows de vision sans rediriger les utilisateurs vers l'application caméra native.

Associez avec @capgo/capacitor-uploader pour envoyer les captures depuis des chemins de disque plutôt que de charger des buffers complets en JavaScript.

PlateformeNotes
iOSAppareils multi-objectifs, pinch zoom, formats de codes-barres via le scanner natif
AndroidAperçu CameraX, résolution de capture configurable
Le WebSupport limité, voir le README du plugin pour la surface web actuelle
  • 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 d'aperçu de la caméra.
MéthodeDescription
startLance l'aperçu de la caméra.
stopArrête l'aperçu de la caméra.
captureCapture une photo avec la caméra.
captureSampleCapture une seule image du flux de la preview caméra.
getSupportedFlashModesRécupère les modes de flash supportés par la caméra active.
setAspectRatioDéfinit le rapport d'aspect de l'aperçu caméra.
getAspectRatioRécupère le rapport d'aspect actuel de l'aperçu caméra.
setGridModeDéfinit le mode de grille de l'overlay de l'aperçu caméra.
getGridModeRécupère le mode de grille actuel de l'overlay de l'aperçu caméra.
checkPermissionsVérifie l'état actuel des permissions de la caméra (et optionnellement du micro) sans afficher la boîte de dialogue système.
requestPermissionsDemande les permissions pour la caméra (et le micro, optionnel). Si les permissions sont déjà accordées ou refusées, le statut actuel est renvoyé sans afficher de prompt. Si showSettingsAlert est à true et que les permissions sont refusées, une alerte spécifique à la plateforme guidera l'utilisateur vers les paramètres de l'appareil.
getHorizontalFovRécupère le champ de vision horizontal de la caméra active. Note : cela peut être une estimation sur certains appareils.
getSupportedPictureSizesRécupère les tailles d'image prises en charge pour toutes les caméras.
setFlashModeDéfinit le mode flash de la caméra active.
flipBascule entre la caméra avant et la caméra arrière.
setOpacityDéfinit l'opacité de l'aperçu de la caméra.
stopRecordVideoArrête l'enregistrement vidéo en cours.
startRecordVideoLance l'enregistrement d'une vidéo.
isRunningVérifie si l'aperçu de la caméra est actif.
getAvailableDevicesRécupère tous les appareils photo disponibles.
getZoomRécupère l'état actuel du zoom, incluant le min/max et les infos sur l'objectif actuel.
getZoomButtonValuesRenvoie les valeurs des boutons de zoom pour un changement rapide. - 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.
setZoomDéfinit le niveau de zoom de la caméra.
getFlashModeRécupère le mode flash actuel.
removeAllListenersSupprime tous les écouteurs enregistrés.
setDeviceIdBascule la caméra active vers celle dont l'ID est spécifié deviceId.
getDeviceIdRécupère l'ID de l'appareil photo actuellement lié. Sur Android, si une requête pour un objectif physique bascule sur une caméra logique, cela renvoie l'ID de la caméra logique liée.
getPreviewSizeRécupère la taille et la position actuelles de l'aperçu.
setPreviewSizeDéfinit la taille et la position de l'aperçu.
setFocusDéfinit la mise au point de la caméra sur un point précis de l'aperçu.
addListenerAdds a listener for screen resize events.
addListenerAjoute un écouteur pour les événements de changement d'orientation.
deleteFileSupprime un fichier au chemin absolu donné sur l'appareil. Utilisez ceci pour nettoyer rapidement les images temporaires créées avec storeToFile. Sur le web, cela n'est pas supporté et générera une erreur.
getSafeAreaInsetsRécupère les insets de la safe area pour les appareils. Retourne l'inset de l'encoche/découpe caméra selon l'orientation et l'orientation actuelle. En mode portrait : retourne l'inset du haut (encoche en haut). En mode paysage : retourne l'inset de gauche (encoche sur le côté). Cela cible spécifiquement la zone de découpe (encoche, trou, etc.) présente sur tous les téléphones modernes.
getOrientationRécupère l'orientation actuelle de l'appareil dans un format multiplateforme.
getExposureModesRetourne les modes d'exposition supportés par la caméra active. Les modes peuvent inclure : ‘locked’, ‘auto’, ‘continuous’, ‘custom’.
getExposureModeRetourne le mode d'exposition actuel.
setExposureModeDéfinit le mode d'exposition.
getExposureCompensationRangeRetourne la plage de compensation d'exposition (biais EV) supportée.
getExposureCompensationRetourne la compensation d'exposition actuelle (biais EV).
setExposureCompensationDéfinit la compensation d'exposition (biais EV). La valeur sera limitée à la plage supportée.
getPluginVersionRécupère la version du plugin natif Capacitor.

Utilisez ces valeurs de CameraLens.deviceType ou LensInfo.deviceType pour choisir l'objectif de la caméra physique.

ValeurL'utilisateur trouvera
ultraWideObjectif ultra grand-angle.
wideAngleObjectif grand-angle standard.
telephotoObjectif téléobjectif.
trueDepthCaméra frontale TrueDepth.
dualSystème de double caméra.
dualWideSystème de double caméra grand-angle.
tripleSystème de triple caméra.

Cette référence est synchronisée depuis src/definitions.ts dans capacitor-camera-preview.

Si vous utilisez @capgo/camera-preview pour planifier le comportement des médias et de l'interface natifs, connectez-l’à Utiliser @capgo/camera-preview pour la capacité native dans l'utilisation de @capgo/camera-preview, Utiliser @capgo/capacitor-live-activities pour la capacité native dans Utiliser @capgo/capacitor-live-activities @capgo/capacitor-live-activities pour le détail d'implémentation dans @capgo/capacitor-live-activities Utiliser @capgo/capacitor-video-player pour la capacité native dans Utiliser @capgo/capacitor-video-player, et @capgo/capacitor-video-player pour le détail d'implémentation dans @capgo/capacitor-video-player.