Einstieg

Installieren

bun add @capgo/ricoh360
bunx cap sync

Importieren

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

API Übersicht

initialize

Initialisiert die SDK mit der Kamera-URL

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

await Ricoh360Camera.initialize({} as InitializeOptions);

getCameraAsset

Ruft ein Kamera-Asset aus einer URL ab und gibt es als Base64 zurück

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

await Ricoh360Camera.getCameraAsset({} as GetCameraAssetOptions);

listFiles

Listet die auf der Kamera gespeicherten Dateien auf

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

await Ricoh360Camera.listFiles();

capturePicture

Ermittelt ein Bild

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

await Ricoh360Camera.capturePicture();

captureVideo

Ermittelt ein Video

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

await Ricoh360Camera.captureVideo({} as VideoCaptureOptions);

livePreview

Startet Live-Vorschau

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

await Ricoh360Camera.livePreview({} as LivePreviewOptions);

stopLivePreview

Beendet Live-Vorschau

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

await Ricoh360Camera.stopLivePreview();

readSettings

Liest Kameraeinstellungen

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

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

setSettings

Setzt Kameraeinstellungen

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

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

sendCommand

Sendet rohen Befehl an die Kamera

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

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

Typenverweis

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

Quellwahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.