Guide
How to use Camera Preview in Capacitor
En utilisant @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. Exécutez-l’à nouveau après chaque mise à jour du plugin.
Importer
import { CameraPreview } from '@capgo/camera-preview';
API en un coup d'œil
| Méthode | Description |
|---|---|
start |
Démarrer la prévisualisation de la caméra. |
stop |
Arrêtez la prévisualisation de la caméra. |
capture |
Capturer une photo à partir de la caméra. |
captureSample |
Capturera une seule image de la flux de prévisualisation de la caméra. |
startBarcodeScanner |
Démarre la lecture de codes-barres sur la preview de la caméra active. |
stopBarcodeScanner |
Arrêtez la reconnaissance de code-barres tout en continuant à prévisualiser la caméra. |
getSupportedFlashModes |
Récupérez les modes de la lumière flash supportés par la caméra active. |
setAspectRatio |
Set the aspect ratio of the camera preview. |
getAspectRatio |
Obtenez le rapport d'aspect actuel de la prévisualisation de la caméra. |
setGridMode |
Configure la grille du mode de la vue d'aperçu de la caméra. |
getGridMode |
Obtenez le mode grille actuel de l'overlay de la prévisualisation de la caméra. |
checkPermissions |
Vérifiez l'état actuel des autorisations de la caméra (et facultativement du microphone) sans afficher le dialogue système. |
requestPermissions |
Demande les permissions de la caméra (et microphone optionnel). Si les permissions sont déjà accordées ou refusées, le statut actuel est retourné sans solliciter. showSettingsAlert Lorsque la condition est vraie et que les permissions sont refusées, un avertissement spécifique à la plateforme guidera l'utilisateur vers les paramètres de l'application. |
getHorizontalFov |
Obtenez le champ de vision horizontal (FoV) pour la caméra active. Remarque : Cela peut être une estimation sur certains appareils. |
getSupportedPictureSizes |
Obtenez les tailles de photo prises en charge pour toutes les caméras. |
setFlashMode |
Configure la mode de flash pour la caméra active. |
flip |
Basculer entre la caméra avant et la caméra arrière. |
setOpacity |
Configurez l'opacité de la prévisualisation de la caméra. |
stopRecordVideo |
Arrête une enregistrement vidéo en cours. |
startRecordVideo |
Démarre une enregistrement vidéo. |
setVideoQuality |
Configure la qualité de l'enregistrement vidéo pour la session de la caméra active. |
getVideoQuality |
Obtient la qualité vidéo actuelle de l'enregistrement. |
getSupportedVideoQualities |
Retourne les qualités vidéo prises en charge par la caméra active. |
setVideoCodec |
Configure le codec vidéo utilisé lors de l'enregistrement. |
getVideoCodec |
Obtient le codec vidéo actuel utilisé pour l'enregistrement. |
getSupportedVideoCodecs |
Retourne les codecs vidéo prises 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 prises en charge par la caméra active. |
getVideoStabilizationMode |
Obtient le mode de stabilisation vidéo actuel. |
setVideoStabilizationMode |
Configure le mode de stabilisation vidéo pour l'enregistrement. Ce paramètre ne peut pas être modifié pendant une enregistrement en cours. Vous pouvez également passer videoStabilizationMode en cours startRecordVideo() paramètres. |
isRunning |
Vérifie si la prise en charge de la caméra est en cours. |
getAvailableDevices |
Récupère tous les appareils de caméra disponibles. |
getZoom |
Gets the current zoom state, including min/max and current lens info. |
getZoomButtonValues |
Retourne les valeurs du bouton de zoom pour un changement rapide. - iOS/Android : inclut 0,5 si l'ultra-large est disponible ; 1 et 2 si large est disponible ; 3 si télescopique est disponible - Web : non pris en charge. |
setZoom |
Définit le niveau de zoom de la caméra. |
getFlashMode |
Récupère le mode de clignotement actuel. |
setDeviceId |
Change la caméra active en celle avec l'ID spécifié. deviceId. |
getDeviceId |
Récupère l'ID de l'appareil de caméra qui est actuellement lié. Sur Android, si une demande de lentille physique retombe sur une caméra logique, cela retourne l'ID de la caméra logique liée. |
getPreviewSize |
Gets the current preview size and position. |
setPreviewSize |
Sets the preview size and position. |
setFocus |
Fixe l'objectif de la caméra sur un point spécifique dans la prévisualisation. |
deleteFile |
Supprime un fichier à l'emplacement absolu donné sur le dispositif. Utilisez cela pour nettoyer rapidement les images temporaires créées avec storeToFile. Sur web, cela n'est pas pris en charge et lancera une erreur. |
getSafeAreaInsets |
Récupère les insets de zone de sécurité pour les appareils. Retourne les insets de la notch/camera coupure d'orientation et l'orientation actuelle. En mode paysage : retourne l'inset de gauche (notch déplacé du côté). En mode portrait : retourne l'inset de haut (notch en haut). Cela cible spécifiquement l'aire de coupure (notch, trou de poinçon, etc.) que tous les téléphones modernes ont. |
getOrientation |
Récupère l'orientation actuelle de l'appareil sous une forme cross-plateforme. |
getExposureModes |
Les modes d'exposition pris en charge par la caméra active. Les modes peuvent inclure : 'fixe', 'automatique', 'continu', 'personnalisé'. |
getExposureMode |
Retourne le mode d'exposition actuel. |
setExposureMode |
Fixe le mode d'exposition. |
getExposureCompensationRange |
Retourne la plage des valeurs de compensation d'exposition (EV). |
getExposureCompensation |
Retourne la compensation d'exposition actuelle (EV). |
setExposureCompensation |
Fixe la compensation d'exposition (EV). La valeur sera limitée à la plage. |
getWhiteBalanceModes |
Retourne les modes de balance blanche pris en charge par la caméra active. Les modes peuvent inclure : « AUTO », « LOCK », « CONTINU ». CUSTOM n'est pas listé jusqu'à ce que le support des gains manuels soit mis en œuvre. |
getWhiteBalanceMode |
Renvoie le mode de balance blanc actuel. |
setWhiteBalanceMode |
Fixe le mode de balance blanc. CONTINUOUS maintient la balance blanc automatique en cours (recommandé ; évite une teinte chaude/jaune), LOCK gèle les gains actuels, AUTO effectue une ajustement unique. CUSTOM est réservé et rejeté jusqu'à ce que le support manuel soit mis en place. |
getSupportedVideoFrameRates |
Affiche les taux de cadence vidéo pris en charge par la caméra active pour le format actuel. Les valeurs prises en charge dépendent de la sélection de la caméra, du objectif et de la qualité vidéo. |
getVideoFrameRate |
Renvoie le taux de cadence vidéo configuré pour la caméra active. Sur Android, le taux de cadence de l'enregistrement peut toujours varier en faible lumière ou sous pression thermique. |
setVideoFrameRate |
Fixe le taux de cadence vidéo cible pour la session de la caméra active. Préférez passer frameRate à startRecordVideo() when starting a recording. Rejects unsupported values with a clear error. |
Exemples
start()
Démarre la preview de la caméra.
import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.start({ parent: 'parent' });
console.log(result);
stop()
Arrête la preview de la caméra.
import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.stop();
capture()
Capturer une photo à partir de la caméra.
import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.capture({ height: 1920 });
console.log(result);
captureSample()
Capturera une seule image de la flux de prévisualisation de la caméra.
import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.captureSample({
quality: 85,
mirrorFrontCamera: false,
});
console.log(result);
startBarcodeScanner()
Démarre le scan de code-barres sur la preview active de la caméra.
import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.startBarcodeScanner();
stopBarcodeScanner()
Arrête le scan de code-barres tout en continuant la preview de la caméra.
import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.stopBarcodeScanner();
Le tableau ci-dessus liste les 56 méthodes de base. Les aides aux écouteurs et aux versions, ainsi que le contrat complet de chaque méthode, sont documentés dans le repository GitHub.
Écoutez les événements
addListener renvoie un gestionnaire. Appelez handle.remove() lorsque l'écran est démonté, ou CameraPreview.removeAllListeners() Pour supprimer tous les écouteurs.
Référence complète
Continuez à partir de l'utilisation de @capgo/camera-preview
Si vous utilisez L'utilisation de @capgo/camera-preview Pour planifier le comportement des médias et de l'interface natives, connectez-l’avec @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, En utilisant @capgo/capacitor-activités-en-ligne pour la capacité native dans En utilisant @capgo/capacitor-activités-en-ligne En utilisant @capgo/capacitor-activités-en-ligne pour les détails d'implémentation dans @capgo/capacitor-activités-en-ligne, et En utilisant @capgo/capacitor-joueur-de-videos pour la capacité native dans En utilisant @capgo/capacitor-joueur-de-videos.