Salas RTC y Web SDK
Flujo de integración
Sección titulada «Flujo de integración»- Cree un proyecto y una clave de ámbito en el Consola de RTC.
- Su backend crea una sala utilizando el servidor API.
- Su aplicación autentica a un usuario y comprueba su pertenencia a la sala.
- Su backend solicita las credenciales de los participantes para esa sala autorizada.
- El cliente se conecta con esas credenciales y publica los contenidos multimedia si se le permite.
- Su backend cierra la sala cuando finaliza la sesión.
Sus usuarios finales no reciben la claveAPI del proyecto. Usted sigue siendo responsable de la identidad de la aplicación, la pertenencia al servicio, el consentimiento y la interfaz de usuario.
Cree una sala desde su backend
Sección titulada «Cree una sala desde su backend»# Replace the sample UUID with the project ID copied from your console.curl --fail-with-body \ --request POST https://api.rtc.champrep.com/v1/rooms \ --header "Authorization: Bearer $RTC_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"projectId":"00000000-0000-4000-8000-000000000001","name":"Product support","maxParticipants":4}'Guarde el valor devuelto id en la grabación de la sala de su aplicación. maxParticipants
debe ajustarse tanto a la APIrestricción actual como a la asignación del plan activo. No repita automáticamente la creación de la sala tras un tiempo de espera ambiguo: la primera solicitud podría haber tenido éxito. Compruebe primero la lista.
Obtener las credenciales de los participantes
Sección titulada «Obtener las credenciales de los participantes»Tras comprobar el acceso de su usuario, su backend envía:
curl --fail-with-body \ --request POST "https://api.rtc.champrep.com/v1/rooms/$RTC_ROOM_ID/tokens" \ --header "Authorization: Bearer $RTC_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"canPublish":true}'La respuesta contiene token, participantId, expiresIn, url, y
iceServers. Transmita ese conjunto de credenciales al cliente autorizado a través de su propio punto final autenticado con el almacenamiento en caché desactivado. Trate toda esta información como sensible. Las credenciales caducan a los cinco minutos para la incorporación y no pueden reutilizarse tras una incorporación satisfactoria. Esto no supone una duración máxima de la llamada de cinco minutos.
Navegador SDK
Sección titulada «Navegador SDK»Utilice la distribuciónSDK web compatible con JavaScript/TypeScript.
Contacto CHAMPREP para obtener acceso al paquete e instrucciones de instalación. No instale ningún paquete de terceros con un nombre similar. El siguiente ejemplo da por hecho que ya dispone del RtcSession
clase en su aplicación. Su ruta de importación depende de dicha distribución.
const session = new RtcSession();
session.addEventListener('state', (event) => { updateConnectionLabel((event as CustomEvent).detail);});session.addEventListener('track', (event) => { const { id, stream, kind } = (event as CustomEvent).detail; attachRemoteMedia(id, stream, kind);});session.addEventListener('trackremoved', (event) => { removeRemoteMedia((event as CustomEvent).detail);});session.addEventListener('localtrack', (event) => { showLocalPreview((event as CustomEvent).detail);});session.addEventListener('error', (event) => { showCallError((event as CustomEvent).detail);});
await session.connect(async () => { // Your server authenticates this session and authorizes its room membership. // Implement CSRF protection appropriate to your application's session model. const response = await fetch('/your-app/rtc/join', { method: 'POST', credentials: 'same-origin', cache: 'no-store', }); if (!response.ok) throw new Error('Unable to join this room'); return response.json();});
// Call from your application's explicit microphone/camera consent flow.await session.publish(true);
// Call when leaving or unmounting the call screen.// session.close();Las funciones para la reproducción de contenidos multimedia y los errores son marcadores de posición específicos de la aplicación. Asigne cada flujo devuelto al elemento de audio o vídeo correspondiente, silencie su vista previa local, configure playsInline para el vídeo y gestionar el rechazo de la reproducción automática mediante un control de reproducción activado por el usuario. Una pista de audio remota necesita un elemento compatible con audio incluso cuando no hay vídeo.
SDK controles
Sección titulada «SDK controles»| Método | Comportamiento |
|---|---|
connect(tokenProvider) | Conéctese mediante una función que devuelva nuevas credenciales |
publish(true) | Solicite el micrófono y la cámara y publique sus pistas |
publish(false) | Publicar el audio del micrófono sin el vídeo de la cámara |
setMuted(true) / setMuted(false) | Silenciar o activar el sonido del emisor del micrófono |
setCamera(false) / setCamera(true) | Desactive o active el generador de la cámara |
shareScreen() | Abra el selector del navegador y publique un registro de pantalla solo con vídeo |
setReceiveQuality('low') | Solicite vídeo recibido de menor calidad |
setReceiveQuality('auto') | Restablezca las preferencias habituales de vídeo recibido |
close() | Salir, cerrar transportes y liberar pistas capturadas |
No llame a publish para un participante de solo recepción. Evite las acciones de publicación duplicadas en su interfaz de usuario. Este no captura el audio de la pantallaAPI. Para detener el uso compartido, utilice el control «Detener uso compartido» del navegador. Silenciar no es lo mismo que abandonar; llamada close() para liberar la sesión y los dispositivos capturados.
Cambios en la red y ciclo de vida
Sección titulada «Cambios en la red y ciclo de vida»El intentaSDK la reconexión tras interrupciones de señalización y vuelve a utilizar la función del proveedor de tokens. Emita siempre un nuevo token tras comprobar el acceso; nunca almacene en caché un token consumido. La reconexión tiene un límite y puede fallar. Muestre los estados de conexión y de error, y ofrezca un flujo de reincorporación controlado por el usuario.
El modo de bajo ancho de banda reduce la calidad del vídeo recibido; no puede garantizar una llamada en una conexión inutilizable. Considere la posibilidad de realizar una publicación solo de audio cuando sea apropiado. El SDK tambiénSDK admite new RtcSession({ iceTransportPolicy: 'relay' }) para conexiones «solo de retransmisión», que requieren un servicio de retransmisión accesible.
Pruebe dispositivos reales, permisos del navegador, redes restringidas, ejecución en segundo plano, compartición de pantalla y el comportamiento de reconexión antes del lanzamiento. Las guías de Python, Node.js SDKs y MEAN/MERN/MEN siguen vigentes elementos de la hoja de ruta.