Zum Inhalt springen
Documentation

RTC-Räume und Web SDK

  1. Erstellen Sie ein Projekt und einen bereichsbezogenen Schlüssel im RTC-Konsole.
  2. Ihr Backend erstellt einen Raum mithilfe der Server API.
  3. Ihre Anwendung authentifiziert einen Benutzer und überprüft dessen Raummitgliedschaft.
  4. Ihr Backend fordert die Zugangsdaten der Teilnehmer für diesen autorisierten Raum an.
  5. Der Client tritt mit diesen Anmeldedaten bei und veröffentlicht Medien, sofern dies zulässig ist.
  6. Ihr Backend beendet den Raum, sobald die Sitzung beendet ist.

Ihre Endnutzer erhalten den Projekt-SchlüsselAPI nicht. Sie bleiben verantwortlich für die Identität der Anwendung, die Mitgliedschaft, die Einwilligung und die Benutzeroberfläche.

Terminal-Fenster
# 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}'

Speichern Sie die zurückgegebenen id in der Raumaufzeichnung Ihrer Anwendung stummschalten oder die Stummschaltung aufheben. maxParticipants muss sowohl der aktuellen APIEinschränkung als auch dem zulässigen Umfang des aktiven Plans entsprechen. Wiederholen Sie die Raumerstellung nach einem mehrdeutigen Timeout nicht automatisch: Die erste Anfrage könnte erfolgreich gewesen sein. Überprüfen Sie zunächst die Liste.

Nach Überprüfung der Zugriffsrechte Ihres Nutzers sendet Ihr Backend:

Terminal-Fenster
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}'

Die Antwort enthält token, participantId, expiresIn, url, und iceServers. Leiten Sie diesen Anmeldedatensatz über Ihren eigenen authentifizierten Endpunkt mit deaktiviertem Caching an den autorisierten Client weiter. Behandeln Sie alle diese Daten als vertraulich. Anmeldedaten für den Beitritt verfallen nach fünf Minuten und können nach einem erfolgreichen Beitritt nicht mehr wiederverwendet werden. Dies bezieht sich nicht auf eine maximale Gesprächsdauer von fünf Minuten.

Verwenden Sie die unterstützte JavaScript/TypeScript-WebverteilungSDK. Kontakt CHAMPREP für den Zugriff auf das Paket und Installationsanweisungen. Installieren Sie kein gleichnamiges Paket eines Drittanbieters. Das folgende Beispiel geht davon aus, dass Sie bereits über das bereitgestellte RtcSession Klasse in Ihrer Anwendung. Der Importpfad hängt von der jeweiligen Distribution ab.

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

Die Funktionen für die Medienwiedergabe und die Fehlerbehandlung sind anwendungsspezifische Platzhalter. Verknüpfen Sie jeden zurückgegebenen Stream mit dem entsprechenden Audio- oder Video- Element, schalten Sie Ihre lokale Vorschau stumm und stellen Sie playsInline für Video und behandeln Sie die Ablehnung der automatischen Wiedergabe mit einer vom Benutzer aktivierten Wiedergabesteuerung. Eine Remote-Audiospur benötigt ein audiofähiges Element, auch wenn kein Video vorhanden ist.

MethodeVerhalten
connect(tokenProvider)Teilnahme über eine Funktion, die aktuelle Anmeldedaten zurückgibt
publish(true)Mikrofon und Kamera anfordern und deren Tonspuren veröffentlichen
publish(false)Mikrofon-Audio ohne Kamera-Video veröffentlichen
setMuted(true) / setMuted(false)Den Mikrofon-Produzenten stummschalten oder die Stummschaltung aufheben
setCamera(false) / setCamera(true)Deaktivieren oder aktivieren Sie den Kamera-Producer
shareScreen()Öffnen Sie die Browser-Auswahl und veröffentlichen Sie eine reine Video-Bildschirmaufzeichnung
setReceiveQuality('low')Fordern Sie empfangene Videos in geringerer Qualität an
setReceiveQuality('auto')Stellen Sie die normalen Einstellungen für empfangene Videos wieder her
close()Verlassen, Transporte schließen und erfasste Spuren freigeben

Rufen Sie nicht publish für einen Teilnehmer, der nur empfangen kann. Verhindern Sie doppelte Veröffentlichungsaktionen in Ihrer Benutzeroberfläche. Bildschirm-Audio wird dabei nicht erfasstAPI. Um die Freigabe zu beenden, verwenden Sie die Schaltfläche „Freigabe beenden“ des Browsers. Das Stummschalten ist nicht gleichbedeutend mit dem Verlassen des Anrufs; Anruf close() um die Sitzung und die damit verbundenen Geräte freizugeben.

Das SDK versuchtSDK nach Signalisierungsunterbrechungen eine erneute Verbindung herzustellen und nutzt dabei erneut die Token-Provider-Funktion. Geben Sie stets ein neu Token nach Überprüfung des Zugriffs ausstellen; speichern Sie ein verbrauchtes Token niemals im Cache. Die Wiederherstellung der Verbindung ist begrenzt und kann fehlschlagen. Zeigen Sie Verbindungs- und Fehlerstatus an und bieten Sie einen vom Benutzer gesteuerten Ablauf zur Wiederherstellung der Verbindung an.

Der Modus für geringe Bandbreite verringert die Qualität des empfangenen Videos; er kann keinen Anruf über eine unbrauchbare Verbindung garantieren. Ziehen Sie gegebenenfalls die Veröffentlichung nur von Audio in Betracht. Das akzeptiert zudemSDK new RtcSession({ iceTransportPolicy: 'relay' }) für reine Relay-Verbindungen, für die ein erreichbarer Relay-Dienst erforderlich ist.

Testen Sie vor der Veröffentlichung echte Geräte, Browserberechtigungen, eingeschränkte Netzwerke, den Hintergrundbetrieb, die Bildschirmfreigabe und das Verhalten bei der Wiederverbindung. Die Anleitungen für Python, Node.js SDKs sowie MEAN/MERN/MEN bleiben bestehen Roadmap-Elemente.