Getting Started

安装

npm install @capgo/capacitor-ricoh360
npx cap sync

导入

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

API 介绍

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

initialize

初始化SDK

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

await Ricoh360Camera.initialize({} as InitializeOptions);

getCameraAsset

从 URL 中检索摄像头资产并以 base64 格式返回

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

await Ricoh360Camera.getCameraAsset({} as GetCameraAssetOptions);

listFiles

复制到剪贴板

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

await Ricoh360Camera.listFiles();

capturePicture

捕获视频

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

await Ricoh360Camera.capturePicture();

captureVideo

录制视频

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

await Ricoh360Camera.captureVideo({} as VideoCaptureOptions);

livePreview

开始实时预览

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

await Ricoh360Camera.livePreview({} as LivePreviewOptions);

stopLivePreview

复制到剪贴板

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

await Ricoh360Camera.stopLivePreview();

readSettings

设置相机设置

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

await Ricoh360Camera.readSettings({} as { options: string[] });

setSettings

设置相机设置

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

await Ricoh360Camera.setSettings({} as { options: Record<string, any> });

sendCommand

将原始命令发送到相机

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

await Ricoh360Camera.sendCommand({} as { endpoint: string; payload: Record<string, any> });

类型参考

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 继续

如果您正在使用 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 的原生能力