Guía
Cómo usar Twilio Video en Capacitor
Usando @capgo/capacitor-twilio-video
Capacitor API para unirse a salas de Twilio Video con una superficie de llamada nativa en la aplicación.
Instalar
bun add @capgo/capacitor-twilio-video
bunx cap sync
bunx cap sync copia el plugin nativo code en tus proyectos nativos. Ejecútalo de nuevo después de cada actualización del plugin.
Importar
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
API a un vistazo
| Método | Descripción |
|---|---|
login |
Almacena y valida un token de acceso a Twilio Video creado por tu backend. |
logout |
Elimina el token de acceso en caché y abandona la sala activa. |
isLoggedIn |
Verifica si se almacena un token de Twilio válido en el dispositivo. |
joinRoom |
Únete a una sala de Twilio y muestra el overlay de llamada en la aplicación. |
leaveRoom |
Abandona la sala actual si estás conectado. |
setMicrophoneEnabled |
Habilita/desactiva la publicación del micrófono local. |
setCameraEnabled |
Activar/desactivar la publicación de la cámara local. |
getCallStatus |
Devuelve el nombre actual de la sala, el estado de medios y el recuento de participantes. |
checkMicrophonePermission |
Verificar el estado de permiso de micrófono. |
requestMicrophonePermission |
Solicitar permiso de micrófono. |
checkCameraPermission |
Verificar el estado de permiso de cámara. |
requestCameraPermission |
Solicitar permiso de cámara. |
Ejemplos
login()
Guardar y validar un token de acceso Twilio Video creado por tu backend.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.login({ accessToken: 'access-token-123' });
console.log(result);
logout()
Eliminar el token de acceso cacheado y dejar la sala activa.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.logout();
console.log(result);
isLoggedIn()
Verificar si un token Twilio válido está actualmente cacheado en el dispositivo.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.isLoggedIn();
// The result holds sensitive values: use it without logging it.
joinRoom()
Unirse a una sala Twilio y presentar la capa de llamada nativa en la aplicación.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.joinRoom({ roomName: 'room' });
console.log(result);
leaveRoom()
Dejar la sala actual si está conectado.
import { CapacitorTwilioVideo } from '@capgo/capacitor-twilio-video';
const result = await CapacitorTwilioVideo.leaveRoom();
console.log(result);
setMicrophoneEnabled()
Activar/desactivar 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 básicos. Los ayudantes de escucha y versión, así como el contrato completo de cada método, se documentan en el repositorio de GitHub.
Escuchar eventos
addListener devuelve un manejador. Llame a handle.remove() cuando se desmonte la pantalla, o CapacitorTwilioVideo.removeAllListeners() para eliminar todos los escuchas.
Referencia completa
Continuar desde el uso de @capgo/capacitor-twilio-video
If estás utilizando Usando @capgo/capacitor-twilio-video para planificar el comportamiento de medios y interfaz nativa, conecta con @capgo/capacitor-video-de-twilio para el detalle de implementación en @capgo/capacitor-twilio-video, Getting Started para el detalle de implementación en Inicio, Usando @capgo/capacitor-live-activities para la capacidad nativa en Usando @capgo/capacitor-live-activities, @capgo/capacitor-actividades en vivo para el detalle de implementación en @capgo/capacitor-live-activities, y Usando @capgo/capacitor-video-player para la capacidad nativa en Uso de @capgo/capacitor-reproductor-de-video.