Moderation — REST

Erzwingen der Trennung eines Client-Endpunkts von einer Sitzung

Zusätzlich zur Verwaltung verbundener Client-Endpunkte über das OpenTok.js-SDK können App-Server serverseitig einen HTTP-DELETE-Befehl auslösen, um einen verbundenen Client zur Trennung von einer Sitzung zu zwingen.

Ihr Anwendungsserver kann einen Client von einer OpenTok-Sitzung trennen, indem er eine HTTP-DELETE-Anfrage an die Ressource für die Verbindung dieses Clients sendet:

SESSION_ID=SOME_SESSION_ID CONNECTION_ID=SOME_CONNECTION_ID API_KEY=123456 API_SECRET=ABCDEF1234567890 curl -v \ -X DELETE \ -H "X-OPENTOK-AUTH:JSON_WEB_TOKEN" \ https://api.opentok.com/v2/project/${API_KEY}/session/${SESSION_ID}/connection/${CONNECTION_ID}

Weitere Informationen finden Sie in der OpenTok REST-API-Dokumentation.

Streams in einer Sitzung zwangsweise stummschalten, um veröffentlichtes Audio zu unterdrücken

Sie können die OpenTok REST API um einen Sender eines bestimmten Streams dazu zu zwingen, seinen übertragenen Ton stummzuschalten:

SESSION_ID=SOME_SESSION_ID STREAM_ID=SOME_STREAM_ID API_KEY=123456 API_SECRET=ABCDEF1234567890 JWT=jwt_token curl -v \ -X POST \ -H "X-OPENTOK-AUTH:JSON_WEB_TOKEN" \ https://api.opentok.com/v2/project/${API_KEY}/session/${SESSION_ID}/stream/${STREAM_ID}/mute

Sie können die OpenTok REST API um alle Streams (mit Ausnahme einer optionalen Liste von Streams) in einer Sitzung dazu zu zwingen, das veröffentlichte Audio stummzuschalten:

SESSION_ID=SOME_SESSION_ID DATA='{"excludedStreamIds": ["excludedStreamId1", "excludedStreamId2"], "active": true}' API_KEY=123456 API_SECRET=ABCDEF1234567890 curl -v \ -H "Content-Type: application/json" \ -X POST \ -H "X-OPENTOK-AUTH:JSON_WEB_TOKEN" \ https://api.opentok.com/v2/project/${API_KEY}/session/${SESSION_ID}/mute

Die JSON-Daten enthalten die folgenden Eigenschaften:

  • active (Boolescher Wert, erforderlich) — Gibt an, ob die Streams in der Sitzung stummgeschaltet werden sollen (true) und den Stummschaltungsstatus der Sitzung aktivieren oder den Stummschaltungsstatus der Sitzung deaktivieren (false). Wenn der Stummschaltungsmodus aktiviert ist (true), alle aktuellen und zukünftigen Streams, die in der Sitzung veröffentlicht werden (mit Ausnahme der Streams im excludedStreamIds array) werden stummgeschaltet. Wenn Sie diese Methode mit dem active Eigenschaft eingestellt auf false, werden zukünftige Streams, die in der Sitzung veröffentlicht werden, nicht stummgeschaltet (bereits stummgeschaltete Streams bleiben jedoch weiterhin stummgeschaltet).

  • excludedStreamIds (Zeichenfolgen-Array, optional) — Die Stream-IDs der Streams, die nicht stummgeschaltet werden sollen. Dies ist eine optionale Eigenschaft. Wenn Sie diese Eigenschaft weglassen, werden alle Streams in der Sitzung stummgeschaltet. Diese Eigenschaft gilt nur, wenn die active Eigenschaft wird auf true. Wenn die active Eigenschaft wird auf false, wird es ignoriert.

Um den Stummschaltstatus der Sitzung aufzuheben (damit zukünftige Streams nicht mehr stummgeschaltet werden), rufen Sie die Methode erneut mit dem active Eigenschaft eingestellt auf false:

SESSION_ID=SOME_SESSION_ID DATA='{"active": false}' API_KEY=123456 API_SECRET=ABCDEF1234567890 curl -v \ -H "Content-Type: application/json" \ -X POST \ -H "X-OPENTOK-AUTH:JSON_WEB_TOKEN" \ https://api.opentok.com/v2/project/${API_KEY}/session/${SESSION_ID}/mute