Aller au contenu
Documentation

Salles RTC et Web SDK

  1. Créez un projet et une clé de portée dans le Console RTC.
  2. Votre backend crée une salle à l’aide de la serveur API.
  3. Votre application authentifie un utilisateur et vérifie son appartenance à la salle.
  4. Votre backend demande les identifiants du participant pour cette salle autorisée.
  5. Le client se connecte à l’aide de ces identifiants et publie les flux multimédias si cela est autorisé.
  6. Votre backend ferme la salle lorsque la session est terminée.

Vos utilisateurs finaux ne reçoivent pas la cléAPI du projet. Vous restez responsable de l’identité de l’application, de l’adhésion, du consentement et de l’interface utilisateur.

Fenêtre de terminal
# 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}'

Enregistrez les données renvoyées id dans l’enregistrement de la salle de votre application. maxParticipants doit respecter à la fois la contrainteAPI actuelle et la limite autorisée par le forfait actif. Ne répétez pas automatiquement la création de la salle après un délai d’expiration ambigu : la première requête a peut-être abouti. Vérifiez d’abord la liste.

Après avoir vérifié les droits d’accès de votre utilisateur, votre backend envoie :

Fenêtre de terminal
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 réponse contient token, participantId, expiresIn, url, et iceServers. Transmettez cet ensemble d’identifiants au client autorisé via votre propre point de terminaison authentifié, la mise en cache étant désactivée. Traitez l’ensemble de ces informations comme sensibles. Les identifiants expirent au bout de cinq minutes pour la connexion et ne peuvent pas être réutilisés après une connexion réussie. Il ne s’agit pas d’une durée maximale d’appel de cinq minutes.

Utilisez la distributionSDK Web JavaScript/TypeScript prise en charge. Contact CHAMPREP pour l’accès au paquet et les instructions d’installation. N’installez pas de paquet tiers portant un nom similaire. L’exemple suivant part du principe que vous disposez déjà du RtcSession dans votre application. Son chemin d’importation dépend de cette distribution.

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();

Les fonctions de rendu des médias et de gestion des erreurs sont des espaces réservés spécifiques à l’application. Associez chaque flux renvoyé à l’élément audio ou vidéo approprié, mettez en sourdine votre prévisualisation locale, configurez playsInline pour la vidéo, et gérez le refus de la lecture automatique à l’aide d’une commande « Lecture » activée par l’utilisateur. Une piste audio distante nécessite un élément prenant en charge l’audio, même en l’absence de vidéo.

MéthodeComportement
connect(tokenProvider)Rejoindre la session à l’aide d’une fonction renvoyant de nouvelles informations d’identification
publish(true)Demander l’accès au microphone et à la caméra et publier leurs pistes
publish(false)Publier le son du microphone sans la vidéo de la caméra
setMuted(true) / setMuted(false)Couper ou réactiver le son du producteur du microphone
setCamera(false) / setCamera(true)Désactivez ou activez le producteur de la caméra
shareScreen()Ouvrez la fenêtre de sélection du navigateur et publiez un enregistrement d’écran contenant uniquement de la vidéo
setReceiveQuality('low')Demandez une vidéo reçue de qualité inférieure
setReceiveQuality('auto')Rétablissez les préférences habituelles concernant les vidéos reçues
close()Quitter, fermer les transports et libérer les pistes capturées

N’appelez pas publish pour un participant en réception uniquement. Évitez les actions de publication en double dans votre interface utilisateur. L’audio de l’écran n’est pas capturé par cette fonctionnalitéAPI. Pour arrêter le partage, utilisez la commande « Arrêter le partage » du navigateur. La mise en sourdine n’équivaut pas à quitter la conversation ; appelez close() pour libérer la session et ses périphériques capturés.

Le tenteSDK une reconnexion après des interruptions de signalisation et utilise à nouveau la fonction « token-provider ». Émettez toujours un nouveau jeton après avoir vérifié l’accès ; ne jamais mettre en cache un jeton utilisé. La reconnexion est limitée et peut échouer. Affichez les états de connexion et d’erreur, et proposez un processus de reconnexion contrôlé par l’utilisateur.

Le mode « faible bande passante » réduit la qualité de la vidéo reçue ; il ne peut garantir un appel sur une connexion inutilisable. Envisagez la diffusion audio uniquement lorsque cela est approprié. Le accepte égalementSDK new RtcSession({ iceTransportPolicy: 'relay' }) pour les connexions en relais uniquement, qui nécessitent un service de relais accessible.

Testez les appareils réels, les autorisations de navigateur, les réseaux restreints, le fonctionnement en arrière-plan, le partage d’écran et le comportement de reconnexion avant la mise en production. Les guides Python, Node.js SDKs et MEAN/MERN/MEN restent éléments de la feuille de route.