Prise en main

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

bunx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Utilisez ensuite le prompt suivant :

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

Si vous préférez une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

bun add @capgo/capacitor-ricoh360
bunx cap sync

Importer

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

Démarrage rapide

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

const result = await Ricoh360Camera.initialize({ url: 'https://example.com' });
console.log(result);

Exemple : getCameraAsset

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

const result = await Ricoh360Camera.getCameraAsset({ url: 'https://example.com' });
console.log(result);

Exemple : listFiles

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

const result = await Ricoh360Camera.listFiles();
console.log(result);

Erreurs courantes

• Initialiser une seule fois: exécutez le setup lors du bootstrap de l'app.
• Sync native : exécuter bunx cap sync après les mises à jour du plugin.
• Source de vérité : fiez-vous src/definitions.ts au repo GitHub.

Aperçu de API

Chaque exemple répète l'import pour que le snippet puisse être copié seul.

initialize

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

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

const result = await Ricoh360Camera.initialize({ url: 'https://example.com' });
console.log(result);

getCameraAsset

Récupère un asset de la caméra via une URL et le retourne en base64

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

const result = await Ricoh360Camera.getCameraAsset({ url: 'https://example.com' });
console.log(result);

listFiles

Liste les fichiers stockés sur la caméra

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

const result = await Ricoh360Camera.listFiles();
console.log(result);

capturePicture

Capture une photo

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

const result = await Ricoh360Camera.capturePicture();
console.log(result);

captureVideo

Capture une vidéo

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

const result = await Ricoh360Camera.captureVideo({
  resolution: '4K',
  frameRate: 1,
  bitrate: 1,
});
console.log(result);

livePreview

Lance l'aperçu en direct

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

const result = await Ricoh360Camera.livePreview({
  displayInFront: false,
  cropPreview: false,
});
console.log(result);

stopLivePreview

Arrête l'aperçu en direct

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

const result = await Ricoh360Camera.stopLivePreview();
console.log(result);

readSettings

Lit les paramètres de la caméra

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

const result = await Ricoh360Camera.readSettings({ options: ['option'] });
console.log(result);

setSettings

Configure les paramètres de la caméra

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

const result = await Ricoh360Camera.setSettings({ options: {} });
console.log(result);

sendCommand

Envoie une commande brute à la caméra

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

const result = await Ricoh360Camera.sendCommand({
  endpoint: 'https://example.com',
  payload: {},
});
console.log(result);

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 de src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Continuer depuis Getting Started

Si vous utilisez Prise en main pour planifier le comportement des médias et de l'interface natifs, connectez-l’à Utiliser @capgo/capacitor-live-activities pour la capacité native dans Utiliser @capgo/capacitor-live-activities @capgo/capacitor-live-activities pour le détail d'implémentation dans @capgo/capacitor-live-activities Utiliser @capgo/capacitor-video-player pour la fonctionnalité native dans la section Utiliser @capgo/capacitor-video-player, @capgo/capacitor-video-player pour les détails d'implémentation dans @capgo/capacitor-video-player, et Utilisation de @capgo/capacitor-native-navigation pour la fonctionnalité native dans Using @capgo/capacitor-native-navigation.