カメラプレビュー プラグインの使用方法 (@capgo/camera-preview)
カメラプレビュー プラグインの主なインターフェイス
インストール
bun add @capgo/camera-preview
bunx cap sync
bunx cap sync プラグインのネイティブcodeをプロジェクトにコピーします。プラグインのアップグレード後は再度実行してください。
インポート
import { CameraPreview } from '@capgo/camera-preview';
APIの概要
| 方法 | 説明 |
|---|---|
start |
カメラプレビューを開始します。 |
stop |
カメラプレビューを停止します。 |
capture |
カメラから写真を撮ります。 |
captureSample |
カメラプレビューのストリームから1枚のフレームを撮ります。 |
startBarcodeScanner |
アクティブなカメラプレビューでバーコードスキャンを開始します。 |
stopBarcodeScanner |
バーコードスキャンを停止しながらカメラプレビューを続行します。 |
getSupportedFlashModes |
アクティブなカメラでサポートされているフラッシュモードを取得します。 |
setAspectRatio |
カメラプレビューのアスペクト比を設定します。 |
getAspectRatio |
カメラプレビューの現在のアスペクト比を取得します。 |
setGridMode |
カメラプレビューのオーバーレイのグリッドモードを設定します。 |
getGridMode |
カメラプレビューのオーバーレイの現在のグリッドモードを取得します。 |
checkPermissions |
システムダイアログを提示せずにカメラ（およびオプションでマイク）許可状態を確認します。 |
requestPermissions |
カメラ (およびオプションのマイク) の許可を要求します。許可が既に付与されたり拒否された場合は、現在の状態が提示されます。 showSettingsAlert true の場合、許可が拒否されている場合、プラットフォーム固有の警告が提示されます。ユーザーはアプリの設定に誘導されます。 |
getHorizontalFov |
アクティブなカメラの水平視野角 (FoV) を取得します。注: 一部のデバイスでは、推定値が返されます。 |
getSupportedPictureSizes |
すべてのカメラでサポートされている画像サイズを取得します。 |
setFlashMode |
アクティブなカメラのフラッシュモードを設定します。 |
flip |
前面カメラと後面カメラを切り替えます。 |
setOpacity |
カメラプレビューの不透明度を設定します。 |
stopRecordVideo |
進行中の動画撮影を停止します。 |
startRecordVideo |
動画撮影を開始します。 |
setVideoQuality |
アクティブなカメラセッションの動画撮影品質を設定します。 |
getVideoQuality |
現在の動画撮影品質を取得します。 |
getSupportedVideoQualities |
アクティブなカメラでサポートされている動画品質を取得します。 |
setVideoCodec |
動画エンコード方式を設定します。 |
getVideoCodec |
現在の動画エンコード方式を取得します。 |
getSupportedVideoCodecs |
現在のカメラがサポートする動画エンコード方式を取得します。 |
isVideoStabilizationSupported |
現在のカメラが動画の安定化をサポートしているかどうかを確認します。 |
getSupportedVideoStabilizationModes |
現在のカメラがサポートする動画の安定化モードを取得します。 |
getVideoStabilizationMode |
現在の動画の安定化モードを取得します。 |
setVideoStabilizationMode |
動画の安定化モードを設定します。レコーディング中は変更できません。レコーディング中でもオプションを渡すことができます。 videoStabilizationMode オプション。 startRecordVideo() options. |
isRunning |
利用可能なすべてのカメラデバイスを取得します。 |
getAvailableDevices |
現在のズーム状態、最小値/最大値、現在のレンズ情報を取得します。 |
getZoom |
__CAPGO_KEEP_0__ |
getZoomButtonValues |
iOS/Android: 超広角が利用可能な場合は 0.5 を含み、広角が利用可能な場合は 1 と 2 を含み、望遠レンズが利用可能な場合は 3 を含みます - Web: 不対応。 |
setZoom |
カメラのズームレベルを設定します。 |
getFlashMode |
現在のフラッシュモードを取得します。 |
setDeviceId |
指定されたカメラに切り替えます。 deviceId. |
getDeviceId |
現在のカメラデバイスのIDを取得します。Androidの場合、物理レンズの要求が論理カメラにフォールバックした場合、このIDは論理カメラのIDを返します。 |
getPreviewSize |
現在のプレビューのサイズと位置を取得します。 |
setPreviewSize |
プレビューのサイズと位置を設定します。 |
setFocus |
プレビュー内の特定のポイントにカメラの焦点を設定します。 |
deleteFile |
指定された絶対パスにあるファイルを削除します。 これを使用して、 によって作成された一時的な画像を迅速にクリーンアップできます。 Web ではサポートされていませんが、例外を投げます。 storeToFileウェブ上ではサポートされず、エラーを投げます。 |
getSafeAreaInsets |
現在のデバイスのオリエンテーションを取得します。 |
getOrientation |
__CAPGO_KEEP_0__ |
getExposureModes |
現在のカメラで使用できる露光モードを返します。モードには、'locked'、'auto'、'continuous'、'custom' が含まれます。 |
getExposureMode |
現在の露光モードを返します。 |
setExposureMode |
露光モードを設定します。 |
getExposureCompensationRange |
現在のカメラで使用できる露光補正範囲を返します。 |
getExposureCompensation |
現在の露光補正値を返します。 |
setExposureCompensation |
露光補正値を設定します。値は範囲内に丸められます。 |
getWhiteBalanceModes |
現在のカメラで使用できる白バランスモードを返します。モードには、'AUTO'、'LOCK'、'CONTINUOUS' が含まれます。 CUSTOM 手動ゲインのサポートが実装されるまでリストされません。 |
getWhiteBalanceMode |
現在の白バランスモードを返します。 |
setWhiteBalanceMode |
白バランスモードを設定します。 CONTINUOUS 自動白バランスを実行し続ける (推奨; 黄色い色味を避ける)、 LOCK 現在のゲインを固定します AUTO 1回の調整を行う。 CUSTOM サポートが実装されるまで、手動で設定する必要があります。 |
getSupportedVideoFrameRates |
現在のフォーマットで使用しているアクティブ カメラがサポートする動画フレームレートの一覧を表示します。サポートされる値は、選択したカメラ、レンズ、動画の品質によって異なります。 |
getVideoFrameRate |
アクティブ カメラの設定された動画フレームレートを返します。Android の場合、実際のレコーディング フレームレートは、低光環境や熱圧力下では変化する可能性があります。 |
setVideoFrameRate |
アクティブ カメラ セッションのターゲット動画フレームレートを設定します。まず、 frameRate to startRecordVideo() 開始時にレコーディングを開始するときに使用します。サポートされていない値は、明確なエラーで拒否されます。 |
例
start()
カメラ プレビューを開始します。
import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.start({ parent: 'parent' });
console.log(result);
stop()
カメラ プレビューを停止します。
import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.stop();
capture()
カメラから写真を撮ります。
import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.capture({ height: 1920 });
console.log(result);
captureSample()
カメラ プレビュー ストリームから1枚のフレームを撮ります。
import { CameraPreview } from '@capgo/camera-preview';
const result = await CameraPreview.captureSample({
quality: 85,
mirrorFrontCamera: false,
});
console.log(result);
startBarcodeScanner()
カメラプレビューでバーコードスキャンを開始します。
import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.startBarcodeScanner();
stopBarcodeScanner()
バーコードスキャンを停止しますが、カメラプレビューは続行されます。
import { CameraPreview } from '@capgo/camera-preview';
await CameraPreview.stopBarcodeScanner();
上の表には、56のコアメソッドがリストされています。リスナーとバージョンヘルパー、各メソッドのフルコントラクトは、以下の__CAPGO_KEEP_0__リポジトリにドキュメントされています。 GitHub リポジトリ.
イベントをリスンする
addListener ハンドルを返します。画面をアンマウントしたり、すべてのリスナーをクリアしたりするには handle.remove() ハンドルを呼び出してください。 CameraPreview.removeAllListeners() フルリファレンス
ドキュメント
Keep going from Using @capgo/camera-preview
Capacitorカメラプレビューを使用している場合 Using @capgo/camera-preview ネイティブメディアとインターフェイスの動作を計画するには、Capacitorカメラプレビューを接続してください @capgo/camera-preview カメラプレビューの実装詳細については、@capgo/camera-previewを参照してください。 Capacitorカメラプレビューの実装詳細については、Getting Startedを参照してください Capacitorカメラプレビューの実装詳細については、Getting Startedを参照してください @capgo/capacitor-ライブ活動 native機能のために使用する@capgo/capacitor-live-activities @capgo/capacitor-ライブアクティビティ @capgo/capacitorライブ活動の実装詳細について @capgo/capacitor-ビデオプレーヤー Capacitorカメラプレビューのnative機能のために@capgo/capacitor-ビデオプレーヤーを使用します。