Session

Représente une session OpenTok.

Utilisez la méthode \OpenTok\OpenTok->createSession() pour créer une session OpenTok. Utilisez la méthode getSessionId() de l'objet Session pour récupérer l'identifiant de la session.

Table des matières

generateToken()  : chaîne de caractères : Crée un jeton permettant de se connecter à la session. Pour authentifier un utilisateur, le client transmet ce jeton lors de la connexion à la session.

getArchiveMode()  : Mode archive : Détermine si la session est automatiquement archivée (ArchiveMode::ALWAYS) ou non (ArchiveMode::MANUAL).

getE2EE()  : bool : Indique si chiffrement de bout en bout est défini pour la session.

getLocation()  : chaîne de caractères : Renvoie l'adresse IP de l'indicateur de localisation.

getMediaMode()  : MediaMode : Renvoie MediaMode::RELAYED si les flux de la session seront transmis directement entre les pairs ; renvoie MediaMode::ROUTED si les flux de la session seront transmis via le routeur multimédia OpenTok.

getSessionId()  : chaîne de caractères : Renvoie l'identifiant de session, qui identifie de manière unique la session.

Méthodes

generateToken()

Crée un jeton permettant de se connecter à la session. Pour authentifier un utilisateur, le client transmet ce jeton lors de la connexion à la session.

public generateToken([array<string|int, mixed> $options = array() ][, bool $legacy = false ]) : string

À des fins de test, vous pouvez également générer des jetons ou vous connecter à votre Account Video API OpenTok.

Paramètres

$options : tableau<chaîne|entier, mixte> = tableau() : Ce tableau définit les options du jeton. Il contient les clés suivantes, qui sont toutes facultatives :

- `'role'` (string) — One of the constants defined in the RoleConstants
  class. The default role is publisher
- `'expireTime'` (int) — The timestamp for when the token expires,
  in milliseconds since the Unix epoch. The default expiration time is 24 hours
  after the token creation time. The maximum expiration time is 30 days after the
  token creation time.
- `'data'` (string) — A string containing connection metadata
  describing the end-user. For example, you can pass the user ID, name, or other data
  describing the end-user. The length of the string is limited to 1000 characters.
  This data cannot be updated once it is set.

$legacy : bool = false : Les jetons de connexion sont désormais des JWT signés avec SHA-256. Définissez cette valeur sur true pour créer un jeton au format T1 classique.

Valeurs de retour

chaîne de caractères —

La chaîne de caractères du jeton.

getArchiveMode()

Détermine si la session est automatiquement archivée (ArchiveMode::ALWAYS) ou non (ArchiveMode::MANUAL).

public getArchiveMode() : ArchiveMode

Voir OpenTok->createSession() et Mode archive.

Valeurs de retour

Mode archive —

getE2EE()

Que chiffrement de bout en bout est défini pour la session.

public getE2EE() : bool

Valeurs de retour

bool —

getLocation()

Renvoie l'adresse IP de l'indicateur de localisation.

public getLocation() : string

Voir OpenTok->createSession().

Valeurs de retour

chaîne de caractères —

getMediaMode()

Renvoie MediaMode::RELAYED si les flux de la session seront transmis directement entre les pairs ; renvoie MediaMode::ROUTED si les flux de la session seront transmis via le routeur multimédia OpenTok.

public getMediaMode() : MediaMode

Voir OpenTok->createSession() et MediaMode.

Valeurs de retour

MediaMode —

getSessionId()

Renvoie l'identifiant de session, qui identifie de manière unique la session.

public getSessionId() : string

Valeurs de retour

chaîne de caractères —