@capgo/camera-preview

概要

@capgo/camera-preview をレンダリングします ネイティブのカメラレイヤー WebViewの背面または前面に配置し、継続的なプレビュー、静止画撮影、フラッシュ制御、アスペクト比、さらにオプションで バーコードスキャンが可能です。標準のカメラアプリに遷移させることなく、スキャン決済、ARオーバーレイ、カスタムシャッターUX、ビジョンワークフローなどを構築できます。

と連携して @capgo/capacitor-uploader JavaScriptでフルバッファをロードする代わりに、ディスクパスからキャプチャをアップロードできます。

プラットフォーム対応

プラットフォーム	備考
iOSと	マルチレンズ対応、ピンチズーム、ネイティブスキャナーによるバーコード形式
Android	CameraX プレビュー、撮影解像度を設定可能
Web	限定的なサポート。現在のWeb対応範囲はプラグインのREADMEを参照してください

コア機能

• start - カメラプレビューを開始します。
• stop - カメラプレビューを停止します。
• capture - カメラで写真を撮影します。
• captureSample - カメラプレビューのストリームから単一フレームをキャプチャします。

公開 API

メソッド	説明
start	カメラプレビューを開始します。
stop	カメラプレビューを停止します。
capture	カメラで写真を撮影します。
captureSample	カメラプレビューのストリームから1フレームをキャプチャします。
getSupportedFlashModes	使用中のカメラがサポートしているフラッシュモードを取得します。
setAspectRatio	カメラプレビューのアスペクト比を設定します。
getAspectRatio	カメラプレビューの現在のアスペクト比を取得します。
setGridMode	カメラプレビューオーバーレイのグリッドモードを設定します。
getGridMode	カメラプレビューオーバーレイの現在のグリッドモードを取得します。
checkPermissions	システムダイアログを表示せずに、現在のカメラ（および任意でマイク）の権限ステータスを確認します。
requestPermissions	カメラ（およびオプションでマイク）の権限をリクエストします。すでに権限が許可または拒否されている場合は、プロンプトを表示せずに現在のステータスを返します。値が showSettingsAlert true かつ権限が拒否されている場合は、ユーザーをアプリの設定画面へ誘導するプラットフォーム固有のアラートが表示されます。
getHorizontalFov	アクティブなカメラの水平視野角（FOV）を取得します。注意：デバイスによっては推定値となる場合があります。
getSupportedPictureSizes	すべてのカメラでサポートされている写真サイズを取得します。
setFlashMode	アクティブなカメラのフラッシュモードを設定します。
flip	インカメラとアウトカメラを切り替えます。
setOpacity	カメラプレビューの不透明度を設定します。
stopRecordVideo	進行中のビデオ録画を停止します。
startRecordVideo	ビデオ録画を開始します。
isRunning	カメラプレビューが現在実行中かどうかを確認します。
getAvailableDevices	利用可能なすべてのカメラデバイスを取得します。
getZoom	最小/最大ズーム値や現在のレンズ情報を含む、現在のズーム状態を取得します。
getZoomButtonValues	ズームボタンの値を返します。素早い切り替えに使用できます。- iOS/Android: 超広角が利用可能な場合は0.5、広角が利用可能な場合は1と2、望遠が利用可能な場合は3が含まれます。- Web: 非対応。
setZoom	カメラのズームレベルを設定します。
getFlashMode	現在のフラッシュモードを取得します。
removeAllListeners	登録されているすべてのリスナーを削除します。
setDeviceId	アクティブなカメラを指定されたものに切り替えます。 deviceId.
getDeviceId	現在バインドされているカメラデバイスのIDを取得します。Androidで物理レンズのリクエストが論理カメラにフォールバックした場合、このメソッドはバインドされている論理カメラのIDを返します。
getPreviewSize	現在のプレビューのサイズと位置を取得します。
setPreviewSize	プレビューのサイズと位置を設定します。
setFocus	プレビュー内の特定のポイントにカメラのフォーカスを設定します。
addListener	画面のリサイズイベントのリスナーを追加します。
addListener	画面の向き変更イベントのリスナーを追加します。
deleteFile	Deletes a file at the given absolute path on the device. Use this to quickly clean up temporary images created with storeToFile. Webではサポートされておらず、エラーが発生します。
getSafeAreaInsets	デバイスのセーフエリアのインセットを取得します。向きに応じたノッチやカメラのカットアウトのインセットと、現在の向きを返します。ポートレートモードでは上部のインセット（上部のノッチ）を、ランドスケープモードでは左側のインセット（サイドに移動したノッチ）を返します。これは、最新のスマートフォンに搭載されているカットアウト領域（ノッチ、パンチホールなど）を対象としています。
getOrientation	現在のデバイスの向きをクロスプラットフォーム形式で取得します。
getExposureModes	アクティブなカメラがサポートしている露出モードを返します。モードには 'locked'、'auto'、'continuous'、'custom' が含まれます。
getExposureMode	現在の露出モードを返します。
setExposureMode	露出モードを設定します。
getExposureCompensationRange	サポートされている露出補正（EVバイアス）の範囲を返します。
getExposureCompensation	現在の露出補正（EVバイアス）を返します。
setExposureCompensation	露出補正（EVバイアス）を設定します。値は指定された範囲内に制限されます。
getPluginVersion	ネイティブの Capacitor プラグインのバージョンを取得します。

リファレンス値

次の値を使用して CameraLens.deviceType または LensInfo.deviceType 物理カメラレンズを選択します。

デバイスタイプ

値	ユーザーは以下を確認できます：
ultraWide	超広角カメラレンズ。
wideAngle	標準広角カメラレンズ。
telephoto	望遠カメラレンズ。
trueDepth	TrueDepth フロントカメラ。
dual	デュアルカメラシステム。
dualWide	デュアル広角カメラシステム
triple	トリプルカメラシステム

Source of Truth

このリファレンスは以下から同期されています： src/definitions.ts における capacitor-camera-preview.

@capgo/camera-previewから続ける

使用している場合 @capgo/camera-preview ネイティブメディアとインターフェースの挙動を計画するには、次と連携させてください @capgo/camera-preview の使い方 @capgo/camera-preview を使用してネイティブ機能を利用する場合、 @capgo/capacitor-live-activities の使用 @capgo/capacitor-live-activities の使用におけるネイティブ機能については、 @capgo/capacitor-live-activities @capgo/capacitor-live-activities の実装の詳細については、 @capgo/capacitor-video-playerの使用方法 @capgo/capacitor-video-player を使用する際のネイティブ機能については、 @capgo/capacitor-video-player @capgo/capacitor-video-player. の実装の詳細については