AddonSession

@PublicApi
public interface AddonSession



Eine Add-on-Sitzung.

Enthält Methoden, die alle Add-on-Sitzungen verwenden. Wenn du Zugriff auf gemeinsames Ansehen und gemeinsames Ansehen haben möchtest, rufe getCoWatching bzw. getCoDoing auf.

Zusammenfassung

Verschachtelte Typen

Ein Builder für AddonSession.

Öffentliche Methoden

abstract ListenableFuture<Void>

Die Add-on-Sitzung wird beendet und die Verbindung zur Meet App wird getrennt.

abstract void

Beendet den Status „Gesperrt“.

abstract CoDoingClient

Gibt die Instanz CoDoingClient zurück.

abstract CoWatchingClient

Gibt die Instanz CoWatchingClient zurück.

abstract AddonMeetingInfo

Gibt Informationen zur verbundenen Besprechung zurück, z. B. die Besprechungs-URL.

abstract boolean

Gibt true zurück, wenn die Sitzung beendet ist.

abstract boolean

Gibt an, ob die Sitzung angehalten wurde.

abstract void

Setzt den Startstatus des Add-ons zurück.

abstract void

Sperrt die Add-on-Sitzung.

abstract void

Aktualisiert den Startstatus des Add-ons.

abstract void
updateParticipantMetadata(byte[] metadata)

Aktualisiert die Metadaten für diesen Teilnehmer.

Öffentliche Methoden

endSession

abstract ListenableFuture<VoidendSession()

Die Add-on-Sitzung wird beendet und die Verbindung zur Meet App wird getrennt. Dadurch wird weder die Videokonferenz beendet noch der Nutzer verlässt die Videokonferenz.

Wenn die Sitzung bereits beendet wurde, ist dies ein Nullvorgang. Es wird keine Ausnahme ausgelöst.

Returns
ListenableFuture<Void>

ListenableFuture, das als erfolgreich ausgewertet wird, oder AddonException, wenn ein unerwarteter Fehler aufgetreten ist

endSuspension

abstract void endSuspension()

Beendet den Status „Gesperrt“. Die Add-on-App kann wieder Updates senden und empfangen.

Wenn er sich nicht im Status "Ausgesetzt" befindet, ist dies ein Nulloperation.

Löst aus
java.lang.IllegalStateException

wenn die Sitzung beendet ist. Dies kann entweder ein expliziter Aufruf von endSession sein oder ein externer Grund, der über onSessionEnded angezeigt wird.

getCoDoing

abstract CoDoingClient getCoDoing()

Gibt die Instanz CoDoingClient zurück.

Löst aus
java.lang.IllegalStateException

Die Sitzung wurde ohne Aufruf von withCoDoing erstellt oder sie wurde beendet.

getCoWatching

abstract CoWatchingClient getCoWatching()

Gibt die Instanz CoWatchingClient zurück.

Löst aus
java.lang.IllegalStateException

Die Sitzung wurde ohne Aufruf von withCoWatching erstellt oder sie wurde beendet.

getMeetingInfo

abstract AddonMeetingInfo getMeetingInfo()

Gibt Informationen zur verbundenen Besprechung zurück, z. B. die Besprechungs-URL.

Löst aus
java.lang.IllegalStateException

wenn die Sitzung beendet ist. Dies kann entweder ein expliziter Aufruf von endSession sein oder ein externer Grund, der über onSessionEnded angezeigt wird.

isSessionEnded

abstract boolean isSessionEnded()

Gibt true zurück, wenn die Sitzung beendet ist. Dies kann entweder von einem expliziten Aufruf von endSession stammen oder auf einen externen Grund zurückzuführen sein, der über onSessionEnded angezeigt wird.

Löst aus
java.lang.IllegalStateException

wenn die Sitzung beendet ist. Dies kann entweder ein expliziter Aufruf von endSession sein oder ein externer Grund, der über onSessionEnded angezeigt wird

isSuspended

abstract boolean isSuspended()

Gibt an, ob die Sitzung angehalten wurde. Weitere Informationen findest du unter suspend und endSuspension.

Löst aus
java.lang.IllegalStateException

wenn die Sitzung beendet ist. Dies kann entweder ein expliziter Aufruf von endSession sein oder ein externer Grund, der über onSessionEnded angezeigt wird.

resetCollaborationStartingState

abstract void resetCollaborationStartingState()

Setzt den Startstatus des Add-ons zurück. Dadurch wird der Startstatus gelöscht, den andere Teilnehmer zuvor erhalten haben. Der Startstatus kann nur vom Initiator zurückgesetzt werden.

suspend

abstract void suspend()

Sperrt die Add-on-Sitzung. Dadurch wird die Verbindung zur Meet App NICHT getrennt. Das SDK sendet dann keine Updates an CoDoingHandler und CoWatchingHandler. Außerdem ignoriert das SDK Aufrufe zur Benachrichtigung von Aufrufen und ignoriert Aufrufe zur Aktualisierung des globalen Status.

Wenn die Sitzung bereits unterbrochen wurde, ist dies ein Leerbefehl.

Beispielsweise können Sie suspend aufrufen, wenn ein Nutzer – aber nicht jeder Nutzer – die Wiedergabe aufgrund der Wiedergabe einer Anzeige unterbrochen hat oder wenn ein Nutzer die App in den Hintergrund stellt.

Löst aus
java.lang.IllegalStateException

wenn die Sitzung beendet ist. Dies kann entweder ein expliziter Aufruf von endSession sein oder ein externer Grund, der über onSessionEnded angezeigt wird.

updateCollaborationStartingState

abstract void updateCollaborationStartingState(
    CollaborationStartingState startingState
)

Aktualisiert den Startstatus des Add-ons. Andere Teilnehmer erhalten diese Information, wenn sie die Einladung zur Zusammenarbeit annehmen. Der Startstatus kann nur vom Initiator aktualisiert werden.

Parameter
CollaborationStartingState startingState

Startstatus des Add-ons

updateParticipantMetadata

abstract void updateParticipantMetadata(byte[] metadata)

Aktualisiert die Metadaten für diesen Teilnehmer.

Um Metadaten von anderen Teilnehmern zu erhalten, muss ein Handler registriert werden. Dazu muss beim Erstellen des AddonSession-Objekts "withParticipantMetadata" aufgerufen werden.

Die codierten Metadaten sind auf MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES Byte pro Teilnehmer beschränkt.

Parameter
byte[] metadata

Ein codiertes Metadaten-Blob, das relevante Metadaten für den lokalen Teilnehmer beschreibt

Löst aus
java.lang.IllegalArgumentException

wenn die bereitgestellten Metadaten MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES Byte überschreiten.

java.lang.IllegalStateException

wenn die Sitzung beendet ist. Dies kann entweder ein expliziter Aufruf von endSession sein oder ein externer Grund, der über onSessionEnded angezeigt wird.