Primeros pasos

Instalar

Puedes usar nuestro setup asistido por IA para instalar el plugin. Añade las skills de Capgo a tu herramienta de IA con el siguiente comando:

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

Luego usa el siguiente prompt:

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

Si prefieres la configuración manual, instala el plugin ejecutando los siguientes comandos y sigue las instrucciones específicas para cada plataforma a continuación:

bun add @capgo/capacitor-ricoh360
bunx cap sync

Importar

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

Inicio rápido

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

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

Ejemplo: getCameraAsset

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

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

Ejemplo: listFiles

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

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

Errores comunes

• Inicializar una vez: run setup during app bootstrap.
• Sync nativo: ejecutar bunx cap sync tras actualizar los plugins.
• Fuente de verdad: confiar src/definitions.ts en el repo de GitHub.

Resumen de API

Cada ejemplo repite el import para que el snippet se pueda copiar solo.

initialize

Inicializa SDK con la URL de la cámara

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

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

getCameraAsset

Obtiene un asset de la cámara desde una URL y lo devuelve en base64

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

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

listFiles

Lista los archivos almacenados en la cámara

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

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

capturePicture

Captura una foto

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

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

captureVideo

Captura un video

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

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

livePreview

Inicia la vista previa en vivo

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

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

stopLivePreview

Detiene la vista previa en vivo

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

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

readSettings

Lee la configuración de la cámara

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

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

setSettings

Configura los ajustes de la cámara

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

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

sendCommand

Envía un comando raw a la cámara

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

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

Referencia de tipos

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

Fuente de verdad

Esta página se genera a partir del src/definitions.ts. Vuelve a ejecutar el sync cuando el API público cambie en el upstream.

Continúa desde Primeros pasos

Si estás usando Primeros pasos para planificar el comportamiento de los medios y la interfaz nativos, conéctalo con Uso de @capgo/capacitor-live-activities para la capacidad nativa en Uso de @capgo/capacitor-live-activities, @capgo/capacitor-live-activities para el detalle de implementación en @capgo/capacitor-live-activities, Uso de @capgo/capacitor-video-player para la funcionalidad nativa en el uso de @capgo/capacitor-video-player, @capgo/capacitor-video-player para los detalles de implementación en @capgo/capacitor-video-player, y Usando @capgo/capacitor-native-navigation para la capacidad nativa al usar @capgo/capacitor-native-navigation.