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:

npx 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-twilio-video` plugin in my project.

Si prefieres la configuración manual, instala el plugin ejecutando estos comandos y sigue las instrucciones de cada plataforma:

bun add @capgo/capacitor-twilio-video
bunx cap sync

Importar

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

Inicio rápido

import { TwilioVideo } from '@capgo/capacitor-twilio-video';
await TwilioVideo.login({ accessToken: 'token' });
await TwilioVideo.joinRoom({ roomName: 'room' });

Errores comunes

• Genera los tokens solo en tu servidor.
• Solicita permisos de cámara y micrófono.
• Gestiona las interrupciones de audio en iOS.

Resumen de API

login

Almacena y valida el token de acceso de Twilio Video generado por tu backend.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.login({ accessToken: 'access-token-123' });
console.log(result);

logout

Borra el token de acceso en caché y sale de la sala activa.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.logout();
console.log(result);

isLoggedIn

Comprueba si hay un token de Twilio válido en la caché del dispositivo.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.isLoggedIn();
// The result holds sensitive values: use it without logging it.

joinRoom

Entra en una sala de Twilio y muestra el overlay nativo de llamada del plugin.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.joinRoom({ roomName: 'room' });
console.log(result);

leaveRoom

Sale de la sala actual si está conectado.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.leaveRoom();
console.log(result);

setMicrophoneEnabled

Activa o desactiva la publicación del micrófono local.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.setMicrophoneEnabled({ enabled: true });
console.log(result);

setCameraEnabled

Activar/desactivar la publicación de la cámara local.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.setCameraEnabled({ enabled: true });
console.log(result);

getCallStatus

Devuelve el nombre de la sala, el estado de medios y el número de participantes.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.getCallStatus();
// The result holds sensitive values: use it without logging it.

checkMicrophonePermission

Verifica el estado del permiso del micrófono.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.checkMicrophonePermission();
console.log(result);

requestMicrophonePermission

Solicitar permiso del micrófono.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.requestMicrophonePermission();
console.log(result);

checkCameraPermission

Verificar el estado del permiso de la cámara.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.checkCameraPermission();
console.log(result);

requestCameraPermission

Solicitar permiso de la cámara.

import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';

const result = await CapacitorTwilioVideo.requestCameraPermission();
console.log(result);

Fuente de verdad

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

Continúa desde Getting Started

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