@capgo/ricoh360

ricoh360-camera

➡️ Get Instant updates for your App with Capgo 🚀

Fix your annoying bug now, Hire a Capacitor expert 💪

Provides an SDK for the Ricoh360 cameras for Capacitor

Install

npm install ricoh360-camera
npx cap sync

API

• initialize(...)
• getCameraAsset(...)
• listFiles(...)
• capturePicture()
• captureVideo(...)
• livePreview(...)
• stopLivePreview()
• readSettings(...)
• setSettings(...)
• sendCommand(...)
• 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>

---

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; }

Array

Prop	Type	Description
length	number	Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Method	Signature	Description
toString	() => string	Returns a string representation of an array.
toLocaleString	() => string	Returns a string representation of an array. The elements are converted to string using their toLocalString methods.
pop	() => T | undefined	Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
push	(...items: T[]) => number	Appends new elements to the end of an array, and returns the new length of the array.
concat	(...items: ConcatArray<T>[]) => T[]	Combines two or more arrays. This method returns a new array without modifying any existing arrays.
concat	(...items: (T | ConcatArray<T>)[]) => T[]	Combines two or more arrays. This method returns a new array without modifying any existing arrays.
join	(separator?: string | undefined) => string	Adds all the elements of an array into a string, separated by the specified separator string.
reverse	() => T[]	Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.
shift	() => T | undefined	Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
slice	(start?: number | undefined, end?: number | undefined) => T[]	Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.
sort	(compareFn?: ((a: T, b: T) => number) | undefined) => this	Sorts an array in place. This method mutates the array and returns a reference to the same array.
splice	(start: number, deleteCount?: number | undefined) => T[]	Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
splice	(start: number, deleteCount: number, ...items: T[]) => T[]	Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
unshift	(...items: T[]) => number	Inserts new elements at the start of an array, and returns the new length of the array.
indexOf	(searchElement: T, fromIndex?: number | undefined) => number	Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
lastIndexOf	(searchElement: T, fromIndex?: number | undefined) => number	Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
every	<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => this is S[]	Determines whether all the members of an array satisfy the specified test.
every	(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => boolean	Determines whether all the members of an array satisfy the specified test.
some	(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => boolean	Determines whether the specified callback function returns true for any element of an array.
forEach	(callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any) => void	Performs the specified action for each element in an array.
map	<U>(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any) => U[]	Calls a defined callback function on each element of an array, and returns an array that contains the results.
filter	<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => S[]	Returns the elements of an array that meet the condition specified in a callback function.
filter	(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => T[]	Returns the elements of an array that meet the condition specified in a callback function.
reduce	(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => T	Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduce	(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T
reduce	<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => U	Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduceRight	(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => T	Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduceRight	(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T
reduceRight	<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => U	Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

ConcatArray

Prop	Type
length	number

Method	Signature
join	(separator?: string | undefined) => string
slice	(start?: number | undefined, end?: number | undefined) => T[]

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; }