Sitzung

java.lang.Object

java.util.Observable

com.opentok.android.Session

public class Session extends Beobachtbar

Stellt eine OpenTok-Sitzung dar, an der der Client teilnimmt. Der erste Schritt bei der Verwendung des OpenTok-Android-SDK besteht darin, eine „Session“-Instanz durch Aufruf des Konstruktors „Session()“ zu initialisieren.

Wenn Sie die Session-Instanz erstellen, übergeben Sie die OpenTok-Sitzungs-ID, das Token und den API-Schlüssel. Einen API-Schlüssel erhalten Sie, wenn Sie sich einschreiben für einen OpenTok-Account. Zu Testzwecken können Sie Test-Sitzungs-IDs und -Token generieren, indem Sie sich bei Ihrem Vonage Video API-Konto. Verwenden Sie das Serverseitige OpenTok-Bibliotheken um Sitzungs-IDs und Tokens in Ihrer Versand-App zu generieren.

Siehe auch: : - Sitzung Erstellung - Token Erstellung

Zusammenfassung zu verschachtelten Klassen

Verschachtelte Klassen

Modifikator und Typ

Klasse

Beschreibung

static interface

Session.ArchiveListener

Überwacht, wann eine Archivaufzeichnung der Sitzung beginnt und endet.

static class

Session.Builder

static class

Session.Capabilities

Definiert den Wert, der von der getCapabilities() Methode.

protected static class

Session.ConfigurableSessionOptions

static interface

Session.ConnectionListener

Überwacht, wann andere Clients eine Verbindung zur Sitzung herstellen und diese wieder trennen.

static interface

Session.MuteListener

Überwacht, wann ein Moderator Streams in der Sitzung stummschaltet oder den Stummschaltstatus in der Sitzung aufhebt.

static interface

Session.ReconnectionListener

Überwacht, ob ein Client versucht, die Verbindung automatisch wiederherzustellen, nachdem die Verbindung zu einer OpenTok-Sitzung unterbrochen wurde.

static interface

Session.SessionListener

Überwacht Zustandsänderungen in einem Session Objekt.

static class

Session.SessionOptions

Eine Basisklasse zur Definition erweiterter Sitzungsoptionen mit der Session.Builder.sessionOptions(Session.SessionOptions sessionOptions) Methode.

static interface

Session.SessionOptionsProvider

Veraltet.

static interface

Session.SignalListener

Überwacht, wann in der Sitzung ein Signal gesendet wird.

static interface

Session.StreamCaptionsPropertiesListener

Überwacht, ob sich die Untertitel-Eigenschaften von Streams in der Sitzung ändern.

static interface

Session.StreamPropertiesListener

Überwacht, ob sich die Eigenschaften von Streams in der Sitzung ändern.

Zusammenfassung der Felddaten

Felder

Modifikator und Typ

Feld

Beschreibung

protected String

apiKey

protected URL

apiUrl

protected Session.ArchiveListener

archiveListener

protected Session.ConnectionListener

connectionListener

protected android.content.Context

context

protected Session.MuteListener

muteListener

protected Session.ReconnectionListener

reconnectionListener

protected String

sessionId

protected Session.SessionListener

sessionListener

protected Session.SignalListener

signalListener

protected Session.StreamCaptionsPropertiesListener

streamCaptionsPropertiesListener

protected Session.StreamPropertiesListener

streamPropertiesListener

Zusammenfassung zum Konstruktor

Konstruktoren

Modifikator

Konstruktor

Beschreibung

protected

Session(Session.Builder builder)

Zusammenfassung der Methode

Alle MethodenInstanzmethodenKonkrete Methoden

Modifikator und Typ

Methode

Beschreibung

void

connect(String token)

Stellt unter Verwendung des bereitgestellten Authentifizierungstokens eine Verbindung zu der im Konstruktor „Session“ bereitgestellten OpenTok-Sitzung her.

void

disableForceMute()

Hebt den aktiven Stummschaltstatus der Sitzung auf.

void

disconnect()

Beendet die Verbindung zu dieser Sitzung.

protected void

finalize()

Wird vom Garbage Collector aufgerufen, wenn dieser feststellt, dass keine Verweise mehr auf das Session-Objekt vorhanden sind.

void

forceDisconnect(Connection connection)

Zwingt einen Client, die Verbindung zur Sitzung zu trennen.

void

forceMuteAll(Iterable<Stream> excludedStreams)

Zwingt alle Sender in der Sitzung (mit Ausnahme derjenigen, die ausgeschlossene Streams übertragen) dazu, den Ton stummzuschalten.

void

forceMuteStream(Stream stream)

Zwingt den Anbieter eines bestimmten Streams dazu, dessen Ton stummzuschalten.

Session.Capabilities

getCapabilities()

Gibt an, ob der Client in der Sitzung Streams veröffentlichen und abonnieren kann, basierend auf der Rolle, die dem für die Verbindung zur Sitzung verwendeten Token zugewiesen ist.

Connection

getConnection()

Gibt die Connection entsprechend der Verbindung dieses Clients zu dieser Sitzung.

String

getSessionId()

Gibt die bei der Instanziierung übergebene Sitzungs-ID zurück.

protected void

onArchiveStarted(String id, String name)

Wird aufgerufen, wenn die Aufzeichnung eines Archivs der Sitzung beginnt.

protected void

onArchiveStopped(String id)

Wird aufgerufen, wenn die Aufzeichnung eines Archivs der Sitzung beendet wird.

protected void

onConnected()

Wird aufgerufen, wenn der Client eine Verbindung zur OpenTok-Sitzung herstellt.

protected void

onConnectionCreated(Connection connection)

Wird aufgerufen, wenn ein weiterer Der Client stellt eine Verbindung zur Sitzung her.

protected void

onConnectionDestroyed(Connection connection)

Wird aufgerufen, wenn ein anderer Client die Sitzung verlässt.

protected void

onDisconnected()

Wird aufgerufen, wenn der Client nicht mehr mit der OpenTok- Sitzung verbunden ist.

protected void

onError(OpentokError error)

Wird aufgerufen, wenn beim Herstellen der Verbindung zur Sitzung oder während der Verbindung ein Fehler auftritt.

protected void

onMuteForced(MuteForcedInfo info)

Wird ausgelöst, wenn ein Moderator Streams in der Sitzung stummschaltet oder den Stummschaltstatus in der Sitzung aufhebt.

void

onPause()

Rufe diese Methode auf, wenn die Aktivität der App angehalten wird.

protected void

onReconnected()

Wird aufgerufen, wenn der lokale Client die Verbindung zur OpenTok-Sitzung wiederhergestellt hat, nachdem seine Netzwerkverbindung vorübergehend unterbrochen war.

protected void

onReconnecting()

Wird aufgerufen, wenn der lokale Client die Verbindung zu einer OpenTok-Sitzung verloren hat und versucht, die Verbindung wiederherzustellen.

void

onResume()

Rufe diese Methode auf, wenn die Aktivität der App wieder aufgenommen wird.

protected void

onSignalReceived(String type, String data, Connection connection)

Wird aufgerufen, wenn in der Sitzung ein Signal empfangen wird.

protected void

onStreamDropped(Stream stream)

Wird aufgerufen, wenn ein weiterer Der Client stellt die Übertragung eines Streams an diese OpenTok-Sitzung ein.

protected void

onStreamHasAudioChanged(Stream stream, int hasAudio)

Wird aufgerufen, wenn sich der Status eines Streams in der Sitzung von „mit Audio“ zu „ohne Audio“ ändert.

protected void

onStreamHasCaptionsChanged(Stream stream, int hasCaptions)

Wird aufgerufen, wenn sich bei einem Stream in der Sitzung der Status zwischen „mit Untertiteln“ und „ohne Untertitel“ ändert.

protected void

onStreamHasVideoChanged(Stream stream, int hasVideo)

Wird aufgerufen, wenn sich der Status eines Streams in der Sitzung von „mit Video“ zu „ohne Video“ ändert.

protected void

onStreamReceived(Stream stream)

Wird aufgerufen, wenn ein neuer Stream von ein weiterer Client in dieser OpenTok-Sitzung.

protected void

onStreamVideoDimensionsChanged(Stream stream, int width, int height)

Wird aufgerufen, wenn sich die Videoabmessungen eines Streams in der Sitzung ändern.

protected void

onStreamVideoTypeChanged(Stream stream, int videoType)

Wird aufgerufen, wenn sich der Videotyp eines Streams in der Sitzung ändert.

void

publish(PublisherKit publisher)

Startet einen Publisher, der Daten an die Sitzung überträgt.

String

reportIssue()

Melden Sie, dass bei Ihrer App ein Problem aufgetreten ist.

void

sendSignal(String type, String data)

Sendet ein Signal an alle Clients in einer Sitzung.

void

sendSignal(String type, String data, boolean retryAfterReconnect)

Sendet ein Signal an alle Clients in einer Sitzung.

void

sendSignal(String type, String data, Connection connection)

Sendet ein Signal an einen bestimmten Client innerhalb einer Sitzung.

void

sendSignal(String type, String data, Connection connection, boolean retryAfterReconnect)

Sendet ein Signal an einen bestimmten Client innerhalb einer Sitzung. Diese Version der Methode umfasst ein retryAfterReconnect Parameter.

void

setArchiveListener(Session.ArchiveListener listener)

Legt einen Session.ArchiveListener Objekt, das überwacht, wann eine Archivaufzeichnung in dieser Sitzung beginnt oder endet.

void

setConnectionListener(Session.ConnectionListener listener)

Legt einen Session.ConnectionListener Objekt, mit dem überwacht werden kann, wann andere Clients eine Verbindung zu dieser Sitzung herstellen und trennen.

void

setEncryptionSecret(String secret)

Legt den Schlüssel für die End-to-End-Verschlüsselung fest, der von allen Herausgebern und Abonnenten verwendet wird.

void

setMuteListener(Session.MuteListener listener)

Legt einen Session.MuteListener Objekt, das überwacht werden soll, wenn in dieser Sitzung ein Befehl zur erzwungenen Stummschaltung gesendet wird.

void

setReconnectionListener(Session.ReconnectionListener listener)

Legt einen Session.ReconnectionListener Objekt, das benachrichtigt werden soll, wenn der Client versucht, die Verbindung zu einer OpenTok-Sitzung wiederherzustellen, oder wenn die Verbindung wiederhergestellt wurde.

void

setSessionListener(Session.SessionListener listener)

Legt einen Session.SessionListener Objekt zur Überwachung von Zustandsänderungen für dieses Session-Objekt.

void

setSignalListener(Session.SignalListener listener)

Legt einen Session.SignalListener Objekt, das überwacht, wann in dieser Sitzung Signale gesendet werden.

void

setStreamCaptionsPropertiesListener(Session.StreamCaptionsPropertiesListener listener)

Legt einen Session.StreamCaptionsPropertiesListener Objekt zur Überwachung der Eigenschaften der Eigenschaft „stream captions“.

void

setStreamPropertiesListener(Session.StreamPropertiesListener listener)

Legt einen Session.StreamPropertiesListener Objekt zur Überwachung von Eigenschaften von Streams, die sich in dieser Sitzung ändern.

void

subscribe(SubscriberKit subscriber)

Beginne mit dem Empfang und der Wiedergabe von Audio-Video-Stream-Daten für den angegebenen Teilnehmer.

void

unpublish(PublisherKit publisher)

Trennt den Publisher von der Sitzung.

void

unsubscribe(SubscriberKit subscriber)

Beendet das Abonnieren (Empfangen eines Streams) eines bestimmten Abonnenten in der Sitzung.

Von der Klasse „java.util“ geerbte Methoden.Beobachtbar

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Von der Klasse „java.lang.“ geerbte Methoden.Objekt

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Felddetails

sessionListener

geschützt Session.SessionListener sessionListener

Verbindungs-Listener

geschützt Session.ConnectionListener Verbindungs-Listener

streamPropertiesListener

geschützt Session.StreamPropertiesListener streamPropertiesListener

streamCaptionsPropertiesListener

geschützt Session.StreamCaptionsPropertiesListener streamCaptionsPropertiesListener

signalListener

geschützt Session.SignalListener signalListener

archiveListener

geschützt Session.ArchiveListener archiveListener

reconnectionListener

geschützt Session.ReconnectionListener reconnectionListener

muteListener

geschützt Session.MuteListener muteListener

Kontext

protected android.content.Context context

apiKey

geschützt Zeichenfolge apiKey

sessionId

geschützt Zeichenfolge sessionId

apiUrl

geschützt URL apiUrl

Angaben zum Hersteller

Sitzung

geschützte Sitzung(Session.Builder Builder) löst aus Ausnahme

Würfe: : Exception

Details zur Methode

getConnection

öffentlich Verbindung getConnection()

Gibt die Connection entsprechend der Verbindung dieses Clients zu dieser Sitzung.

Wenn ein Stream erstellt wird, wird der Session.SessionListener.onStreamReceived(Session session, Stream stream) Methode aufgerufen wird. Vergleichen Sie das vom Stream.getConnection() Methode mit dem Connection-Objekt, das von Sesssion.getConnection() um zu prüfen, ob der neue Stream von Ihrem Client veröffentlicht wird.

Gibt Folgendes zurück: : Die OpenTok-Sitzungs-ID für diese Instanz.

Siehe auch: : - Session.SessionListener.onConnected(Session session) - Session.SessionListener.onStreamReceived(Session session, Stream stream) - Stream.getConnection()

getSessionId

öffentlich Zeichenfolge getSessionId()

Gibt die bei der Instanziierung übergebene Sitzungs-ID zurück.

Gibt Folgendes zurück: : Die OpenTok-Sitzungs-ID für diese Instanz.

setSessionListener

public void setSessionListener(Session.SessionListener Zuhörer)

Legt einen Session.SessionListener Objekt zur Überwachung von Zustandsänderungen für dieses Session-Objekt.

Parameter: : listener - Die Session.SessionListener Instanz.

setConnectionListener

public void setConnectionListener(Session.ConnectionListener Zuhörer)

Legt einen Session.ConnectionListener Objekt, mit dem überwacht werden kann, wann andere Clients eine Verbindung zu dieser Sitzung herstellen und trennen.

Parameter: : listener - Die Session.ConnectionListener Instanz.

setStreamPropertiesListener

public void setStreamPropertiesListener(Session.StreamPropertiesListener Zuhörer)

Legt einen Session.StreamPropertiesListener Objekt zur Überwachung von Eigenschaften von Streams, die sich in dieser Sitzung ändern. Dazu gehören Eigenschaften, die angeben, ob der Stream Audio enthält, ob er Video enthält und welche Videoabmessungen er hat.

Parameter: : listener - Die Session.StreamPropertiesListener Instanz.

setStreamCaptionsPropertiesListener

public void setStreamCaptionsPropertiesListener(Session.StreamCaptionsPropertiesListener Zuhörer)

Legt einen Session.StreamCaptionsPropertiesListener Objekt zur Überwachung der Eigenschaften der Eigenschaft „stream captions“.

Parameter: : listener - Die Session.StreamCaptionsPropertiesListener Instanz.

setSignalListener

public void setSignalListener(Session.SignalListener Zuhörer)

Legt einen Session.SignalListener Objekt, das überwacht, wann in dieser Sitzung Signale gesendet werden.

Parameter: : listener - Die Session.SignalListener Instanz.

setArchiveListener

public void setArchiveListener(Session.ArchiveListener Zuhörer)

Legt einen Session.ArchiveListener Objekt, das überwacht, wann eine Archivaufzeichnung in dieser Sitzung beginnt oder endet.

Parameter: : listener - Die Session.ArchiveListener Instanz.

setReconnectionListener

public void setReconnectionListener(Session.ReconnectionListener Zuhörer)

Parameter: : listener - Die Session.ReconnectionListener Instanz.

setMuteListener

public void setMuteListener(Session.MuteListener Zuhörer)

Legt einen Session.MuteListener Objekt, das überwacht werden soll, wenn in dieser Sitzung ein Befehl zur erzwungenen Stummschaltung gesendet wird.

Parameter: : listener - Die Session.MuteListener Instanz.

verbinden

public void connect(Zeichenfolge Token)

Stellt unter Verwendung des bereitgestellten Authentifizierungstokens eine Verbindung zu der im Konstruktor „Session“ bereitgestellten OpenTok-Sitzung her.

Sobald die Sitzung hergestellt ist, wird die Session.SessionListener.onConnected(Session session) Die Methode wird aufgerufen.

Wenn die Sitzung keine Verbindung herstellen kann, wird die Session.SessionListener.onError(Session session, OpentokError error) Die Methode wird aufgerufen.

Parameter: : token - Das Token des Benutzers. Siehe Token Übersicht über die Erstellung.

Trennen

public void disconnect()

Trennt die Verbindung zu dieser Sitzung. Alle Subscriber- und Publisher-Instanzen werden getrennt. Als bewährte Vorgehensweise sollten Sie vor dem Aufruf dieser Methode die Methode unpublish(PublisherKit) Methode für alle Publisher und warte auf die PublisherKit.onStreamDestroyed(Stream) Callback. Dadurch wird sichergestellt, dass Publisher vollständig entfernt werden, insbesondere wenn Probleme mit der Netzwerkverbindung das Entfernen aufgrund der Wiederverbindungsfunktion verhindern, die Publisher-Streams möglicherweise für eine eventuelle Wiederverbindung aufrechterhält.

Wenn die Sitzung getrennt wird, wird die Session.SessionListener.onDisconnected(Session session) Die Methode wird aufgerufen.

onPause

public void onPause()

Rufen Sie diese Methode auf, wenn die Aktivität der App angehalten wird. Dadurch werden der Video-Renderer und der Capturer aller Publisher der Sitzung angehalten. Außerdem werden die Video-Renderer aller Subscriber angehalten.

Die von OpenTok-Publishern verwendeten Kameras werden nun freigegeben, wenn Sie diese Methode aufrufen. Publisher rufen die Kameras erneut ab, wenn Sie die onResume() Methode.

onResume

public void onResume()

Rufen Sie diese Methode auf, wenn die Aktivität der App wieder aufgenommen wird. Dadurch werden der Video-Renderer und der Capturer aller Publisher der Sitzung wieder aktiviert. Außerdem werden die Video-Renderer aller Subscriber wieder aktiviert.

Alle Kameras (die von OpenTok-Publishern verwendet werden), die zum Zeitpunkt Ihres Aufrufs der onPause() Die Methoden werden beim Aufruf erneut abgerufen. Session.onResume().

veröffentlichen.

public void publish(PublisherKit (Verlag)

Startet einen Publisher, der Daten an die Sitzung überträgt.

Parameter: : publisher - Der Publisher, den Sie in die Sitzung streamen möchten.

nicht veröffentlichen

public void unpublish(PublisherKit (Verlag)

Trennt den Publisher von der Sitzung.

Parameter: : publisher - Der Herausgeber soll die Veröffentlichung zurückziehen.

abbestellen

public void unsubscribe(SubscriberKit Abonnent)

Beendet das Abonnieren (Empfangen eines Streams) eines bestimmten Abonnenten in der Sitzung.

Parameter: : subscriber - Der Abonnent, dessen Abonnement Sie kündigen möchten.

signalSenden

public void sendSignal(Zeichenfolge Typ, Zeichenfolge Daten)

Sendet ein Signal an alle Clients in einer Sitzung.

Siehe auch: : - sendSignal(String type, String data, Connection connection) - sendSignal(String type, String data, boolean retryAfterReconnect) - Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)

signalSenden

public void sendSignal(Zeichenfolge Typ, Zeichenfolge data, boolean retryAfterReconnect)

Sendet ein Signal an alle Clients in einer Sitzung. Diese Version der Methode enthält ein retryAfterReconnect Parameter.

Parameter: : type - Der Typ des Signals. Der Typ wird ebenfalls in der Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection) Methode. : data - Die zu sendenden Daten. Die Datengröße ist auf 8 kB begrenzt. : retryAfterReconnect - Ob bei der Wiederherstellung der Verbindung zur Sitzung Signale gesendet werden sollen, die während der Unterbrechung der Verbindung ausgelöst wurden. Wenn Ihr Client die Verbindung zur OpenTok-Sitzung aufgrund einer Unterbrechung der Netzwerkverbindung verliert, versucht der Client, die Verbindung zur Sitzung wiederherzustellen, und die Session.ReconnectionListener.onReconnecting(Session session) Methode aufgerufen wird. Standardmäßig werden Signale, die während einer Unterbrechung der Verbindung ausgelöst wurden, gesendet, sobald (und falls) der Client die Verbindung zur OpenTok-Sitzung wiederherstellt. Sie können dies verhindern, indem Sie die retryAfterReconnect Parameter zu false. (Der Standardwert ist true.)

Siehe auch: : - sendSignal(String type, String data) - Session.ReconnectionListener.onReconnecting(Session session) - Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)

signalSenden

public void sendSignal(Zeichenfolge Typ, Zeichenfolge Daten, Verbindung Verbindung)

Sendet ein Signal an einen bestimmten Client innerhalb einer Sitzung.

Siehe auch: : - sendSignal(String type, String data) - sendSignal(String type, String data, Connection connection, boolean retryAfterReconnect) - Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)

signalSenden

public void sendSignal(Zeichenfolge Typ, Zeichenfolge Daten, Verbindung Verbindung, bool retryAfterReconnect)

Sendet ein Signal an einen bestimmten Client innerhalb einer Sitzung. Diese Version der Methode umfasst ein retryAfterReconnect Parameter.

Parameter: : type - Der Typ des Signals. Der Typ wird ebenfalls in der Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection) Methode. : data - Die zu sendenden Daten. Die Datengröße ist auf 8 kB begrenzt. : connection - Ein Connection-Objekt. Das Connection-Objekt repräsentiert die Verbindung eines Clients zur Sitzung. Dies ist der Client, an den die Nachricht gesendet wird. (Siehe Session.ConnectionListener.onConnectionCreated(Session session, Connection connection) und Connection. : retryAfterReconnect - Ob bei der Wiederherstellung der Verbindung zur Sitzung Signale gesendet werden sollen, die während der Unterbrechung der Verbindung ausgelöst wurden. Wenn Ihr Client die Verbindung zur OpenTok-Sitzung aufgrund einer Unterbrechung der Netzwerkverbindung verliert, versucht der Client, die Verbindung zur Sitzung wiederherzustellen, und die Session.ReconnectionListener.onReconnecting(Session session) Methode aufgerufen wird. Standardmäßig werden Signale, die während einer Unterbrechung der Verbindung ausgelöst wurden, gesendet, sobald (und sofern) der Client die Verbindung zur OpenTok-Sitzung wiederherstellt. Sie können dies verhindern, indem Sie die retryAfterReconnect Parameter bis false. (Der Standardwert ist true.)

Siehe auch: : - sendSignal(String type, String data) - sendSignal(String type, String data, Connection connection) - sendSignal(String type, String data, boolean retryAfterReconnect) - Session.SignalListener.onSignalReceived(Session session, String type, String data, Connection connection)

getCapabilities

öffentlich Session.Capabilities getCapabilities()

Gibt an, ob der Client in der Sitzung Streams veröffentlichen und abonnieren kann, basierend auf der Rolle, die dem für die Verbindung zur Sitzung verwendeten Token zugewiesen ist. Diese Methode gibt Folgendes zurück: null bis Sie eine Verbindung zu einer Sitzung hergestellt haben und die Session.SessionListener.onConnected(Session session) Die Methode wurde aufgerufen.

Problem melden

öffentlich Zeichenfolge reportIssue()

Melden Sie, dass bei Ihrer App ein Problem aufgetreten ist. Sie können die Problem-ID mit der Inspektor oder wenn Sie ein Problem mit dem TokBox-Supportteam besprechen.

Rückgabewerte: : Die mit dem Problem verknüpfte ID.

forceDisconnect

public void forceDisconnect(@NonNull Verbindung Verbindung)

Zwingt einen Client, die Verbindung zur Sitzung zu trennen. Sie können zwar forceDisconnect(Connection) Um Ihre Verbindung zu beenden, ist es einfacher, die Methode „disconnect“ aufzurufen. Es wird ein Fehler zurückgegeben, wenn die Rolle des Clients nicht über die erforderlichen Berechtigungen verfügt, um andere Benutzer zur Trennung der Verbindung zu zwingen. Sie legen die Rolle eines Clients fest, wenn Sie das Benutzer-Token erstellen. Wenn eine Verbindung mithilfe dieser Methode beendet wird, Session.SessionListener.onDisconnected(Session), onConnectionDestroyed(Connection) und PublisherKit.onStreamDestroyed(Stream) Callbacks werden genauso ausgelöst, wie dies der Fall wäre, wenn die Verbindung selbst beendet worden wäre mithilfe von disconnect().

Parameter: : connection - Die Verbindung, die man trennen muss.

forceMuteStream

public void forceMuteStream(@NonNull Stream Stream)

Zwingt den Anbieter eines bestimmten Streams dazu, dessen Ton stummzuschalten.

Prüfen Sie die canForceMute Eigenschaft des Objekts, das durch den Aufruf von getCapabilities() um zu prüfen, ob Sie diese Funktion erfolgreich aufrufen können. Dies ist Clients vorbehalten, die sich mit einem Token verbunden haben, dem die Moderatorenrolle zugewiesen wurde (siehe die Token-Erstellung (Dokumentation).

Parameter: : stream - Das Objekt, das den Stream für die Anforderung zur erzwungenen Stummschaltung repräsentiert. Dazu gehört der Stream, der stummgeschaltet werden soll.

Siehe auch: : - getCapabilities() - forceMuteAll(Iterable) - PublisherKit.onMuteForced() - Stummschalten des Tons von Streams in einer Sitzung

forceMuteAll

public void forceMuteAll(@Nullable Iterierbar<Stream> excludedStreams)

Zwingt alle Sender in der Sitzung (mit Ausnahme derjenigen, die ausgeschlossene Streams übertragen) dazu, den Ton stummzuschalten.

Außerdem werden alle Streams, die nach dem Aufruf der forceMuteAll() Methode werden mit stummgeschaltetem Ton veröffentlicht. Sie können den Stummschaltstatus einer Sitzung aufheben, indem Sie die disableForceMute() Methode. Nachdem Sie die disableForceMute() Mit dieser Methode wird die Stummschaltung bei neuen Streams, die in der Sitzung veröffentlicht werden, aufgehoben.

Der Aufruf dieser Methode bewirkt, dass die Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) Methode, die in jedem mit der Sitzung verbundenen Client aufgerufen werden soll, mit der getActive() Methode der info Objekt zurückgeben true.

Parameter: : excludedStreams - Das Objekt, das die Streams repräsentiert, die von der Anforderung zur erzwungenen Stummschaltung ausgeschlossen werden sollen. Dazu gehört auch der Stream, der nicht stummgeschaltet werden soll.

Siehe auch: : - Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) - getCapabilities() - disableForceMute() - forceMuteStream(Stream stream) - Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) - PublisherKit.onMuteForced() - Stummschalten des Tons von Streams in einer Sitzung

disableForceMute

public void disableForceMute()

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 forceMuteAll(Iterable) Methode (oder ein Moderator in einem anderen Client löst einen Befehl aus, alle Streams stummzuschalten), werden alle Streams, die nach dem Moderationsbefehl veröffentlicht werden, mit stummgeschaltetem Ton veröffentlicht. Rufen Sie die disableForceMute() Methode zum Aufheben der Stummschaltung einer Sitzung (damit neu veröffentlichte Streams nicht automatisch stummgeschaltet werden).

Der Aufruf dieser Methode bewirkt, dass die Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) aufzurufende Methode, mit der getActive() Methode der info Objekt Rückgabe false.

Siehe auch: : - Session.MuteListener.onMuteForced(Session session, MuteForcedInfo info) - getCapabilities() - forceMuteAll(Iterable) - Stummschalten des Tons von Streams in einer Sitzung

setEncryptionSecret

public void setEncryptionSecret(Zeichenfolge (Geheimnis)

Legt den Schlüssel für die End-to-End-Verschlüsselung fest, der von allen Herausgebern und Abonnenten verwendet wird.

Siehe die Leitfaden für Entwickler zur End-to-End-Verschlüsselung.

Parameter: : secret - Wert des Verschlüsselungsschlüssels.

onArchiveStarted

protected void onArchiveStarted(Zeichenfolge id, Zeichenfolge Name)

Wird aufgerufen, wenn die Aufzeichnung eines Archivs der Sitzung beginnt. Als Reaktion auf diese Methode können Sie eine Benachrichtigung in der Benutzeroberfläche hinzufügen (z. B. ein Symbol in der Publisher-Ansicht), die anzeigt, dass die Sitzung aufgezeichnet wird.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onArchiveStarted() Methode der Schnittstelle `Session.ArchiveListener` .

Parameter: : id - Die eindeutige ID des Archivs. : name - Der Name des Archivs (sofern bei der Erstellung des Archivs ein Name angegeben wurde).

onArchiveStopped

protected void onArchiveStopped(Zeichenfolge id)

Wird aufgerufen, wenn die Aufzeichnung eines Archivs der Sitzung beendet wird. Als Reaktion auf diese Methode können Sie eine Benachrichtigung in der Benutzeroberfläche (z. B. ein Symbol in der Publisher-Ansicht) entfernen, die darauf hinweist, dass die Sitzungsaufzeichnung beendet wurde.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onArchiveStopped() Methode der Schnittstelle `Session.ArchiveListener` .

Parameter: : id - Die eindeutige ID des Archivs.

onStreamHasAudioChanged

protected void onStreamHasAudioChanged(Stream stream, int hasAudio)

Wird aufgerufen, wenn sich der Status eines Streams in der Sitzung von „mit Audio“ zu „ohne Audio“ ändert.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onStreamHasAudioChanged() Methode der Schnittstelle `Session.StreamPropertiesListener` .

Parameter: : stream - Der Bach. : hasAudio - Ob der Stream Ton enthält (true) oder nicht ( false).

onStreamHasCaptionsChanged

protected void onStreamHasCaptionsChanged(Stream stream, int hasCaptions)

Wird aufgerufen, wenn sich bei einem Stream in der Sitzung der Status zwischen „mit Untertiteln“ und „ohne Untertitel“ ändert.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onStreamHasCaptionsChanged() Methode der Schnittstelle `Session.StreamPropertiesListener` .

Parameter: : stream - Der Bach. : hasCaptions - Ob der Stream Untertitel enthält (true) oder nicht ( false).

onStreamHasVideoChanged

protected void onStreamHasVideoChanged(Stream stream, int hasVideo)

Wird aufgerufen, wenn sich der Status eines Streams in der Sitzung von „mit Video“ zu „ohne Video“ ändert.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onStreamHasVideoChanged() Methode der Schnittstelle `Session.StreamPropertiesListener` .

Parameter: : stream - Der Bach. : hasVideo - Ob der Stream Video enthält (true) oder nicht ( false).

onStreamVideoDimensionsChanged

protected void onStreamVideoDimensionsChanged(Stream stream, int Breite, int Höhe)

Wird aufgerufen, wenn sich die Videoabmessungen eines Streams in der Sitzung ändern.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onStreamVideoDimensionsChanged() Methode der Schnittstelle `Session.StreamPropertiesListener` .

Parameter: : stream - Der Bach. : width - Die neue Breite des Streams in Pixeln. : height - Die neue Höhe des Streams in Pixeln.

onStreamVideoTypeChanged

protected void onStreamVideoTypeChanged(Stream stream, int videoType)

Wird aufgerufen, wenn sich der Videotyp eines Streams in der Sitzung ändert.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onStreamVideoTypeChanged() Methode der Schnittstelle `Session.StreamPropertiesListener` .

Parameter: : stream - Der Bach. : videoType - Der neue Videotyp des Streams.

onConnectionCreated

protected void onConnectionCreated(Verbindung Verbindung)

Wird aufgerufen, wenn ein weiterer Der Client stellt eine Verbindung zur Sitzung her. Das Connection-Objekt repräsentiert die Verbindung des Clients zur Sitzung. Beachten Sie, dass diese Methode aufgerufen wird, wenn sonstiges Clients stellen eine Verbindung zur Sitzung her. Wenn Ihre eigene Wenn sich ein Client verbindet, wird der Session.SessionListener.onConnected(Session session) Die Methode wird aufgerufen.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onConnectionCreated() Methode der Schnittstelle `Session.ConnectionListener` .

Parameter: : connection - Die neue Verbindung in der Sitzung.

onConnectionDestroyed

protected void onConnectionDestroyed(Verbindung Verbindung)

Wird aufgerufen, wenn ein anderer Client die Sitzung verlässt. Das Connection-Objekt stellt die vorherige Verbindung des Clients zur Sitzung dar. Wenn Ihr eigene Der Client trennt die Verbindung, der Session.SessionListener.onDisconnected(Session session) Die Methode wird aufgerufen.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onConnectionDestroyed() Methode der Schnittstelle `Session.ConnectionListener` .

Parameter: : connection - Die Verbindung, die die Sitzung verlassen hat.

onSignalReceived

protected void onSignalReceived(Zeichenfolge Typ, Zeichenfolge Daten, Verbindung Verbindung)

Wird aufgerufen, wenn in der Sitzung ein Signal empfangen wird.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onSignalReceived() Methode der Schnittstelle `Session.SignalListener` .

Parameter: : type - Die Typzeichenfolge des Signals. : data - Die Signaldaten. : connection - Die Verbindung, die den Client identifiziert, der die Nachricht gesendet hat. Dieser Wert kann null.

onReconnecting

protected void onReconnecting()

Wird aufgerufen, wenn der lokale Client die Verbindung zu einer OpenTok-Sitzung verloren hat und versucht, die Verbindung wiederherzustellen. Dies ist auf einen Ausfall der Netzwerkverbindung zurückzuführen. Wenn der Client die Verbindung zur Sitzung wiederherstellen kann, wird die Session.ReconnectionListener.onReconnected(Session session) Methode aufgerufen wird. Andernfalls, wenn der Client die Verbindung nicht wiederherstellen kann, wird die Session.SessionListener.onDisconnected(Session session) Methode aufgerufen wird.

Als Reaktion auf den Aufruf dieser Methode möchten Sie möglicherweise eine Benachrichtigung über die Benutzeroberfläche anzeigen, um den Benutzer darüber zu informieren, dass die App versucht, die Verbindung zur Sitzung wiederherzustellen, und dass die Audio- und Videostreams vorübergehend unterbrochen sind.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onReconnecting() Methode der Schnittstelle `Session.ReconnectionListener` .

Siehe auch: : - onReconnected()

onReconnected

protected void onReconnected()

Wird aufgerufen, wenn der lokale Client die Verbindung zur OpenTok-Sitzung wiederhergestellt hat, nachdem seine Netzwerkverbindung vorübergehend unterbrochen war. Wenn die Verbindung unterbrochen wird, wird die Session.ReconnectionListener.onReconnecting(Session session) Methode aufgerufen wird, vor dem Session.ReconnectionListener.onReconnected(Session session) Methode. Wenn der Client die Verbindung zur Sitzung nicht wiederherstellen kann, wird die Session.SessionListener.onDisconnected(Session session) Methode aufgerufen wird.

Alle bestehenden Publisher und Subscriber werden automatisch wieder verbunden, wenn der Client die Verbindung wiederherstellt und diese Methode aufgerufen wird.

Standardmäßig werden alle Signale, die vom lokalen Client mithilfe der sendSignal(String type, String data) Die Signale dieser Methode werden gesendet, wenn der Client die Verbindung wiederherstellt. Um zu verhindern, dass Signale gesendet werden, die während der Unterbrechung der Verbindung ausgelöst wurden, verwenden Sie die sendSignal(String type, String data, boolean retryAfterReconnect) Methode zum Senden des Signals und legen Sie die retryAfterReconnect Parameter zu false. (Alle Signale, die von anderen Clients gesendet wurden, während die Verbindung Ihres Clients unterbrochen war, werden bei der Wiederherstellung der Verbindung empfangen.)

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onReconnected() Methode der Schnittstelle `Session.ReconnectionListener` .

Siehe auch: : - onReconnecting()

onConnected

protected void onConnected()

Wird aufgerufen, wenn der Client eine Verbindung zur OpenTok-Sitzung herstellt.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onConnected() Methode der Schnittstelle `Session.SessionListener` .

onDisconnected

protected void onDisconnected()

Wird aufgerufen, wenn der Client nicht mehr mit der OpenTok- Sitzung verbunden ist.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onDisconnected() Methode der Schnittstelle `Session.SessionListener` .

onStreamReceived

protected void onStreamReceived(Stream Stream)

Wird aufgerufen, wenn ein neuer Stream von ein weiterer Client in dieser OpenTok-Sitzung.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onStreamReceived() Methode der Schnittstelle `Session.SessionListener` .

Parameter: : stream - Ein Stream-Objekt, das den neuen Stream darstellt und zum Erstellen eines Subscribers verwendet werden kann.

onStreamDropped

protected void onStreamDropped(Stream Stream)

Wird aufgerufen, wenn ein weiterer Der Client stellt die Übertragung eines Streams an diese OpenTok-Sitzung ein.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onStreamDropped() Methode der Schnittstelle `Session.SessionListener` .

Parameter: : stream - Ein Stream-Objekt, das den abgebrochenen Stream darstellt und zur Identifizierung eines Abonnenten verwendet werden kann.

onError

protected void onError(Opentok-Fehler Fehler)

Wird aufgerufen, wenn beim Herstellen einer Verbindung zur Sitzung oder während der Verbindung ein Fehler auftritt. Nach dem Aufruf dieser Methode sollte die Sitzung als ausgefallen und nicht mehr verfügbar betrachtet werden. Versuchen Sie nicht, die Verbindung erneut herzustellen oder andere Methoden des Session-Objekts aufzurufen.

Diese Methode wird aufgerufen, wenn der Versuch, eine Verbindung zur Sitzung herzustellen, fehlschlägt. Sie wird außerdem aufgerufen, wenn die Verbindung zur Sitzung nach einer erfolgreichen Verbindung aufgrund eines Fehlers unterbrochen wird; in diesem Fall wird die Methode unmittelbar vor der Session.SessionListener.onDisconnected(Session session) Methode aufgerufen wird.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onError() Methode der Schnittstelle `Session.SessionListener` .

Parameter: : error - Eine Fehlermeldung, in der die Ursache des Fehlers beschrieben wird.

onMuteForced

protected void onMuteForced(MuteForcedInfo Info)

Wird ausgelöst, wenn ein Moderator Streams in der Sitzung stummschaltet oder den Stummschaltstatus in der Sitzung aufhebt.

Wenn Sie die Klasse „Session“ erweitern, können Sie diese Methode anstelle der onMuteForced() Methode der Schnittstelle „Session.MuteListener“.

Parameter: : info - Rufen Sie die getActive Methode dieses Objekts, um festzustellen, ob der Moderator Streams in der Sitzung stummgeschaltet hat (true) oder den Stummschaltungsstatus in der Sitzung deaktiviert (false).

Siehe auch: : - forceMuteAll(Iterable) - disableForceMute() - onMuteForced(MuteForcedInfo) - PublisherKit.onMuteForced() - Stummschalten des Tons von Streams in einer Sitzung

abschließen

protected void finalize() throws Wurfgegenstand

Wird vom Garbage Collector aufgerufen, wenn dieser feststellt, dass keine Verweise mehr auf das Session-Objekt vorhanden sind.

Überschreibungen: : finalize im Unterricht Object

Würfe: : Throwable