@capgo/capacitor-ricoh360

Control Ricoh 360 cameras from your Capacitor app: live preview, photo capture, settings and file access.

🤖 Building with an AI coding agent? Install Capgo skills so Claude Code, Codex, Cursor, Copilot, or Gemini CLI know how to install and use @capgo/capacitor-ricoh360 in your Capacitor app: npx skills add Cap-go/capgo-skills. Then ask your agent: "Add @capgo/capacitor-ricoh360 to my Capacitor app and wire it up." Agent setup guides · Hosted MCP

Key features

• Connect: initialize() with the camera URL.
• Capture: capturePicture() takes a photo.
• Live preview: livePreview() and stopLivePreview().
• Files: listFiles() and getCameraAsset() read media stored on the camera.
• Settings and commands: readSettings(), setSettings() and sendCommand() for raw camera API calls.
• Platforms: iOS and Android. Not available on web.

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/ricoh360-camera-plugin/

Compatibility

| Plugin version | Capacitor compatibility | Maintained | | -------------- | ----------------------- | ---------- | | v8.*.* | v8.*.* | ✅ | | v7.*.* | v7.*.* | On demand | | v6.*.* | v6.*.* | ❌ | | v5.*.* | v5.*.* | ❌ |

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-ricoh360` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

npm install @capgo/capacitor-ricoh360
npx cap sync

API

• initialize(...)
• getCameraAsset(...)
• listFiles(...)
• capturePicture()
• captureVideo(...)
• livePreview(...)
• stopLivePreview()
• readSettings(...)
• setSettings(...)
• sendCommand(...)
• getPluginVersion()
• Interfaces
• Type Aliases

initialize(...)

initialize(options: InitializeOptions) => Promise<CommandResponse>

Initializes the SDK with camera URL

| Param | Type | | ------------- | --------------------------------------------------------------- | | options | InitializeOptions |

Returns: Promise<CommandResponse>

getCameraAsset(...)

getCameraAsset(options: GetCameraAssetOptions) => Promise<GetCameraAssetResponse>

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

| Param | Type | Description | | ------------- | ----------------------------------------------------------------------- | ------------------------------------------------- | | options | GetCameraAssetOptions | Object containing the URL to fetch the asset from |

Returns: Promise<GetCameraAssetResponse>

listFiles(...)

listFiles(options?: ListFilesOptions | undefined) => Promise<ListFilesResponse>

Lists files stored on the camera

| Param | Type | Description | | ------------- | ------------------------------------------------------------- | -------------------------------------------------- | | options | ListFilesOptions | Optional parameters to filter and paginate results |

Returns: Promise<ListFilesResponse>

capturePicture()

capturePicture() => Promise<CommandResponse>

Captures a picture

Returns: Promise<CommandResponse>

captureVideo(...)

captureVideo(options: VideoCaptureOptions) => Promise<CommandResponse>

Captures a video

| Param | Type | | ------------- | ------------------------------------------------------------------- | | options | VideoCaptureOptions |

Returns: Promise<CommandResponse>

livePreview(...)

livePreview(options: LivePreviewOptions) => Promise<CommandResponse>

Starts live preview

| Param | Type | | ------------- | ----------------------------------------------------------------- | | options | LivePreviewOptions |

Returns: Promise<CommandResponse>

stopLivePreview()

stopLivePreview() => Promise<CommandResponse>

Stops live preview

Returns: Promise<CommandResponse>

readSettings(...)

readSettings(options: { options: string[]; }) => Promise<CommandResponse>

Reads camera settings

| Param | Type | Description | | ------------- | ----------------------------------- | ----------------------------------------- | | options | { options: string[]; } | Array of option names to read from camera |

Returns: Promise<CommandResponse>

setSettings(...)

setSettings(options: { options: Record<string, any>; }) => Promise<CommandResponse>

Sets camera settings

| Param | Type | Description | | ------------- | -------------------------------------------------------------------------- | ---------------------------------------- | | options | { options: Record<string, any>; } | Object containing camera settings to set |

Returns: Promise<CommandResponse>

sendCommand(...)

sendCommand(options: { endpoint: string; payload: Record<string, any>; }) => Promise<CommandResponse>

Send raw command to camera

| Param | Type | | ------------- | -------------------------------------------------------------------------------------------- | | options | { endpoint: string; payload: Record<string, any>; } |

Returns: Promise<CommandResponse>

getPluginVersion()

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version

Returns: Promise<{ version: string; }>

Interfaces

CommandResponse

| Prop | Type | | -------------- | ------------------- | | session | string | | info | string | | preview | string | | picture | string | | settings | string |

InitializeOptions

| Prop | Type | | --------- | ------------------- | | url | string |

GetCameraAssetResponse

| Prop | Type | | ---------------- | ------------------- | | statusCode | number | | data | string | | filePath | string |

GetCameraAssetOptions

| Prop | Type | | ---------------- | -------------------- | | url | string | | saveToFile | boolean |

ListFilesResponse

| Prop | Type | | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | results | { entries: { name: string; fileUrl: string; size: number; dateTimeZone: string; width?: number; height?: number; previewUrl?: string; _projectionType?: string; isProcessed?: boolean; _thumbSize?: number; }[]; totalEntries: number; } |

ListFilesOptions

| Prop | Type | | ------------------- | ---------------------------------------- | | fileType | 'all' | 'image' | 'video' | | startPosition | number | | entryCount | number | | maxThumbSize | number | | _detail | boolean |

VideoCaptureOptions

| Prop | Type | | ---------------- | ------------------------- | | resolution | '4K' | '2K' | | frameRate | number | | bitrate | number |

LivePreviewOptions

| Prop | Type | | -------------------- | -------------------- | | displayInFront | boolean | | cropPreview | boolean |

Type Aliases

Record

Construct a type with a set of properties K of type T

{ [P in K]: T; }