SessionProperties.Builder

java.lang.Object

com.opentok.SessionProperties.Builder

Classe englobante : : Propriétés de session

classe publique statique SessionProperties.Builder étend Objet

Utilisez cette classe pour créer un objet SessionProperties.

Voir aussi : : - SessionProperties

Résumé du constructeur

Constructeurs

Constructeur

Description

Builder()

Résumé de la méthode

Toutes les méthodes · Méthodes d'instance · Méthodes concrètes

Modificateur et type

Méthode

Description

SessionProperties.Builder

archiveMode(ArchiveMode archiveMode)

Appelez cette méthode pour déterminer si la session sera automatiquement archivée (ArchiveMode.ALWAYS) ou pas (ArchiveMode.MANUAL).

SessionProperties.Builder

archiveName(String archiveName)

Indique le nom de l'archive pour toutes les archives de la session d'archivage automatique.

SessionProperties.Builder

archiveResolution(Resolution archiveResolution)

Indique la résolution d'archivage pour toutes les archives de la session d'archivage automatique.

SessionProperties

build()

Crée l'objet SessionProperties.

SessionProperties.Builder

endToEndEncryption()

Permet chiffrement de bout en bout pour une session acheminée.

SessionProperties.Builder

location(String location)

Appelez cette méthode pour définir une adresse IP que les serveurs OpenTok utiliseront pour localiser la session au sein de leur réseau mondial.

SessionProperties.Builder

mediaMode(MediaMode mediaMode)

Appelez cette méthode pour déterminer si la session transmettra des flux à l'aide du routeur multimédia OpenTok (MediaMode.ROUTED) ou pas (MediaMode.RELAYED).

Méthodes héritées de la classe java.lang.Objet

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

Informations sur le constructeur

Constructeur

public Builder()

Détails de la méthode

emplacement

public SessionProperties.Builder emplacement(Chaîne emplacement) lance InvalidArgumentException

Appelez cette méthode pour définir une adresse IP que les serveurs OpenTok utiliseront pour localiser la session au sein de leur réseau mondial. Si vous ne définissez pas d'indication de localisation, les serveurs OpenTok se baseront sur le premier client se connectant à la session.

Paramètres : : location - L'adresse IP qui servira d'indication de localisation.

Renvoie : : L'objet SessionProperties.Builder avec le paramètre d'indication d'emplacement.

Lancers : : InvalidArgumentException

mediaMode

public SessionProperties.Builder mediaMode(MediaMode mediaMode)

Appelez cette méthode pour déterminer si la session transmettra des flux à l'aide du routeur multimédia OpenTok (MediaMode.ROUTED) ou pas (MediaMode.RELAYED). Par défaut, le mediaMode propriété est définie sur MediaMode.RELAYED.

Avec la mediaMode est définie comme étant la propriété MediaMode.RELAYED, la session tentera de transmettre les flux directement entre les clients. Si les clients ne parviennent pas à se connecter en raison de restrictions de pare-feu, la session utilise le serveur TURN d'OpenTok pour relayer les flux audio et vidéo .

Le Routeur multimédia OpenTok offre les avantages suivants :

Le routeur multimédia OpenTok permet de réduire la consommation de bande passante lors des sessions multipartites. (Lorsque le mediaMode est fixée à MediaMode.RELAYED, chaque client doit envoyer un flux audio-vidéo distinct à chaque client abonné à ce flux.)
Le routeur multimédia OpenTok permet d'améliorer la qualité de l'expérience utilisateur grâce à solution de secours audio et récupération vidéo. Grâce à ces fonctionnalités, si la connexion d'un client se détériore au point de ne plus permettre la lecture de la vidéo d'un flux auquel il est abonné, la vidéo est interrompue sur ce client (sans affecter les autres clients), et le client ne reçoit alors que le son. Si la connexion du client s'améliore, la vidéo reprend.
Le routeur multimédia OpenTok prend en charge le archivage fonctionnalité qui vous permet d'enregistrer, de sauvegarder et de récupérer des sessions OpenTok.

Paramètres : : mediaMode - Définir la valeur définie dans le MediaMode enum.

Renvoie : : L'objet SessionProperties.Builder avec le paramètre de mode multimédia.

archiveMode

public SessionProperties.Builder archiveMode(Mode archive archiveMode)

Appelez cette méthode pour déterminer si la session sera automatiquement archivée (ArchiveMode.ALWAYS) ou pas (ArchiveMode.MANUAL).

L'utilisation d'une session toujours archivée nécessite également le mode « routed media » (MediaMode.ROUTED).

Paramètres : : archiveMode - Le mode « Archive ».

Renvoie : : L'objet SessionProperties.Builder avec le paramètre de mode d'archivage.

résolution d'archivage

public SessionProperties.Builder archiveResolution(Résolution (résolution d'archivage)

Indique la résolution d'archivage pour toutes les archives de la session archivée automatiquement. Une session qui commence par le mode d'archivage ArchiveMode.ALWAYS appliquera cette résolution à l'ensemble des archives de cette session.

Paramètres : : archiveResolution - La résolution de l'archivage automatique sous forme d'énumération.

Renvoie : : L'objet SessionProperties.Builder avec le paramètre de résolution des archives.

nom_de_l'archive

public SessionProperties.Builder archiveName(Chaîne archiveName)

Indique le nom de l'archive pour toutes les archives de la session à archivage automatique. Une session qui commence par le mode d'archivage ArchiveMode.ALWAYS utilisera ce nom d'archive pour toutes les archives de cette session.

Paramètres : : archiveName - Le nom de l'archive, d'une longueur maximale de 80 caractères.

Renvoie : : L'objet SessionProperties.Builder avec le paramètre de nom d'archive.

chiffrement de bout en bout

public SessionProperties.Builder endToEndEncryption()

Permet chiffrement de bout en bout pour une session acheminée. Vous devez également définir mediaMode(MediaMode) à MediaMode.ROUTED lors de l'appel de cette méthode.

Retourne : : L'objet SessionProperties.Builder dont la propriété e2ee est définie sur true.

construire

public Propriétés de session build()

Crée l'objet SessionProperties.

Renvoie : : L'objet SessionProperties.