Guía
Cómo usar Twilio Video en Capacitor
Uso de @capgo/capacitor-twilio-video
Capacitor API para unirse a salas de Twilio Video con una interfaz de llamada nativa.
Instalar
bun add @capgo/capacitor-twilio-video
bunx cap sync
bunx cap sync copia el code nativo del plugin en tus proyectos nativos. Ejecútalo de nuevo tras cada actualización del plugin.
Importar
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
API de un vistazo
| Método | Descripción |
|---|---|
login |
Almacena y valida un token de acceso de Twilio Video generado por tu backend. |
logout |
Borra el token de acceso en caché y sale de la sala activa. |
isLoggedIn |
Comprueba si hay un token de Twilio válido en la caché del dispositivo. |
joinRoom |
Únete a una sala de Twilio y muestra el overlay nativo de llamada del plugin. |
leaveRoom |
Sale de la sala actual si está conectado. |
setMicrophoneEnabled |
Activa/desactiva la publicación del micrófono local. |
setCameraEnabled |
Activar/desactivar la publicación de la cámara local. |
getCallStatus |
Devuelve el nombre de la sala, el estado de medios y el número de participantes. |
checkMicrophonePermission |
Comprueba el estado del permiso del micrófono. |
requestMicrophonePermission |
Solicitar permiso del micrófono. |
checkCameraPermission |
Verificar el estado del permiso de la cámara. |
requestCameraPermission |
Solicitar permiso de la cámara. |
Ejemplos
login()
Almacena y valida un 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()
Únete a 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/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);
La tabla anterior enumera los 12 métodos principales. Los helpers de listener y de versión, y el contrato completo de cada método, están documentados en la repositorio GitHub.
Escuchar eventos
addListener devuelve un handle. Llama handle.remove() cuando la pantalla se desmonte, o CapacitorTwilioVideo.removeAllListeners() para limpiar todos los listeners.
Referencia completa
Continúa desde Usando @capgo/capacitor-twilio-video
Si estás usando Uso de @capgo/capacitor-twilio-video para planificar el comportamiento de los medios nativos y la interfaz, conéctalo con @capgo/capacitor-twilio-video para los detalles de implementación en @capgo/capacitor-twilio-video, Primeros pasos para los detalles de implementación en Primeros pasos, 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, y Uso de @capgo/capacitor-video-player para la capacidad nativa en Uso de @capgo/capacitor-video-player.