AddonSession

Kotlin |Java

@PublicApi
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
@PublicApi interface AddonSession.Builder Ein Builder für AddonSession.

Öffentliche Funktionen
ListenableFuture<Void!>!	endSession() Die Add-on-Sitzung wird beendet und die Verbindung zur Meet App wird getrennt.
Unit	endSuspension() Beendet den Status „Gesperrt“.
CoDoingClient!	getCoDoing() Gibt die Instanz CoDoingClient zurück.
CoWatchingClient!	getCoWatching() Gibt die Instanz CoWatchingClient zurück.
AddonMeetingInfo!	getMeetingInfo() Gibt Informationen zur verbundenen Besprechung zurück, z. B. die Besprechungs-URL.
Boolean	isSessionEnded() Gibt true zurück, wenn die Sitzung beendet ist.
Boolean	isSuspended() Gibt an, ob die Sitzung angehalten wurde.
Unit	resetCollaborationStartingState() Setzt den Startstatus des Add-ons zurück.
Unit	suspend() Sperrt die Add-on-Sitzung.
Unit	updateCollaborationStartingState(     startingState: CollaborationStartingState! ) Aktualisiert den Startstatus des Add-ons.
Unit	updateParticipantMetadata(metadata: ByteArray!) Aktualisiert die Metadaten für diesen Teilnehmer.

Öffentliche Funktionen

endSession

fun endSession(): ListenableFuture<Void!>!

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

fun endSuspension(): Unit

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

fun getCoDoing(): CoDoingClient!

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

fun getCoWatching(): CoWatchingClient!

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

fun getMeetingInfo(): AddonMeetingInfo!

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

fun isSessionEnded(): Boolean

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

fun isSuspended(): Boolean

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

fun resetCollaborationStartingState(): Unit

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

fun suspend(): Unit

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

fun updateCollaborationStartingState(
    startingState: CollaborationStartingState!
): Unit

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
startingState: CollaborationStartingState!	Startstatus des Add-ons

updateParticipantMetadata

fun updateParticipantMetadata(metadata: ByteArray!): Unit

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
metadata: ByteArray!	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.