com.opentok.OpenTok
public class OpenTok extends Objekt
Enthält Methoden zum Erstellen von OpenTok-Sitzungen, zum Generieren von Tokens und zum Arbeiten mit Archiven.
Um ein neues OpenTok-Objekt zu erstellen, rufen Sie den OpenTok-Konstruktor mit Ihrem OpenTok-API-Schlüssel und dem API-Geheimnis für Ihr Vonage Video API-Konto. Geben Sie Ihr API-Geheimnis nicht öffentlich weiter. Sie verwenden es mit dem OpenTok-Konstruktor (ausschließlich auf Ihrem Webserver ), um OpenTok-Sitzungen zu erstellen.
Stellen Sie sicher, dass das gesamte OpenTok-Server-SDK auf Ihrem Webserver installiert ist.
Zusammenfassung zu verschachtelten Klassen
Verschachtelte Klassen
Modifikator und Typ
Klasse
Beschreibung
static class
OpenTok.Builder
Dient zur Erstellung eines OpenTok-Objekts mit erweiterten Einstellungen.
Zusammenfassung zum Konstruktor
Konstruktoren
Konstruktor
Beschreibung
OpenTok(int apiKey, String apiSecret)
Erstellt ein OpenTok-Objekt.
OpenTok(String applicationId, Path privateKeyPath)
Erstellt ein OpenTok-Objekt zur Verwendung mit dem Vonage Video API.
Zusammenfassung der Methode
Alle MethodenInstanzmethodenKonkrete Methoden
Modifikator und Typ
Methode
Beschreibung
void
addArchiveStream(String archiveId, String streamId, boolean hasAudio, boolean hasVideo)
Fügt einen Stream zu einem OpenTok-Archiv hinzu.
void
addBroadcastStream(String broadcastId, String streamId, boolean hasAudio, boolean hasVideo)
Fügt einen Stream zu einer Opentok-Übertragung hinzu.
void
close()
Rufen Sie diese Methode auf, wenn Sie die Verwendung des OpenTok-Objekts beendet haben, um zu verhindern, dass Dateideskriptoren offen bleiben.
AudioConnector
connectAudioStream(String sessionId, String token, AudioConnectorProperties properties)
Audio aus einer Vonage Video API-Sitzung an einen WebSocket senden.
Session
createSession()
Erstellt eine OpenTok-Sitzung mit den Standardeinstellungen:
Session
createSession(SessionProperties properties)
Erstellt eine neue OpenTok-Sitzung.
void
deleteArchive(String archiveId)
Löscht ein OpenTok-Archiv.
Sip
dial(String sessionId, String token, SipProperties properties)
Ruft ein SIP-Gateway an, um eine Verbindung zu einer OpenTok-Sitzung herzustellen.
void
disableForceMute(String sessionId)
Hebt den aktiven Stummschaltstatus der Sitzung auf.
void
forceDisconnect(String sessionId, String connectionId)
Einen Client von einer OpenTok-Sitzung trennen
void
forceMuteAll(String sessionId, MuteAllProperties properties)
Zwingt alle Streams (mit Ausnahme eines optionalen Arrays von Streams) in einer Sitzung dazu, das veröffentlichte Audio stummzuschalten.
void
forceMuteStream(String sessionId, String streamId)
Den Betreiber eines bestimmten Streams dazu zwingen, den Ton stummzuschalten.
String
generateToken(String sessionId)
Erstellt ein Token für die Verbindung zu einer OpenTok-Sitzung unter Verwendung der Standardeinstellungen.
String
generateToken(String sessionId, TokenOptions tokenOptions)
Erstellt ein Token für die Verbindung zu einer OpenTok-Sitzung.
Archive
getArchive(String archiveId)
Ruft einen Archive Objekt für die angegebene Archiv-ID.
Broadcast
getBroadcast(String broadcastId)
Ruft einen Broadcast Objekt für die angegebene Broadcast-ID.
Render
getRender(String renderId)
Ruft ein Render-Objekt ab, das Details zu einem Experience Composer enthält.
Stream
getStream(String sessionId, String streamId)
Ruft einen Stream Objekt für die angegebene Sitzungs-ID und Stream-ID.
ArchiveList
listArchives()
Gibt eine Liste von Archive Objekte, die Archive darstellen, die sowohl
bereits abgeschlossen als auch noch in Bearbeitung sind, für Ihren API-Schlüssel.
ArchiveList
listArchives(int offset, int count)
Gibt eine Liste von Archive Objekte, die Archive darstellen, die sowohl
bereits abgeschlossen als auch noch in Bearbeitung sind, für Ihren API-Schlüssel.
ArchiveList
listArchives(String sessionId)
Gibt eine Liste von Archive Objekte, die Archive darstellen, die sowohl
bereits abgeschlossen als auch noch in Bearbeitung sind, für Ihren API-Schlüssel.
ArchiveList
listArchives(String sessionId, int offset, int count)
Gibt eine Liste von Archive Objekte, die Archive darstellen, die sowohl
bereits abgeschlossen als auch noch in Bearbeitung sind, für Ihren API-Schlüssel.
List<Render>
listRenders()
Ruft eine Liste von Render-Objekten ab, die die mit dem OpenTok-Projekt verknüpften Experience Composers darstellen.
List<Render>
listRenders(Integer offset, Integer count)
Ruft eine Liste von Render-Objekten ab, die eine Liste der Experience Composers darstellen, die dem OpenTok-Projekt zugeordnet sind.
StreamList
listStreams(String sessionId)
Ruft eine Liste von Stream Objekte für die angegebene Sitzungs-ID.
void
playDTMF(String sessionId, String dtmfDigits)
DTMF-Ziffern an alle Clients in einer Sitzung senden.
void
playDTMF(String sessionId, String connectionId, String dtmfDigits)
DTMF-Ziffern an einen bestimmten Client in einer Sitzung senden.
void
removeArchiveStream(String archiveId, String streamId)
Entfernt einen Stream aus einem Opentok-Archiv.
void
removeBroadcastStream(String broadcastId, String streamId)
Entfernt einen Stream aus einer Opentok-Übertragung.
void
setArchiveLayout(String archiveId, ArchiveProperties properties)
Legt den Layouttyp für ein zusammengesetztes Archiv fest.
void
setBroadcastLayout(String broadcastId, BroadcastProperties properties)
Legt den Layouttyp für die Sendung fest.
void
setStreamLayouts(String sessionId, StreamListProperties properties)
Legt die Liste der Layoutklassen für Streams in einer Sitzung fest.
void
signal(String sessionId, SignalProperties props)
Sendet ein Signal an alle Clients, die mit einer Sitzung verbunden sind.
void
signal(String sessionId, String connectionId, SignalProperties props)
Sendet ein Signal an einen bestimmten Client, der mit einer Sitzung verbunden ist.
Archive
startArchive(String sessionId)
Archive
startArchive(String sessionId, ArchiveProperties properties)
Beginnt mit der Archivierung einer OpenTok-Sitzung.
Archive
startArchive(String sessionId, String name)
Broadcast
startBroadcast(String sessionId, BroadcastProperties properties)
Startet eine Live-Streaming-Übertragung für eine OpenTok-Sitzung.
Caption
startCaptions(String sessionId, String token, CaptionProperties properties)
Verwenden Sie die Live Captions API, um Audiostreams zu transkribieren und Echtzeit-Untertitel für Ihre Anwendung zu generieren.
Render
startRender(String sessionId, String token, RenderProperties properties)
Startet einen Experience Composer-Render für eine OpenTok-Sitzung.
Archive
stopArchive(String archiveId)
Beendet die Aufzeichnung eines OpenTok-Archivs, das gerade aufgezeichnet wird.
Broadcast
stopBroadcast(String broadcastId)
Beendet eine Live-Streaming-Übertragung einer OpenTok-Sitzung.
void
stopCaptions(String captionsId)
Verwenden Sie diese Methode, um die Live-Untertitel für eine Sitzung zu deaktivieren.
void
stopRender(String renderId)
Beendet einen Experience Composer einer OpenTok-Sitzung.
Von der Klasse „java.lang.“ geerbte Methoden.Objekt
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Angaben zum Hersteller
OpenTok
public OpenTok(int apiKey, Zeichenfolge apiSecret)
Erstellt ein OpenTok-Objekt.
Parameter:
: apiKey - Ihr OpenTok-API-Schlüssel. (Siehe Ihre Vonage Video API Account-Seite.)
: apiSecret - Ihr OpenTok-API-Schlüssel. (Siehe Ihre Vonage Video API Account-Seite.)
OpenTok
public OpenTok(Zeichenfolge applicationId, Pfad privateKeyPath)
Erstellt ein OpenTok-Objekt zur Verwendung mit dem Vonage Video API. Dies ist als kurzfristiger Schritt auf dem Weg zur vollständigen Umstellung auf Vonage gedacht. Siehe die Leitfaden zur Umstellung auf das Java SDK Weitere Informationen.
Parameter:
: applicationId - Die UUID Ihrer Vonage-Application, bei der die Videofunktionen aktiviert sind. privateKeyPath - Der absolute Pfad zum privaten Schlüssel Ihrer Anwendung.
Seit: : 4.15.0
Details zur Methode
generateToken
öffentlich Zeichenfolge generateToken(Zeichenfolge sessionId, Token-Optionen tokenOptions) wirft eine Ausnahme OpenTokException
Erstellt ein Token für die Verbindung zu einer OpenTok-Sitzung. Um einen Benutzer zu authentifizieren, der eine Verbindung zu einer OpenTok-Sitzung herstellt, übermittelt der Client bei der Verbindung zur Sitzung ein Token.
Das folgende Beispiel zeigt, wie man ein Token abruft, das die Rolle „Abonnent“ hat und eine Metadatenzeichenfolge für die Verbindung enthält:
import com.opentok.Role;
import com.opentok.TokenOptions;
class Test {
public static void main(String args[]) throws OpenTokException {
int API_KEY = 0; // Replace with your OpenTok API key (see https://tokbox.com/account).
String API_SECRET = ""; // Replace with your OpenTok API secret.
OpenTok sdk = new OpenTok(API_KEY, API_SECRET);
//Generate a basic session. Or you could use an existing session ID.
String sessionId = System.out.println(sdk.createSession());
// Replace with meaningful metadata for the connection.
String connectionMetadata = "username=Bob,userLevel=4";
// Use the Role value appropriate for the user.
String role = Role.SUBSCRIBER;
// Generate a token:
TokenOptions options = new TokenOptions.Buider().role(role).data(connectionMetadata).build();
String token = sdk.generateToken(sessionId, options);
System.out.println(token);
}
}
Zu Testzwecken können Sie Tokens auch generieren, indem Sie sich bei Ihrem Vonage Video API-Konto.
Parameter:
: sessionId - Die Sitzungs-ID der Sitzung, mit der sich der Benutzer verbinden wird.
: tokenOptions - Dieses „TokenOptions“-Objekt definiert Optionen für das Token.
Dazu gehören die folgenden:
- The role of the token (subscriber, publisher, or moderator)
- The expiration time of the token
- Connection data describing the end-user
Rückgabewert: : Die Token-Zeichenkette.
Würfe:
: OpenTokException
generateToken
öffentlich Zeichenfolge generateToken(Zeichenfolge sessionId) throws OpenTokException
Erstellt ein Token für die Verbindung zu einer OpenTok-Sitzung unter Verwendung der Standardeinstellungen. Die Standardeinstellungen lauten wie folgt:
- Dem Token wird die Rolle des Herausgebers zugewiesen.
- Das Token läuft 24 Stunden nach seiner Erstellung ab.
- Das Token enthält keine Verbindungsdaten.
Das folgende Beispiel zeigt, wie man ein Token mit den Standardeinstellungen generiert:
import com.opentok.OpenTok;
class Test {
public static void main(String argv[]) throws OpenTokException {
int API_KEY = 0; // Replace with your OpenTok API key (see https://tokbox.com/account).
String API_SECRET = ""; // Replace with your OpenTok API secret.
OpenTok sdk = new OpenTok(API_KEY, API_SECRET);
//Generate a basic session. Or you could use an existing session ID.
String sessionId = System.out.println(sdk.createSession().getSessionId());
String token = sdk.generateToken(sessionId);
System.out.println(token);
}
}
Parameter:
: sessionId - Die Sitzungs-ID der Sitzung, mit der sich der Benutzer verbinden wird.
Rückgabewert: : Die Token-Zeichenkette.
Würfe:
: OpenTokException
Siehe auch:
: - generateToken(String, TokenOptions)
createSession
öffentlich Sitzung createSession(Sitzungseigenschaften Eigenschaften) löst aus OpenTokException
Erstellt eine neue OpenTok-Sitzung.
Wenn Sie beispielsweise die OpenTok.js-Bibliothek verwenden, geben Sie beim Aufruf der OT.initSession() Methode (zum Initialisieren einer OpenTok-Sitzung).
OpenTok-Sitzungen laufen nicht ab. Authentifizierungstoken verfallen jedoch (siehe die
generateToken(String, TokenOptions) Methode). Beachten Sie außerdem, dass Sitzungen nicht
explizit beendet werden können.
Eine Sitzungs-ID-Zeichenkette kann bis zu 255 Zeichen lang sein.
Der Aufruf dieser Methode führt zu einem OpenTokException im
Falle eines Fehlers. Weitere Informationen finden Sie in der Fehlermeldung.
Der folgende Code erstellt eine Sitzung, die versucht, Streams direkt zwischen Clients zu übertragen (wobei auf den OpenTok-TURN-Server zurückgegriffen wird, um Streams weiterzuleiten, falls die Clients keine Verbindung herstellen können):
import com.opentok.MediaMode;
import com.opentok.OpenTok;
import com.opentok.Session;
import com.opentok.SessionProperties;
class Test {
public static void main(String argv[]) throws OpenTokException {
int API_KEY = 0; // Replace with your OpenTok API key.
String API_SECRET = ""; // Replace with your OpenTok API secret.
OpenTok sdk = new OpenTok(API_KEY, API_SECRET);
SessionProperties sp = new SessionProperties().Builder()
.mediaMode(MediaMode.RELAYED).build();
Session session = sdk.createSession(sp);
System.out.println(session.getSessionId());
}
}
Sie können eine Sitzung auch mithilfe der OpenTok REST-API oder indem Sie sich bei Ihrem Vonage Video API-Konto.
Parameter:
: properties - Dieses „SessionProperties“-Objekt definiert Optionen für die Sitzung.
Dazu gehören die folgenden:
- Whether the session's streams will be transmitted directly between peers or
using the OpenTok Media Router.
- A location hint for the location of the OpenTok server to use for the session.
Rückgabewerte:
: Ein Session-Objekt, das die neue Sitzung repräsentiert. Rufen Sie die getSessionId()
Methode des Session-Objekts, um die Sitzungs-ID abzurufen, die die
Sitzung eindeutig identifiziert. Diese Sitzungs-ID verwenden Sie in den Client-SDKs, um die Sitzung zu identifizieren.
Würfe:
: OpenTokException
createSession
öffentlich Sitzung createSession() löst einen Fehler aus OpenTokException
Erstellt eine OpenTok-Sitzung mit den Standardeinstellungen:
- Der Medienmodus ist „Relay“. Die Sitzung versucht, Streams direkt zwischen den Clients zu übertragen. Wenn zwei Clients aufgrund von Firewalls in den Netzwerken der Clients die Streams des jeweils anderen nicht senden und empfangen können, werden ihre Streams über den OpenTok-TURN-Server weitergeleitet.
- Die Sitzung ermittelt anhand des ersten Clients, der eine Verbindung herstellt, den Standort des zu verwendenden OpenTok-Servers.
Im folgenden Beispiel wird eine Sitzung mit den Standardeinstellungen erstellt:
import com.opentok.OpenTok;
import com.opentok.SessionProperties;
class Test {
public static void main(String argv[]) throws OpenTokException {
int API_KEY = 0; // Replace with your OpenTok API key.
String API_SECRET = ""; // Replace with your OpenTok API secret.
OpenTok sdk = new OpenTok(API_KEY, API_SECRET);
String sessionId = sdk.createSession();
System.out.println(sessionId);
}
}
Rückgabewerte:
: Ein Session-Objekt, das die neue Sitzung repräsentiert. Rufen Sie die getSessionId()
Methode des Session-Objekts, um die Sitzungs-ID abzurufen, die die
Sitzung eindeutig identifiziert. Diese Sitzungs-ID verwenden Sie in den Client-SDKs, um die Sitzung zu identifizieren.
Würfe:
: OpenTokException
Siehe auch:
: - createSession(SessionProperties)
Signal
public void signal(Zeichenfolge sessionId, Signaleigenschaften Requisiten) wirft OpenTokException
Sendet ein Signal an alle Clients, die mit einer Sitzung verbunden sind.
Weitere Informationen finden Sie in der Entwicklerhandbuch zu Signaling.
Parameter:
: sessionId - Die Sitzungs-ID.
: props - Das SignalProperties-Objekt, das die Daten und den Typ des Signals definiert.
Würfe:
: OpenTokException
Signal
public void signal(Zeichenfolge sessionId, Zeichenfolge connectionId, Signaleigenschaften Requisiten) wirft OpenTokException
Sendet ein Signal an einen bestimmten Client, der mit einer Sitzung verbunden ist.
Weitere Informationen finden Sie in der Entwicklerhandbuch zu Signaling.
Parameter:
: sessionId - Die Sitzungs-ID.
: connectionId - Die Verbindungs-ID des Clients, der das Signal empfangen soll.
: props - Das SignalProperties-Objekt, das die Daten und den Typ des Signals definiert.
Würfe:
: OpenTokException
getArchive
öffentlich Archiv getArchive(Zeichenfolge archiveId) wirft eine Ausnahme OpenTokException
Ruft einen Archive Objekt für die angegebene Archiv-ID.
Parameter:
: archiveId - Die Archiv-ID.
Rückgaben:
: Die Archive Objekt.
Würfe:
: OpenTokException
Liste der Archive
öffentlich Archivliste listArchives() löst einen Fehler aus OpenTokException
Gibt eine Liste von Archive Objekte, die sowohl
abgeschlossene als auch noch in Bearbeitung befindliche Archive für Ihren API-Schlüssel darstellen. Diese Liste ist auf 1000 Archive begrenzt,
beginnend mit dem ersten erfassten Archiv. Um einen bestimmten Bereich von Archiven abzurufen, rufen Sie
listArchives(int offset, int count).
Rückgabewerte:
: Eine Liste von Archive Objekte.
Würfe:
: OpenTokException
Liste der Archive
öffentlich Archivliste listArchives(Zeichenfolge sessionId) throws OpenTokException
Gibt eine Liste von Archive Objekte, die Archive darstellen, die sowohl
bereits abgeschlossen als auch noch in Bearbeitung sind, für Ihren API-Schlüssel.
Parameter:
: sessionId - Die Sitzungs-ID der Sitzung, in der die Archivierung gestartet oder automatisch aktiviert wurde.
Ist die Sitzungs-ID null oder leer, wird sie weggelassen.
Rückgabewerte:
: Eine Liste von Archive Objekte.
Würfe:
: OpenTokException
Liste der Archive
öffentlich Archivliste listArchives(int offset, int count) throws OpenTokException
Gibt eine Liste von Archive Objekte, die Archive darstellen, die sowohl
bereits abgeschlossen als auch noch in Bearbeitung sind, für Ihren API-Schlüssel.
Parameter:
: offset - Der Index-Offset des ersten Archivs. 0 ist der Offset des zuletzt gestarteten
Archivs.
1 ist der Offset des Archivs, das vor dem zuletzt gestarteten Archiv gestartet wurde.
: count - Die Anzahl der zurückzugebenden Archive. Die maximale Anzahl der zurückgegebenen Archive
beträgt 1000.
Rückgabewerte:
: Eine Liste von Archive Objekte.
Würfe:
: OpenTokException
Liste der Archive
öffentlich Archivliste listArchives(Zeichenfolge sessionId, int offset, int count) throws OpenTokException
Gibt eine Liste von Archive Objekte, die Archive darstellen, die sowohl
bereits abgeschlossen als auch noch in Bearbeitung sind, für Ihren API-Schlüssel.
Parameter:
: offset - Der Index-Offset des ersten Archivs. 0 ist der Offset des zuletzt gestarteten
Archivs.
1 ist der Offset des Archivs, das vor dem zuletzt gestarteten Archiv gestartet wurde.
: count - Die Anzahl der zurückzugebenden Archive. Die maximale Anzahl der zurückgegebenen Archive
beträgt 1000.
: sessionId - Die Sitzungs-ID der Sitzung, in der die Archivierung gestartet oder automatisch aktiviert wurde.
Rückgabewerte:
: Eine Liste von Archive Objekte.
Würfe:
: OpenTokException
startArchive
öffentlich Archiv startArchive(Zeichenfolge sessionId, Archiv-Eigenschaften Eigenschaften) löst aus OpenTokException
Beginnt mit der Archivierung einer OpenTok-Sitzung. Diese Version des startArchive() Mit dieser
Methode können Sie die Audio- oder Videoaufzeichnung deaktivieren.
Die Teilnehmer müssen aktiv mit der OpenTok-Sitzung verbunden sein, damit Sie erfolgreich mit der Aufzeichnung eines Archivs beginnen können.
Sie können pro Sitzung jeweils nur ein Archiv aufzeichnen. Sie können nur Archive von Sitzungen aufzeichnen, die den OpenTok Media Router verwenden (Sitzungen mit dem Medienbetrieb (auf „routed“ gesetzt); Sie können keine Sitzungen archivieren, bei denen der Medienmodus auf „relayed“ gesetzt ist.
Weitere Informationen zur Archivierung finden Sie unter OpenTok-Archivierung Leitfaden für Entwickler.
Parameter:
: sessionId - Die Sitzungs-ID der zu archivierenden OpenTok-Sitzung.
: properties - Dieses „ArchiveProperties“-Objekt definiert Optionen für das Archiv.
Rückgabewerte: : Das Archiv-Objekt. Dieses Objekt enthält Eigenschaften, die das Archiv definieren, darunter die Archiv-ID.
Würfe:
: OpenTokException
startArchive
öffentlich Archiv startArchive(Zeichenfolge sessionId) throws OpenTokException
Würfe:
: OpenTokException
startArchive
öffentlich Archiv startArchive(Zeichenfolge sessionId, Zeichenfolge name) throws OpenTokException
Würfe:
: OpenTokException
stopArchive
öffentlich Archiv stopArchive(Zeichenfolge archiveId) wirft eine Ausnahme OpenTokException
Beendet die Aufzeichnung eines OpenTok-Archivs, das gerade aufgezeichnet wird.
Die Aufzeichnung von Archiven wird automatisch nach 120 Minuten beendet oder sobald sich alle Teilnehmer aus der archivierten Sitzung abgemeldet haben.
Parameter:
: archiveId - Die Archiv-ID des Archivs, dessen Aufzeichnung Sie beenden möchten.
Rückgabewerte: : Das „Archive“-Objekt, das dem zu beendenden Archiv entspricht.
Würfe:
: OpenTokException
deleteArchive
public void deleteArchive(Zeichenfolge archiveId) wirft eine Ausnahme OpenTokException
Löscht ein OpenTok-Archiv.
Sie können nur ein Archiv löschen, dessen Status „verfügbar“ oder „hochgeladen“ lautet. Durch das Löschen eines Archivs wird dessen Eintrag aus der Archivliste entfernt. Bei einem „verfügbaren“ Archiv wird zudem die Archivdatei gelöscht, sodass sie nicht mehr zum Herunterladen zur Verfügung steht.
Parameter:
: archiveId - Die Archiv-ID des Archivs, das Sie löschen möchten.
Würfe:
: OpenTokException
addArchiveStream
public void addArchiveStream(Zeichenfolge archiveId, Zeichenfolge streamId, boolean hasAudio, boolean hasVideo) throws OpenTokException
Fügt einen Stream zu einem OpenTok-Archiv hinzu.
Diese Methode funktioniert nur bei einem Archiv, das eine Archive.StreamMode auf
... StreamMode.MANUAL.
Sie können diese Methode wiederholt mit derselben Stream-ID aufrufen, um Audio oder
Video zu aktivieren bzw. zu deaktivieren, je nach hasAudio und hasVideo Parameterwerte.
Parameter:
: archiveId - Die Archiv-ID.
: streamId - Die Stream-ID.
: hasAudio - Ob der Ton des Streams im Archiv aktiviert sein soll.
: hasVideo - Ob für den Stream im Archiv die Videowiedergabe aktiviert sein soll.
Würfe:
: OpenTokException
removeArchiveStream
public void removeArchiveStream(Zeichenfolge archiveId, Zeichenfolge streamId) wirft eine Ausnahme OpenTokException
Entfernt einen Stream aus einem Opentok-Archiv.
Diese Methode funktioniert nur bei einem Archiv, das eine Archive.StreamMode auf
... StreamMode.MANUAL.
Parameter:
: archiveId - Die Archiv-ID.
: streamId - Die Stream-ID.
Würfe:
: OpenTokException
setArchiveLayout
public void setArchiveLayout(Zeichenfolge archiveId, Archiv-Eigenschaften Eigenschaften) löst aus OpenTokException
Legt den Layouttyp für ein zusammengesetztes Archiv fest. Eine Beschreibung der Layouttypen finden Sie unter Anpassung des Video-Layouts für zusammengestellte Archive.
Parameter:
: archiveId - {String} Die Archiv-ID.
: properties - Das „ArchiveProperties“-Objekt, das den Aufbau des Archivs definiert.
Würfe:
: OpenTokException
startBroadcast
öffentlich Sendung startBroadcast(Zeichenfolge sessionId, BroadcastProperties Eigenschaften) löst aus OpenTokException
Startet eine Live-Streaming-Übertragung für eine OpenTok-Sitzung. Dadurch wird die Sitzung als HLS-Stream (HTTP Live Streaming) oder als RTMP-Stream übertragen.
Um die Übertragung einer Sitzung erfolgreich zu starten, muss mindestens ein Client mit der Sitzung verbunden sein.
Pro Sitzung kann jeweils nur eine Live-Streaming-Übertragung aktiv sein (mehrere wären ohnehin nicht sinnvoll). Die Live-Streaming-Übertragung kann pro Sitzung gleichzeitig auf einen HLS-Endpunkt und bis zu fünf RTMP-Server gerichtet sein. Sie können Live-Streaming nur für Sitzungen starten, die den OpenTok Media Router verwenden (wobei der Medienmodus auf „routed“ eingestellt ist); bei Sitzungen, bei denen der Medienmodus auf „relayed OpenTok Media Router“ eingestellt ist, können Sie Live-Streaming nicht nutzen. Siehe Der OpenTok Media Router und die Medienmodi.
Weitere Informationen zum Thema Rundfunk finden Sie unter Leitfaden für Entwickler im Bereich Rundfunk.
Parameter:
: sessionId - Die Sitzungs-ID der OpenTok-Sitzung, die übertragen werden soll.
: properties - Das „BroadcastProperties“-Objekt definiert Optionen für die Übertragung.
Rückgabewerte: : Das Broadcast-Objekt. Dieses Objekt enthält Eigenschaften, die den Broadcast definieren, einschließlich der Broadcast-ID.
Würfe:
: OpenTokException
stopBroadcast
öffentlich Sendung stopBroadcast(Zeichenfolge broadcastId) wirft eine Ausnahme OpenTokException
Beendet eine Live-Streaming-Übertragung einer OpenTok-Sitzung. Beachten Sie, dass Übertragungen 120 Minuten nach ihrem Start automatisch beendet werden.
Weitere Informationen zum Thema Rundfunk finden Sie unter Leitfaden für Entwickler im Bereich Rundfunk.
Parameter:
: broadcastId - Die Übertragungs-ID der Übertragungssitzung
Rückgabewerte: : Das Broadcast-Objekt. Dieses Objekt enthält Eigenschaften, die das Archiv definieren, darunter die Archiv-ID.
Würfe:
: OpenTokException
getBroadcast
öffentlich Sendung getBroadcast(Zeichenfolge broadcastId) wirft eine Ausnahme OpenTokException
Ruft einen Broadcast Objekt für die angegebene Broadcast-ID.
Parameter:
: broadcastId - Die Sendungs-ID.
Rückgaben:
: Die Broadcast Objekt.
Würfe:
: OpenTokException
setBroadcastLayout
public void setBroadcastLayout(Zeichenfolge broadcastId, BroadcastProperties Eigenschaften) löst aus OpenTokException
Legt den Layouttyp für die Sendung fest. Eine Beschreibung der Layouttypen finden Sie unter Konfigurieren des Video-Layouts für OpenTok-Live-Streaming-Übertragungen.
Parameter:
: broadcastId - {String} Die Broadcast-ID.
: properties - Dieses „BroadcastProperties“-Objekt, das die Layout-Optionen für
die Sendung definiert.
Würfe:
: OpenTokException
addBroadcastStream
public void addBroadcastStream(Zeichenfolge broadcastId, Zeichenfolge streamId, boolean hasAudio, boolean hasVideo) throws OpenTokException
Fügt einen Stream zu einer Opentok-Übertragung hinzu.
Diese Methode funktioniert nur bei einem Archiv, das eine Archive.StreamMode auf
... StreamMode.MANUAL.
Sie können diese Methode wiederholt mit derselben Stream-ID aufrufen, um Audio oder
Video zu aktivieren bzw. zu deaktivieren, je nach hasAudio und hasVideo Parameterwerte.
Parameter:
: broadcastId - Die Sendungs-ID.
: streamId - Die Stream-ID.
: hasAudio - Ob der Ton des Streams während der Übertragung aktiviert sein soll.
: hasVideo - Ob für den Stream die Videoübertragung aktiviert sein soll.
Würfe:
: OpenTokException
removeBroadcastStream
public void removeBroadcastStream(Zeichenfolge broadcastId, Zeichenfolge streamId) wirft eine Ausnahme OpenTokException
Entfernt einen Stream aus einer Opentok-Übertragung.
Diese Methode funktioniert nur bei einem Archiv, das eine Archive.StreamMode auf
... StreamMode.MANUAL.
Parameter:
: broadcastId - Die Sendungs-ID.
: streamId - Die Stream-ID.
Würfe:
: OpenTokException
setStreamLayouts
public void setStreamLayouts(Zeichenfolge sessionId, StreamListProperties Eigenschaften) löst aus OpenTokException
Legt die Liste der Layoutklassen für Streams in einer Sitzung fest. Layoutklassen werden im Layout für zusammengesetzte Archive und Live-Streaming-Übertragungen verwendet. Weitere Informationen finden Sie unter Anpassung des Video-Layouts für zusammengestellte Archive und Konfigurieren des Video-Layouts für OpenTok-Live-Streaming-Übertragungen.
Sie können die anfängliche Liste der Layout-Klassen für von einem Client veröffentlichte Streams festlegen, wenn Sie
die vom Client verwendeten Streams generieren. Weitere Informationen finden Sie unter generateToken(String, TokenOptions) Methode.
Parameter:
: sessionId - {String} Die Sitzungs-ID der Sitzung, zu der die Streams gehören.
: properties - Dieses „StreamListProperties“-Objekt definiert Klassenlisten für einen oder mehrere
Streams in der Sitzung.
Würfe:
: OpenTokException
forceDisconnect
public void forceDisconnect(Zeichenfolge sessionId, Zeichenfolge connectionId) wirft eine Ausnahme OpenTokException
Einen Client von einer OpenTok-Sitzung trennen
Verwenden Sie diese API, um eine Verbindung einer Sitzung zwangsweise zu beenden.
Parameter:
: sessionId - Die Sitzungs-ID der Verbindung
: connectionId - Die Verbindungs-ID, die getrennt werden soll
Würfe:
: OpenTokException
forceMuteStream
public void forceMuteStream(Zeichenfolge sessionId, Zeichenfolge streamId) wirft eine Ausnahme OpenTokException
Den Betreiber eines bestimmten Streams dazu zwingen, den Ton stummzuschalten.
Weitere Informationen finden Sie unter Stummschalten des Tons von Streams in einer Sitzung.
Parameter:
: sessionId - Die Sitzungs-ID.
: streamId - Die Stream-ID.
Würfe:
: OpenTokException
Siehe auch:
: - forceMuteAll(String, MuteAllProperties)
forceMuteAll
public void forceMuteAll(Zeichenfolge sessionId, Alle Eigenschaften stummschalten Eigenschaften) löst aus OpenTokException
Zwingt alle Streams (mit Ausnahme eines optionalen Arrays von Streams) in einer Sitzung dazu, das veröffentlichte Audio stummzuschalten.
Zusätzlich zu den bereits bestehenden Streams werden alle Streams, die nach dem Aufruf
dieser Methode veröffentlicht werden, mit stummgeschaltetem Ton veröffentlicht. Sie können den Stummschaltungsstatus
einer Sitzung aufheben, indem Sie die Methode OpenTok.disableForceMute() Methode.
Weitere Informationen finden Sie unter Stummschalten des Tons von Streams in einer Sitzung.
Parameter:
: sessionId - Die Sitzungs-ID.
: properties - Definiert eine Liste von Stream-IDs für Streams, die
von der Stummschaltungsaktion ausgeschlossen werden sollen.
Würfe:
: OpenTokException
Siehe auch:
: - forceMuteStream(String, String)
- disableForceMute(String)
disableForceMute
public void disableForceMute(Zeichenfolge sessionId) throws OpenTokException
Hebt den aktiven Stummschaltungsstatus der Sitzung auf. Nachdem Sie diese Methode aufgerufen haben, wird bei neuen Streams, die in der Sitzung veröffentlicht werden, der Ton nicht mehr stummgeschaltet.
Nachdem Sie die OpenTok.forceMuteAll() Methode,
werden alle nach dem Aufruf veröffentlichten Streams mit stummgeschaltetem Ton veröffentlicht. Wenn Sie die
OpenTok.disableForceMute() Mit dieser Methode werden künftig an die Sitzung übermittelte Streams
nicht stummgeschaltet (bereits stummgeschaltete Streams bleiben jedoch weiterhin stummgeschaltet).
Parameter:
: sessionId - Die Sitzungs-ID.
Würfe:
: OpenTokException
Siehe auch:
: - forceMuteAll(String, MuteAllProperties)
getStream
öffentlich Stream getStream(Zeichenfolge sessionId, Zeichenfolge streamId) wirft eine Ausnahme OpenTokException
Ruft einen Stream Objekt für die angegebene Sitzungs-ID und Stream-ID.
Parameter:
: sessionId - Die Sitzungs-ID.
: streamId - Die Stream-ID.
Rückgaben:
: Die Stream Objekt.
Würfe:
: OpenTokException
listStreams
öffentlich StreamList listStreams(Zeichenfolge sessionId) throws OpenTokException
Ruft eine Liste von Stream Objekte für die angegebene Sitzungs-ID.
Parameter:
: sessionId - Die Sitzungs-ID.
Rückgabewerte:
: Die Liste der Stream Objekte.
Würfe:
: OpenTokException
Wählscheibe
öffentlich Nippen dial(Zeichenfolge sessionId, Zeichenfolge Token, SipProperties Eigenschaften) löst aus OpenTokException
Ruft ein SIP-Gateway an, um eine Verbindung zu einer OpenTok-Sitzung herzustellen.
Parameter:
: sessionId - Die Sitzungs-ID.
: token - OpenTok-Token, der für den angerufenen Teilnehmer verwendet werden soll. Sie können Token-Daten hinzufügen,
um festzustellen, ob sich der Teilnehmer an einem SIP-Endpunkt befindet, oder um andere identifizierende Daten,
wie beispielsweise Telefonnummern, anzugeben. (Die OpenTok-Client-Bibliotheken enthalten Eigenschaften zur Überprüfung
der Verbindungsdaten eines mit einer Sitzung verbundenen Clients.) Siehe die
Entwicklerhandbuch zur Token-Erstellung.
: properties - Die SipProperties Objekt, das Optionen für den SIP-Anruf definiert.
Rückgaben:
: Die Sip Objekt.
Würfe:
: OpenTokException
playDTMF
public void playDTMF(Zeichenfolge sessionId, Zeichenfolge dtmfDigits) löst einen Fehler aus OpenTokException
DTMF-Ziffern an alle Clients in einer Sitzung senden.
Parameter:
: sessionId - Die Sitzungs-ID.
: dtmfDigits - Die zu sendende Folge von DTMF-Ziffern. Diese kann die Ziffern 0–9, „*“, „#“
und „p“ enthalten. Ein „p“ steht für eine Pause von 500 ms (falls Sie beim Senden der Ziffern eine Verzögerung einfügen möchten).
Würfe:
: OpenTokException
playDTMF
public void playDTMF(Zeichenfolge sessionId, Zeichenfolge connectionId, Zeichenfolge dtmfDigits) löst einen Fehler aus OpenTokException
DTMF-Ziffern an einen bestimmten Client in einer Sitzung senden.
Parameter:
: sessionId - Die Sitzungs-ID.
: connectionId - Die Sitzungs-ID des Clients, der die DTMF-Ziffern empfangen soll.
: dtmfDigits - Die zu sendende Folge von DTMF-Ziffern. Diese kann die Ziffern 0–9, „*“, „#“
und „p“ enthalten. Ein „p“ steht für eine Pause von 500 ms (falls Sie beim Senden der Ziffern eine Verzögerung einfügen möchten).
Würfe:
: OpenTokException
connectAudioStream
öffentlich AudioConnector connectAudioStream(Zeichenfolge sessionId, Zeichenfolge Token, AudioConnector-Eigenschaften Eigenschaften) löst aus OpenTokException
Senden Sie Audio aus einer Vonage Video API-Sitzung an einen WebSocket. Weitere Informationen finden Sie unter Audio Connector Entwicklerhandbuch.
Parameter:
: sessionId - Die Sitzungs-ID.
: token - Das OpenTok-Token, das für die Verbindung des Audio Connectors zur
OpenTok-Sitzung verwendet werden soll. Sie können Token-Daten hinzufügen, um zu kennzeichnen, dass es sich bei der Verbindung
um den Endpunkt des Audio Connectors handelt, oder um andere identifizierende Daten anzugeben.
: properties - Das ConnectProperties-Objekt definiert Optionen, die in der Anfrage
an den Endpunkt der Audio Connector-API verwendet werden.
Rückgabewerte: : Das „Audio Connect“-Antwortobjekt vom Server.
Würfe:
: OpenTokException
startRender
öffentlich Rendering startRender(Zeichenfolge sessionId, Zeichenfolge Token, Render-Eigenschaften Eigenschaften) löst aus OpenTokException
Startet einen Experience Composer-Render für eine OpenTok-Sitzung. Weitere Informationen finden Sie unter Entwicklerhandbuch zu Experience Composer.
Parameter:
: sessionId - Die Sitzungs-ID.
: properties - Die RenderProperties Objekt, das die Eigenschaften für den Render-Aufruf definiert.
Rückgaben:
: Die Render Antwortobjekt.
Würfe:
: OpenTokException
getRender
öffentlich Rendering getRender(Zeichenfolge renderId) löst einen Fehler aus OpenTokException
Ruft ein Render-Objekt ab, das Details zu einem Experience Composer enthält.
Parameter:
: renderId - Die ID des abzurufenden Experience Composers.
Rückgaben:
: Die Render das mit der angegebenen ID verknüpfte Antwortobjekt.
Würfe:
: OpenTokException
stopRender
public void stopRender(Zeichenfolge renderId) löst einen Fehler aus OpenTokException
Beendet einen Experience Composer einer OpenTok-Sitzung. Beachten Sie, dass Experience Composer automatisch 2 Stunden nach ihrem Start beendet werden. Sie können beim Erstellen des Experience Composers auch einen anderen „maxDuration“-Wert festlegen. Wenn der Experience Composer beendet wird, wird ein Ereignis an die Callback-URL gesendet, sofern Sie eine solche für das Projekt konfiguriert haben.
Parameter:
: renderId - Die ID des Experience Composers, der beendet werden soll.
Würfe:
: OpenTokException
listRenders
öffentlich Liste<Rendering> listRenders() löst einen Fehler aus OpenTokException
Ruft eine Liste von Render-Objekten ab, die die mit dem OpenTok-Projekt verknüpften Experience Composers darstellen.
Rückgabewerte:
: Die Liste der Render Objekte.
Würfe:
: OpenTokException
listRenders
öffentlich Liste<Rendering> listRenders(Integer Versatz, Integer Anzahl) wirft OpenTokException
Ruft eine Liste von Render-Objekten ab, die eine Liste der Experience Composers darstellen, die dem OpenTok-Projekt zugeordnet sind.
Parameter:
: offset - (optional) Startposition in der Liste der vorhandenen Renderings.
: count - (optional) Anzahl der Renders, die ab dem Offset abgerufen werden sollen. Maximal 1000.
Rückgabewerte:
: Die Liste der Render Objekte.
Würfe:
: OpenTokException
startCaptions
öffentlich Bildunterschrift startCaptions(Zeichenfolge sessionId, Zeichenfolge Token, Bildunterschrift-Eigenschaften Eigenschaften) löst aus OpenTokException
Verwenden Sie die Live Captions-API, um Audiostreams zu transkribieren und Echtzeit-Untertitel für Ihre Applications zu generieren. „Live Captions“ ist standardmäßig für alle Projekte aktiviert und wird nutzungsabhängig abgerechnet. Die „Live Captions“-Funktion wird nur in gerouteten Sitzungen unterstützt (Sitzungen, die den OpenTok Media Router verwenden). Sie können bis zu 50 Audiostreams aus einer einzelnen Vonage-Sitzung gleichzeitig an den Transkriptionsdienst senden, um Untertitel zu erstellen.
Parameter:
: sessionId - Die Sitzungs-ID der OpenTok-Sitzung. Das Audiomaterial der Publisher, die in
diese Sitzung senden, wird zur Erstellung der Untertitel verwendet.
: token - Ein gültiges OpenTok-Token, bei dem die Rolle auf „Moderator“ gesetzt ist.
: properties - Die CaptionProperties Objekt, das optionale Eigenschaften der Live-Untertitelung definiert.
Rückgaben:
: A Caption Antwort, die die Bildunterschriften-ID für diesen Aufruf enthält.
Würfe:
: OpenTokException
stopCaptions
public void stopCaptions(Zeichenfolge captionsId) wirft eine Ausnahme OpenTokException
Verwenden Sie diese Methode, um die Live-Untertitel für eine Sitzung zu deaktivieren.
Parameter:
: captionsId - Die eindeutige ID für die Audio-Untertitelungssitzung,
wie sie von Caption.getCaptionsId().
Würfe:
: OpenTokException
schließen
public void close()
Rufen Sie diese Methode auf, wenn Sie die Verwendung des OpenTok-Objekts beendet haben, um zu verhindern, dass Dateideskriptoren offen bleiben.