コンテンツにスキップ
Capgo - Capacitor アプリのリアルタイム更新 Capgo

Getting Started

GitHub

インストール

「インストール」のセクション

AI-Assisted セットアップを使用してプラグインをインストールできます。AI ツールに Capgo スキルを追加するには、以下のコマンドを実行してください。

ターミナル画面
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用してください:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/camera-preview` plugin in my project.

Manual Setup を好む場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください:

ターミナルウィンドウ
bun add @capgo/camera-preview
bunx cap sync

インポート

「インポート」のセクション
import { CameraPreview } from '@capgo/camera-preview';

API の概要

「API の概要」のセクション

start

「start」のセクション

カメラのプレビューを開始します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.start({} as CameraPreviewOptions);

stop

停止

カメラのプレビューを停止します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.stop();

capture

キャプチャ

カメラから写真をキャプチャします。

if storeToFile was set to true when starting the preview, the returned value will be an absolute file path on the device instead of a base64 string. Use getBase64FromFilePath to get the base64 string from the file path.

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.capture({} as CameraPreviewPictureOptions);

captureSample

「captureSample」セクション

カメラプレビュー ストリームから 1 つのフレームをキャプチャします。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.captureSample({} as CameraSampleOptions);

getSupportedFlashModes

「getSupportedFlashModes」セクション

アクティブ カメラでサポートされるフラッシュ モードを取得します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getSupportedFlashModes();

setAspectRatio

「setAspectRatio」セクション

カメラ プレビューのアスペクト レシオを設定します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.setAspectRatio({} as { aspectRatio: '4:3' | '16:9'; x?: number; y?: number });

getAspectRatio

「getAspectRatio」セクション

カメラ プレビューの現在のアスペクト レシオを取得します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getAspectRatio();

setGridMode

セクション「gridモードを設定」

カメラプレビュー上のオーバーレイのグリッドモードを設定します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.setGridMode({} as { gridMode: GridMode });

getGridMode

セクション「現在のグリッドモードを取得」

カメラプレビュー上のオーバーレイの現在のグリッドモードを取得します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getGridMode();

checkPermissions

セクション「許可の確認」

システムダイアログを提示せずにカメラ（オプションでマイク）許可の現在の状態を確認します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.checkPermissions();

requestPermissions

セクション「許可の要求」

カメラ（オプションでマイク）許可を要求します。許可が既に付与されている場合も、拒否されている場合も、現在の状態を返します。許可が拒否されている場合、trueがtrueの場合、プラットフォーム固有のアラートを提示してユーザーをアプリ設定に案内します。 showSettingsAlert クリップボードにコピー

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.requestPermissions();

getHorizontalFov

__CAPGO_KEEP_1__

__CAPGO_KEEP_2__

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getHorizontalFov();

getSupportedPictureSizes

__CAPGO_KEEP_3__

__CAPGO_KEEP_4__

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getSupportedPictureSizes();

setFlashMode

__CAPGO_KEEP_5__

__CAPGO_KEEP_6__

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.setFlashMode({} as { flashMode: CameraPreviewFlashMode | string });

flip

__CAPGO_KEEP_7__

__CAPGO_KEEP_8__

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.flip();

setOpacity

__CAPGO_KEEP_1__

__CAPGO_KEEP_2__

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.setOpacity({} as CameraOpacityOptions);

stopRecordVideo

__CAPGO_KEEP_3__

__CAPGO_KEEP_4__

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.stopRecordVideo();

startRecordVideo

__CAPGO_KEEP_5__

__CAPGO_KEEP_0__

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.startRecordVideo({} as CameraPreviewOptions);

isRunning

__CAPGO_KEEP_0__

__CAPGO_KEEP_7__

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.isRunning();

getAvailableDevices

__CAPGO_KEEP_1__

__CAPGO_KEEP_2__

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getAvailableDevices();

getZoom

__CAPGO_KEEP_1__

__CAPGO_KEEP_3__

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getZoom();

getZoomButtonValues

__CAPGO_KEEP_1__

__CAPGO_KEEP_4__

  • iOS/Android: ultra-wide 0.5、wide 1、2、telephoto 3、Web: なし
  • __CAPGO_KEEP_0__
import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getZoomButtonValues();

setZoom

「setZoom」セクション

カメラのズームレベルを設定します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.setZoom({} as { level: number; ramp?: boolean; autoFocus?: boolean });

getFlashMode

「getFlashMode」セクション

現在のフラッシュモードを取得します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getFlashMode();

setDeviceId

「setDeviceId」セクション

指定されたカメラに切り替えます。 deviceId.

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.setDeviceId({} as { deviceId: string });

getDeviceId

「getDeviceId」セクション

現在バインドされているカメラデバイスのIDを取得します。 Androidの場合、物理レンズのリクエストが論理カメラにフォールバックした場合、このIDは論理カメラのIDを返します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getDeviceId();

getPreviewSize

「getPreviewSize」セクション

現在のプレビュー サイズと位置を取得します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getPreviewSize();

setPreviewSize

「setPreviewSize」セクション

プレビュー サイズと位置を設定します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.setPreviewSize({} as { x?: number; y?: number; width: number; height: number });

setFocus

「setFocus」セクション

プレビュー内で特定のポイントにカメラの焦点を設定します。

注意: プラグインは、タップで焦点を合わせるネイティブのジェスチャー ハンドラーを追加しません。HTML/JS (例: オーバーレイ UI) でタップを処理し、ここに正規化された座標を渡してください。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.setFocus({} as { x: number; y: number });

deleteFile

「deleteFile」セクション

デバイス上の絶対パスで指定されたファイルを削除します。 画像を生成するのに使用する場合など、迅速に一時ファイルを削除するにはこちらを使用してください。 storeToFileOn web, この機能はサポートされていません。エラーが発生します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.deleteFile({} as { path: string });

getSafeAreaInsets

セクション：getSafeAreaInsets

デバイスの安全なエリアのインセットを取得します。 オリエンテーションに応じたノッチ/カメラカットアウトのインセットと現在のオリエンテーションを返します。 ポートレートモード：上部のインセット（上部のノッチ）を返します。 ランドスケープモード：左側のインセット（ノッチが側面に移動）を返します。 この機能は、すべてのモダンな電話が持つカットアウトエリア（ノッチ、パンチホールなど）を特定的にターゲットします。

Android：dp（論理ピクセル）で値が返されます。 iOS：物理ピクセルで値が返され、ステータスバーを除き、ノッチ/カットアウトの純粋なサイズのみを含みます。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getSafeAreaInsets();

getOrientation

セクション：getOrientation

現在のデバイスのオリエンテーションをクロスプラットフォーム形式で取得します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getOrientation();

getExposureModes

セクション：getExposureModes

現在のアクティブカメラでサポートされている露光モードを返します。 モードには、‘locked’、‘auto’、‘continuous’、‘custom’などが含まれます。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getExposureModes();

getExposureMode

getExposureMode

現在の露光モードを取得します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getExposureMode();

setExposureMode

setExposureMode

露光モードを設定します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.setExposureMode({} as { mode: ExposureMode });

getExposureCompensationRange

getExposureCompensationRange

露光補正のサポート範囲を取得します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getExposureCompensationRange();

getExposureCompensation

getExposureCompensation

現在の露光補正を取得します。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.getExposureCompensation();

setExposureCompensation

露光補償を設定

露光補償値 (EV バイアス) を設定します。値は範囲内に丸められます。

import { CameraPreview } from '@capgo/camera-preview';


await CameraPreview.setExposureCompensation({} as { value: number });

タイプ リファレンス

タイプ リファレンス

CameraPreviewOptions

カメラ プレビュー オプション

カメラ プレビューを開始するための設定オプションを定義します。

export interface CameraPreviewOptions {
  /**
   * The parent element to attach the video preview to.
   * @platform web
   */
  parent?: string;
  /**
   * A CSS class name to add to the preview element.
   * @platform web
   */
  className?: string;
  /**
   * The width of the preview in pixels. Defaults to the screen width.
   * @platform android, ios, web
   */
  width?: number;
  /**
   * The height of the preview in pixels. Defaults to the screen height.
   * @platform android, ios, web
   */
  height?: number;
  /**
   * The horizontal origin of the preview, in pixels.
   * @platform android, ios
   */
  x?: number;
  /**
   * The vertical origin of the preview, in pixels.
   * @platform android, ios
   */
  y?: number;
  /**
   * The aspect ratio of the camera preview, '4:3' or '16:9' or 'fill'.
   * Cannot be set if width or height is provided, otherwise the call will be rejected.
   * Use setPreviewSize to adjust size after starting.
   *
   * @since 2.0.0
   */
  aspectRatio?: '4:3' | '16:9';
  /**
   * Controls how the camera preview fills the available space.
   * - 'contain': Fits the entire preview within the space, may show letterboxing (default).
   * - 'cover': Fills the entire space, may crop edges of the preview.
   * @default "contain"
   * @platform android, ios, web
   */
  aspectMode?: 'cover' | 'contain';
  /**
   * The grid overlay to display on the camera preview.
   * @default "none"
   * @since 2.1.0
   */
  gridMode?: GridMode;
  /**
   * Adjusts the y-position to account for safe areas (e.g., notches).
   * @platform ios
   * @default false
   */
  includeSafeAreaInsets?: boolean;
  /**
   * If true, places the preview behind the webview.
   * @platform android
   * @default true
   */
  toBack?: boolean;
  /**
   * Bottom padding for the preview, in pixels.
   * @platform android, ios
   */
  paddingBottom?: number;
  /**
   * Whether to rotate the preview when the device orientation changes.
   * @platform ios
   * @default true
   */
  rotateWhenOrientationChanged?: boolean;
  /**
   * The camera to use.
   * @default "rear"
   */
  position?: CameraPosition | string;
  /**
   * If true, saves the captured image to a file and returns the file path.
   * If false, returns a base64 encoded string.
   * @default false
   */
  storeToFile?: boolean;
  /**
   * If true, prevents the plugin from rotating the image based on EXIF data.
   * @platform android
   * @default false
   */
  disableExifHeaderStripping?: boolean;
  /**
   * If true, disables the audio stream, preventing audio permission requests.
   * @default true
   */
  disableAudio?: boolean;
  /**
   * If true, locks the device orientation while the camera is active.
   * @platform android
   * @default false
   */
  lockAndroidOrientation?: boolean;
  /**
   * If true, allows the camera preview's opacity to be changed.
   * @platform android, web
   * @default false
   */
  enableOpacity?: boolean;


  /**
   * If true, disables the visual focus indicator when tapping to focus.
   * @platform android, ios
   * @default false
   */
  disableFocusIndicator?: boolean;
  /**
   * The `deviceId` of the camera to use. If provided, `position` is ignored.
   * @platform ios
   */
  deviceId?: string;
  /**
   * On Android, attempts to bind a physical camera directly when `deviceId` refers to a physical lens.
   * Disabled by default because OEM support is inconsistent; when false, Android keeps the current logical-camera fallback behavior.
   * @default false
   * @platform android
   */
  enablePhysicalDeviceSelection?: boolean;
  /**
   * The initial zoom level when starting the camera preview.
   * If the requested zoom level is not available, the native plugin will reject.
   * @default 1.0
   * @platform android, ios
   * @since 2.2.0
   */
  initialZoomLevel?: number;
  /**
   * The vertical positioning of the camera preview.
   * @default "center"
   * @platform android, ios, web
   * @since 2.3.0
   */
  positioning?: CameraPositioning;
  /**
   * If true, enables video capture capabilities when the camera starts.
   * @default false
   * @platform android
   * @since 7.11.0
   */
  enableVideoMode?: boolean;
  /**
   * If true, forces the camera to start/restart even if it's already running or busy.
   * This will kill the current camera session and start a new one, ignoring all state checks.
   * @default false
   * @platform android, ios, web
   */
  force?: boolean;
  /**
   * Sets the quality of video for recording.
   * Options: 'low', 'medium', 'high'
   * @note On Android requires 'enableVideoMode' to be true
   * @note Will affect the entire preview stream for iOS
   * @platform ios, android
   * @default "high"
   */
  videoQuality?: 'low' | 'medium' | 'high';
}

CameraPreviewPictureOptions

カメラ プレビュー ピクチャ オプション

ピクチャをキャプチャするためのオプションを定義します。

export interface CameraPreviewPictureOptions {
  /**
   * The maximum height of the picture in pixels. The image will be resized to fit within this height while maintaining aspect ratio.
   * If not specified the captured image will match the preview's visible area.
   */
  height?: number;
  /**
   * The maximum width of the picture in pixels. The image will be resized to fit within this width while maintaining aspect ratio.
   * If not specified the captured image will match the preview's visible area.
   */
  width?: number;
  /**
   * The quality of the captured image, from 0 to 100.
   * Does not apply to `.png` format.
   * @default 85
   */
  quality?: number;
  /**
   * The format of the captured image.
   * @default "jpeg"
   */
  format?: PictureFormat;
  /**
   * If true, the captured image will be saved to the user's gallery.
   * @default false
   * @since 7.5.0
   */
  saveToGallery?: boolean;
  /**
   * If true, the plugin will attempt to add GPS location data to the image's EXIF metadata.
   * This may prompt the user for location permissions.
   * @default false
   * @since 7.6.0
   */
  withExifLocation?: boolean;
  /**
   * If true, the plugin will embed a timestamp in the top-right corner of the image.
   * @default false
   * @since 7.17.0
   */
  embedTimestamp?: boolean;
  /**
   * If true, the plugin will embed the current location in the top-right corner of the image.
   * Requires `withExifLocation` to be enabled.
   * @default false
   * @since 7.18.0
   */
  embedLocation?: boolean;
  /**
   * Sets the priority for photo quality vs. capture speed.
   * - "speed": Prioritizes faster capture times, may reduce image quality.
   * - "balanced": Aims for a balance between quality and speed.
   * - "quality": Prioritizes image quality, may reduce capture speed.
   * See https://developer.apple.com/documentation/avfoundation/avcapturephotosettings/photoqualityprioritization for details.
   *
   * @since 7.21.0
   * @platform ios
   * @default "speed"
   */
  photoQualityPrioritization?: 'speed' | 'balanced' | 'quality';
}

ExifData

EXIF データ

EXIFデータを画像から抽出したものを表します。

export interface ExifData {
  [key: string]: any;
}

CameraSampleOptions

カメラサンプルオプションのセクション

サンプルフレームをキャプチャするためのカメラプレビューのオプションを定義します。

export interface CameraSampleOptions {
  /**
   * The quality of the captured sample, from 0 to 100.
   * @default 85
   */
  quality?: number;
}

CameraPreviewFlashMode

カメラプレビューのフラッシュモードのセクション

カメラの利用可能なフラッシュモードです。 ‘torch’ は連続光モードです。

export type CameraPreviewFlashMode = 'off' | 'on' | 'auto' | 'torch';

GridMode

グリッドモードのセクション
export type GridMode = 'none' | '3x3' | '4x4';

PermissionRequestOptions

パーミッションリクエストオプションのセクション
export interface PermissionRequestOptions {
  disableAudio?: boolean;
  showSettingsAlert?: boolean;
  title?: string;
  message?: string;
  openSettingsButtonTitle?: string;
  cancelButtonTitle?: string;
}

CameraPermissionStatus

カメラパーミッションステータスセクション
export interface CameraPermissionStatus {
  camera: PermissionState;
  microphone?: PermissionState;
}

SupportedPictureSizes

サポートされたピクチャサイズセクション

特定の方向に向いたカメラに対してサポートされるピクチャサイズを表します。

export interface SupportedPictureSizes {
  /** The camera direction ("front" or "rear"). */
  facing: string;
  /** A list of supported picture sizes for this camera. */
  supportedPictureSizes: PictureSize[];
}

CameraOpacityOptions

カメラオパシティオプションセクション

カメラプレビューのオパシティを設定するためのオプションを定義します。

export interface CameraOpacityOptions {
  /**
   * The opacity percentage, from 0.0 (fully transparent) to 1.0 (fully opaque).
   * @default 1.0
   */
  opacity?: number;
}

CameraDevice

カメラデバイスセクション

デバイス上の物理的なカメラを表します（例：前面カメラ）。

export interface CameraDevice {
  /** A unique identifier for the camera device. */
  deviceId: string;
  /** A human-readable name for the camera device. */
  label: string;
  /** The physical position of the camera on the device. */
  position: CameraPosition;
  /** A list of all available lenses for this camera device. */
  lenses: CameraLens[];
  /** The overall minimum zoom factor available across all lenses on this device. */
  minZoom: number;
  /** The overall maximum zoom factor available across all lenses on this device. */
  maxZoom: number;
  /** Identifies whether the device is a logical camera (composed of multiple physical lenses). */
  isLogical: boolean;
}

LensInfo

レンズ情報セクション

現在のアクティブなレンズの詳細情報を表します。

export interface LensInfo {
  /** The focal length of the active lens in millimeters. */
  focalLength: number;
  /** The device type of the active lens. */
  deviceType: DeviceType;
  /** The base zoom ratio of the active lens (e.g., 0.5x, 1.0x). */
  baseZoomRatio: number;
  /** The current digital zoom factor applied on top of the base zoom. */
  digitalZoom: number;
}

真実の源

「真実の源」というセクション

このページはプラグインの src/definitions.tsを再実行してください。APIがアップストリームで変更されたときに。

Getting Startedから続けてください

「Getting Startedから続けてください」というセクション

あなたが Getting Started を使用している場合 Getting Startedを使用してネイティブメディアとインターフェイスの動作を計画している場合、@capgo/camera-previewを接続してください native機能の使用に@capgo/camera-previewを使用します。 @capgo/capacitor-live-activitiesを使用します。 native機能の使用に@capgo/capacitor-live-activitiesを使用します。 @capgo/capacitor-live-activities @capgo/capacitor-live-activitiesの実装詳細 @capgo/capacitor-video-playerを使用します。 native機能の使用に@capgo/capacitor-video-playerを使用します。 @capgo/capacitor-video-player @capgo/capacitor-video-playerの実装詳細