@capgo/camera-preview

Ikhtisar

@capgo/camera-preview merender sebuah layer kamera native di belakang atau di atas WebView Anda dengan preview kontinu, tangkapan gambar, kontrol flash, aspect ratio, dan opsi pemindaian barcode. Bangun fitur scan-to-pay, overlay gaya AR, UX shutter kustom, dan alur kerja vision tanpa harus mengarahkan pengguna ke aplikasi kamera bawaan.

Pasangkan dengan @capgo/capacitor-uploader untuk upload hasil tangkapan dari path disk alih-alih memuat buffer penuh di JavaScript.

Dukungan platform

Platform	Catatan
iOS	Perangkat multi-lensa, pinch zoom, format barcode via native scanner
Android	Preview CameraX, resolusi capture dapat dikonfigurasi
Web	Dukungan terbatas, cek README plugin untuk info web saat ini

Kemampuan Utama

• start - Menjalankan preview kamera.
• stop - Menghentikan preview kamera.
• capture - Mengambil foto dari kamera.
• captureSample - Mengambil satu frame dari stream preview kamera.

API Publik

Metode	Deskripsi
start	Memulai camera preview.
stop	Menghentikan camera preview.
capture	Mengambil foto dari kamera.
captureSample	Mengambil satu frame dari stream camera preview.
getSupportedFlashModes	Mendapatkan mode flash yang didukung oleh kamera aktif.
setAspectRatio	Mengatur aspect ratio camera preview.
getAspectRatio	Mendapatkan aspect ratio camera preview saat ini.
setGridMode	Mengatur mode grid pada overlay camera preview.
getGridMode	Mendapatkan mode grid overlay camera preview saat ini.
checkPermissions	Mengecek status izin kamera (dan mikrofon, opsional) saat ini tanpa memunculkan dialog sistem.
requestPermissions	Meminta izin kamera (dan mikrofon opsional). Jika izin sudah diberikan atau ditolak, status saat ini akan dikembalikan tanpa prompt. Jika showSettingsAlert jika bernilai true dan izin ditolak, alert khusus platform akan ditampilkan untuk mengarahkan pengguna ke pengaturan aplikasi.
getHorizontalFov	Mendapatkan field of view horizontal untuk kamera aktif. Catatan: Ini bisa berupa estimasi pada beberapa perangkat.
getSupportedPictureSizes	Mendapatkan ukuran foto yang didukung untuk semua kamera.
setFlashMode	Mengatur mode flash untuk kamera yang aktif.
flip	Beralih antara kamera depan dan belakang.
setOpacity	Mengatur opasitas preview kamera.
stopRecordVideo	Menghentikan rekaman video yang sedang berjalan.
startRecordVideo	Memulai rekaman video.
isRunning	Memeriksa apakah preview kamera sedang berjalan.
getAvailableDevices	Mengambil semua perangkat kamera yang tersedia.
getZoom	Mendapatkan status zoom saat ini, termasuk min/max dan info lensa saat ini.
getZoomButtonValues	Mengembalikan nilai tombol zoom untuk perpindahan cepat. - iOS/Android: menyertakan 0.5 jika ultra-wide tersedia; 1 dan 2 jika wide tersedia; 3 jika telephoto tersedia - Web: tidak didukung.
setZoom	Mengatur level zoom kamera.
getFlashMode	Mendapatkan mode flash saat ini.
removeAllListeners	Menghapus semua listener yang terdaftar.
setDeviceId	Mengalihkan kamera aktif ke kamera dengan spesifikasi tertentu deviceId.
getDeviceId	Mendapatkan ID perangkat kamera yang sedang terhubung. Di Android, jika permintaan lensa fisik beralih ke kamera logis, ini akan mengembalikan ID kamera logis yang terhubung.
getPreviewSize	Mendapatkan ukuran dan posisi preview saat ini.
setPreviewSize	Mengatur ukuran dan posisi preview.
setFocus	Mengatur fokus kamera ke titik tertentu pada preview.
addListener	Menambahkan listener untuk event resize layar.
addListener	Menambahkan listener untuk event perubahan orientasi.
deleteFile	Menghapus file pada path absolut tertentu di perangkat. Gunakan ini untuk membersihkan gambar sementara yang dibuat dengan storeToFile. Di web, fitur ini tidak didukung dan akan error.
getSafeAreaInsets	Mendapatkan safe area insets untuk perangkat. Mengembalikan inset notch/camera cutout sesuai orientasi dan orientasi saat ini. Dalam mode portrait: mengembalikan top inset (notch di atas). Dalam mode landscape: mengembalikan left inset (notch di samping). Ini khusus menargetkan area cutout (notch, punch hole, dll.) yang ada di semua ponsel modern.
getOrientation	Mendapatkan orientasi perangkat saat ini dalam format cross-platform.
getExposureModes	Mengembalikan mode exposure yang didukung oleh kamera yang aktif. Mode dapat berupa: ‘locked’, ‘auto’, ‘continuous’, ‘custom’.
getExposureMode	Mengembalikan mode exposure saat ini.
setExposureMode	Mengatur mode exposure.
getExposureCompensationRange	Mengembalikan rentang kompensasi eksposur (EV bias) yang didukung.
getExposureCompensation	Mengembalikan kompensasi eksposur (EV bias) saat ini.
setExposureCompensation	Mengatur kompensasi eksposur (EV bias). Nilai akan dibatasi sesuai rentang.
getPluginVersion	Dapatkan versi plugin native Capacitor.

Nilai Referensi

Gunakan nilai berikut dari CameraLens.deviceType atau LensInfo.deviceType untuk memilih lensa kamera fisik.

Tipe Perangkat

Nilai	Pengguna akan menemukan
ultraWide	Lensa kamera ultra-wide.
wideAngle	Lensa kamera wide-angle standar.
telephoto	Lensa kamera telephoto.
trueDepth	Kamera depan TrueDepth.
dual	Sistem kamera ganda.
dualWide	Sistem kamera dual wide.
triple	Sistem kamera triple.

Sumber Kebenaran

Referensi ini disinkronkan dari src/definitions.ts di capacitor-camera-preview.

Lanjutkan dari @capgo/camera-preview

Jika Anda menggunakan @capgo/camera-preview untuk merencanakan perilaku media dan antarmuka native, hubungkan dengan Menggunakan @capgo/camera-preview untuk kapabilitas native saat menggunakan @capgo/camera-preview, Menggunakan @capgo/capacitor-live-activities untuk kemampuan native di Menggunakan @capgo/capacitor-live-activities, @capgo/capacitor-live-activities untuk detail implementasi di @capgo/capacitor-live-activities, Menggunakan @capgo/capacitor-video-player untuk kemampuan native di Menggunakan @capgo/capacitor-video-player, dan @capgo/capacitor-video-player untuk detail implementasi di @capgo/capacitor-video-player.