Démarrage

Installer

bun add @capgo/ricoh360
bunx cap sync

Importer

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

API Présentation

initialize

Initialise le SDK avec l'URL de la caméra

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

await Ricoh360Camera.initialize({} as InitializeOptions);

getCameraAsset

Récupère un élément de caméra à partir d'une URL et le retourne sous forme base64

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

await Ricoh360Camera.getCameraAsset({} as GetCameraAssetOptions);

listFiles

Affiche les fichiers stockés sur la caméra

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

await Ricoh360Camera.listFiles();

capturePicture

Capturer une photo

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

await Ricoh360Camera.capturePicture();

captureVideo

Capturer une vidéo

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

await Ricoh360Camera.captureVideo({} as VideoCaptureOptions);

livePreview

Démarrer la prévisualisation en direct

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

await Ricoh360Camera.livePreview({} as LivePreviewOptions);

stopLivePreview

Arrêtez la prévisualisation en direct

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

await Ricoh360Camera.stopLivePreview();

readSettings

Lis les paramètres de la caméra

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

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

setSettings

Définit les paramètres de la caméra

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

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

sendCommand

Envoyer un commandement brut à la caméra

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

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

Référence de type

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 de Vérité

Cette page est générée à partir du plugin’s src/definitions.tsRe-run la synchronisation lorsque le public API change en amont.