开始使用

安装

您可以使用我们的 AI 助手设置来安装插件。将 Capgo 能力添加到您的 AI 工具中，使用以下命令:

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

如果您更喜欢手动设置，请运行以下命令安装插件，并按照以下平台特定的说明进行操作：

npm install @capgo/capacitor-ricoh360
npx cap sync

导入

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

API概述

每个示例都重复导入，以便可以单独复制代码片段。

initialize

初始化SDK并使用相机URL

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上游发生变化。

继续从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-视频播放器 了解 @capgo/capacitor-视频播放器 的实现细节 使用 @capgo/capacitor-原生导航 了解使用 @capgo/capacitor-原生导航 的原生能力