Getting Started

Copy a setup prompt with the install steps and the full markdown guide for this plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/ricoh360`, `@capgo/capacitor-ricoh360-camera-plugin`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/ricoh360-camera/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Ce contenu n'est pas encore disponible dans votre langue.

Install

bun add @capgo/ricoh360
bunx cap sync

Import

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

API Overview

`initialize`

Initializes the SDK with camera URL

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

await Ricoh360Camera.initialize({} as InitializeOptions);

`getCameraAsset`

Retrieves a camera asset from a URL and returns it as base64

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

await Ricoh360Camera.getCameraAsset({} as GetCameraAssetOptions);

`listFiles`

Lists files stored on the camera

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

await Ricoh360Camera.listFiles();

`capturePicture`

Captures a picture

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

await Ricoh360Camera.capturePicture();

`captureVideo`

Captures a video

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

await Ricoh360Camera.captureVideo({} as VideoCaptureOptions);

`livePreview`

Starts live preview

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

await Ricoh360Camera.livePreview({} as LivePreviewOptions);

`stopLivePreview`

Stops live preview

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

await Ricoh360Camera.stopLivePreview();

`readSettings`

Reads camera settings

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

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

`setSettings`

Sets camera settings

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

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

`sendCommand`

Send raw command to camera

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

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

Type Reference

`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

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.