Sesión

Representa una sesión de OpenTok.

Utiliza el método \OpenTok\OpenTok->createSession() para crear una sesión de OpenTok. Utiliza el método getSessionId() del objeto Session para obtener el ID de la sesión.

Índice

generateToken()  : cadena : Crea un token para conectarse a la sesión. Para autenticar a un usuario, el cliente envía un token al conectarse a la sesión.

getArchiveMode()  : Modo de archivo : Indica si la sesión se archiva automáticamente (ArchiveMode::ALWAYS) o no (ArchiveMode::MANUAL).

getE2EE()  : bool : Si cifrado de extremo a extremo está programado para la sesión.

getLocation()  : cadena : Devuelve la dirección IP de la sugerencia de ubicación.

getMediaMode()  : MediaMode : Devuelve MediaMode::RELAYED si las transmisiones de la sesión se transmitirán directamente entre pares; devuelve MediaMode::ROUTED si las transmisiones de la sesión se transmitirán mediante el enrutador de medios de OpenTok.

getSessionId()  : cadena : Devuelve el ID de sesión, que identifica de forma única a la sesión.

Métodos

generateToken()

Crea un token para conectarse a la sesión. Para autenticar a un usuario, el cliente envía un token al conectarse a la sesión.

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

Para realizar pruebas, también puedes generar tokens o iniciar sesión en tu Account de la Video API de OpenTok.

Parámetros

$options : array<string|int, mixed> = array() : Este array define las opciones del token. Este array incluye las siguientes claves, todas ellas opcionales:

- `'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 : Los tokens de conexión son ahora JWT firmados con SHA-256. Establece este valor en true para crear un token utilizando el formato T1 heredado.

Valores de retorno

cadena —

La cadena del token.

getArchiveMode()

Define si la sesión se archiva automáticamente (ArchiveMode::ALWAYS) o no (ArchiveMode::MANUAL).

public getArchiveMode() : ArchiveMode

Véase OpenTok->createSession() y Modo de archivo.

Valores de retorno

Modo de archivo —

getE2EE()

Ya sea que cifrado de extremo a extremo está programado para la sesión.

public getE2EE() : bool

Valores de retorno

bool —

getLocation()

Devuelve la dirección IP de la sugerencia de ubicación.

public getLocation() : string

Véase OpenTok->createSession().

Valores de retorno

cadena —

getMediaMode()

Devuelve MediaMode::RELAYED si las transmisiones de la sesión se transmitirán directamente entre pares; devuelve MediaMode::ROUTED si las transmisiones de la sesión se transmitirán mediante el enrutador de medios de OpenTok.

public getMediaMode() : MediaMode

Véase OpenTok->createSession() y MediaMode.

Valores de retorno

MediaMode —

getSessionId()

Devuelve el ID de sesión, que identifica de forma única la sesión.

public getSessionId() : string

Valores de retorno

cadena —