快速入门

安装

你可以使用我们的 AI 辅助设置来安装插件。使用以下命令将 Capgo skills 添加到你的 AI 工具中：

bunx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下 prompt：

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;
}

单一事实来源

本页面由插件的 src/definitions.ts生成。当上游的公共 API 发生变化时，请重新运行 sync。

从入门指南继续

如果你正在使用 快速入门 来规划原生媒体和界面行为，并将其与 使用 @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. 时的原生能力