AddonSession

@PublicApi
public interface AddonSession

Une session complémentaire.

Contient des méthodes communes à toutes les sessions de modules complémentaires. Pour accéder au visionnage à plusieurs et au visionnage à plusieurs, appelez respectivement getCoWatching et getCoDoing.

Résumé

Types imbriqués

Compilateur pour AddonSession.

Méthodes publiques
abstract ListenableFuture<Void>

Met fin à la session du module complémentaire et se déconnecte de l'application Meet.
abstract void

Quitter l'état "Suspendu".
abstract CoDoingClient

Renvoie l'instance CoDoingClient.
abstract CoWatchingClient

Renvoie l'instance CoWatchingClient.
abstract AddonMeetingInfo

Affiche les informations sur la réunion associée, telles que l'URL de la réunion.
abstract boolean

Renvoie true si la session est terminée.
abstract boolean

Indique si la session est suspendue.
abstract void

Réinitialise l'état initial du module complémentaire.
abstract void

Suspend la session du module complémentaire.
abstract void

Met à jour l'état initial du module complémentaire.
abstract void
updateParticipantMetadata(byte[] metadata)

Met à jour les métadonnées pour ce participant.

Méthodes publiques

endSession

abstract ListenableFuture<Void> endSession()

Met fin à la session complémentaire et se déconnecte de l'application Meet. Cela ne oblige pas Meet à mettre fin à la réunion et n'entraîne pas la fermeture de l'utilisateur.

Si la session est déjà terminée, il s'agit d'une opération no-op. Aucune exception ne sera générée.

Renvoie
ListenableFuture<Void>

Une ListenableFuture qui renvoie une réussite ou une AddonException en cas d'erreur inattendue

endSuspension

abstract void endSuspension()

Quitter l'état "Suspendu". L'application complémentaire peut à nouveau envoyer et recevoir des mises à jour.

Si l'état n'est pas suspendu, il s'agit d'une opération no-op.

Génère
java.lang.IllegalStateException

si la session est terminée. Il peut s'agir d'un appel explicite à endSession ou d'un motif externe révélé via onSessionEnded.

getCoDoing

abstract CoDoingClient getCoDoing()

Renvoie l'instance CoDoingClient.

Génère
java.lang.IllegalStateException

si la session a été créée sans appeler withCoDoing ou si elle est terminée

getCoWatching

abstract CoWatchingClient getCoWatching()

Renvoie l'instance CoWatchingClient.

Génère
java.lang.IllegalStateException

si la session a été créée sans appeler withCoWatching ou si elle est terminée

getMeetingInfo

abstract AddonMeetingInfo getMeetingInfo()

Affiche les informations sur la réunion associée, telles que l'URL de la réunion.

Génère
java.lang.IllegalStateException

si la session est terminée. Il peut s'agir d'un appel explicite à endSession ou d'un motif externe révélé via onSessionEnded.

isSessionEnded

abstract boolean isSessionEnded()

Renvoie true si la session est terminée. Cela peut être dû à un appel explicite à endSession ou à un motif externe révélé via onSessionEnded.

Génère
java.lang.IllegalStateException

si la session est terminée. Il peut s'agir d'un appel explicite à endSession ou d'un motif externe apparaissant via onSessionEnded.

isSuspended

abstract boolean isSuspended()

Indique si la session est suspendue. Voir suspend et endSuspension.

Génère
java.lang.IllegalStateException

si la session est terminée. Il peut s'agir d'un appel explicite à endSession ou d'un motif externe révélé via onSessionEnded.

resetCollaborationStartingState

abstract void resetCollaborationStartingState()

Réinitialise l'état initial du module complémentaire. L'état de départ reçu par les autres participants sera effacé. Seul l'initiateur peut réinitialiser l'état de départ.

suspend

abstract void suspend()

Suspend la session du module complémentaire. Cette action ne se déconnecte PAS de l'application Meet. Ainsi, le SDK évite d'envoyer des mises à jour à votre CoDoingHandler et CoWatchingHandler, et ignore les appels pour en informer les appels et ignorer les appels pour mettre à jour l'état global.

Si la session est déjà suspendue, il s'agit d'une opération no-op.

Par exemple, vous pouvez choisir d'appeler suspend lorsque la lecture s'interrompt pour un utilisateur (mais pas tous) pour voir une annonce, lorsqu'un utilisateur applique l'arrière-plan en arrière-plan, etc.

Génère
java.lang.IllegalStateException

si la session est terminée. Il peut s'agir d'un appel explicite à endSession ou d'un motif externe révélé via onSessionEnded.

updateCollaborationStartingState

abstract void updateCollaborationStartingState(
    CollaborationStartingState startingState
)

Met à jour l'état initial du module complémentaire. Ce message est reçu par les autres participants lorsqu'ils acceptent l'invitation à collaborer. Seul l'initiateur peut mettre à jour l'état de départ.

Paramètres
CollaborationStartingState startingState

l'état initial du module complémentaire

updateParticipantMetadata

abstract void updateParticipantMetadata(byte[] metadata)

Met à jour les métadonnées pour ce participant.

Pour recevoir des métadonnées d'autres participants, un gestionnaire doit être enregistré en appelant withParticipantMetadata lors de la création de l'AddonSession.

Les métadonnées encodées sont limitées à MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES octets par participant.

Paramètres
byte[] metadata

blob de métadonnées encodé décrivant les métadonnées pertinentes pour le participant local
Génère
java.lang.IllegalArgumentException

si les métadonnées fournies dépassent MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES octets
java.lang.IllegalStateException

si la session est terminée. Il peut s'agir d'un appel explicite à endSession ou d'un motif externe révélé via onSessionEnded.