スタートガイド

インストール

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

bunx 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/capacitor-ricoh360` plugin in my project.

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください：

bun add @capgo/capacitor-ricoh360
bunx cap sync

インポート

import { Ricoh360Camera } from '@capgo/capacitor-ricoh360';

クイックスタート

import { Ricoh360Camera } from '@capgo/capacitor-ricoh360';

const result = await Ricoh360Camera.initialize({ url: 'https://example.com' });
console.log(result);

例: getCameraAsset

import { Ricoh360Camera } from '@capgo/capacitor-ricoh360';

const result = await Ricoh360Camera.getCameraAsset({ url: 'https://example.com' });
console.log(result);

例: listFiles

import { Ricoh360Camera } from '@capgo/capacitor-ricoh360';

const result = await Ricoh360Camera.listFiles();
console.log(result);

よくある落とし穴

• 一度だけ初期化: アプリのブートストラップ時に setup を実行します。
• ネイティブ同期: 実行 bunx cap sync プラグインのアップグレード後。
• 信頼できる情報源: 信頼 src/definitions.ts GitHub リポジトリ内。

API の概要

各サンプルで import を繰り返しているのは、スニペット単体でコピーできるようにするためです。

initialize

カメラURLを使用して SDK を初期化します

import { Ricoh360Camera } from '@capgo/capacitor-ricoh360';

const result = await Ricoh360Camera.initialize({ url: 'https://example.com' });
console.log(result);

getCameraAsset

URLからカメラアセットを取得し、base64形式で返します

import { Ricoh360Camera } from '@capgo/capacitor-ricoh360';

const result = await Ricoh360Camera.getCameraAsset({ url: 'https://example.com' });
console.log(result);

listFiles

カメラに保存されているファイル一覧を取得します

import { Ricoh360Camera } from '@capgo/capacitor-ricoh360';

const result = await Ricoh360Camera.listFiles();
console.log(result);

capturePicture

写真を撮影します

import { Ricoh360Camera } from '@capgo/capacitor-ricoh360';

const result = await Ricoh360Camera.capturePicture();
console.log(result);

captureVideo

動画をキャプチャします

import { Ricoh360Camera } from '@capgo/capacitor-ricoh360';

const result = await Ricoh360Camera.captureVideo({
  resolution: '4K',
  frameRate: 1,
  bitrate: 1,
});
console.log(result);

livePreview

ライブプレビューを開始します

import { Ricoh360Camera } from '@capgo/capacitor-ricoh360';

const result = await Ricoh360Camera.livePreview({
  displayInFront: false,
  cropPreview: false,
});
console.log(result);

stopLivePreview

ライブプレビューを停止します

import { Ricoh360Camera } from '@capgo/capacitor-ricoh360';

const result = await Ricoh360Camera.stopLivePreview();
console.log(result);

readSettings

カメラの設定を読み取ります

import { Ricoh360Camera } from '@capgo/capacitor-ricoh360';

const result = await Ricoh360Camera.readSettings({ options: ['option'] });
console.log(result);

setSettings

カメラの設定を行います

import { Ricoh360Camera } from '@capgo/capacitor-ricoh360';

const result = await Ricoh360Camera.setSettings({ options: {} });
console.log(result);

sendCommand

カメラに生のコマンドを送信します

import { Ricoh360Camera } from '@capgo/capacitor-ricoh360';

const result = await Ricoh360Camera.sendCommand({
  endpoint: 'https://example.com',
  payload: {},
});
console.log(result);

型リファレンス

InitializeOptions

export interface InitializeOptions {
  url: string;
}

CommandResponse

export interface CommandResponse {
  session?: string;
  info?: string;
  preview?: string;
  picture?: string;
  settings?: string;
}

GetCameraAssetOptions

export interface GetCameraAssetOptions {
  url: string;
  saveToFile?: boolean;
}

GetCameraAssetResponse

export interface GetCameraAssetResponse {
  statusCode: number;
  data: string; // base64 encoded data
  filePath?: string;
}

ListFilesOptions

export interface ListFilesOptions {
  fileType?: 'all' | 'image' | 'video';
  startPosition?: number;
  entryCount?: number;
  maxThumbSize?: number;
  _detail?: boolean;
}

ListFilesResponse

export interface ListFilesResponse {
  results: {
    entries: {
      name: string;
      fileUrl: string;
      size: number;
      dateTimeZone: string;
      width?: number;
      height?: number;
      previewUrl?: string;
      _projectionType?: string;
      isProcessed?: boolean;
      _thumbSize?: number;
    }[];
    totalEntries: number;
  };
}

VideoCaptureOptions

export interface VideoCaptureOptions {
  // Define any specific options needed for capturing a video
  resolution?: '4K' | '2K';
  frameRate?: number;
  bitrate?: number;
}

LivePreviewOptions

export interface LivePreviewOptions {
  displayInFront?: boolean;
  cropPreview?: boolean;
}

Source of Truth

このページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。

Getting Startedの続きを進める

使用している場合 スタートガイド ネイティブメディアとインターフェースの挙動を計画するには、次と連携させてください @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 の実装の詳細、および @capgo/capacitor-native-navigation の活用 @capgo/capacitor-native-navigation. の使い方におけるネイティブ機能については