ricoh360-camera

➡️ Get Instant updates for your App with Capgo

Missing a feature? We’ll build the plugin for you 💪

Provides an SDK for the Ricoh360 cameras for Capacitor

Documentation

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

Install

npm install ricoh360-camera
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; }