Sessão

Representa uma sessão do OpenTok.

Use o método \OpenTok\OpenTok->createSession() para criar uma sessão do OpenTok. Use o método getSessionId() do objeto Session para obter o ID da sessão.

Índice

generateToken()  : string : Cria um token para se conectar à sessão. Para autenticar um usuário, o cliente envia um token ao se conectar à sessão.

getArchiveMode()  : Modo de arquivamento : Define se a sessão é arquivada automaticamente (ArchiveMode::ALWAYS) ou não (ArchiveMode::MANUAL).

getE2EE()  : bool : Se criptografia de ponta a ponta está definido para a sessão.

getLocation()  : string : Retorna o endereço IP da dica de localização.

getMediaMode()  : MediaMode : Retorna MediaMode::RELAYED se os fluxos da sessão forem transmitidos diretamente entre pares; retorna MediaMode::ROUTED se os fluxos da sessão forem transmitidos por meio do OpenTok Media Router.

getSessionId()  : string : Retorna o ID da sessão, que identifica a sessão de forma exclusiva.

Métodos

generateToken()

Cria um token para se conectar à sessão. Para autenticar um usuário, o cliente envia um token ao se conectar à sessão.

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

Para fins de teste, você também pode gerar tokens ou fazer login na sua Account da Video API da OpenTok.

Parâmetros

$options : array<string|int, mixed> = array() : Este array define as opções para o token. Ele inclui as seguintes chaves, todas opcionais:

- `'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 : Os tokens de conexão agora são JWTs assinados com SHA-256. Defina este parâmetro como true para criar um token usando o formato T1 antigo.

Valores de retorno

string —

A string do token.

getArchiveMode()

Define se a sessão é arquivada automaticamente (ArchiveMode::ALWAYS) ou não (ArchiveMode::MANUAL).

public getArchiveMode() : ArchiveMode

Veja OpenTok->createSession() e Modo de arquivamento.

Valores de retorno

Modo de arquivamento —

getE2EE()

Se criptografia de ponta a ponta está definido para a sessão.

public getE2EE() : bool

Valores de retorno

bool —

getLocation()

Retorna o endereço IP da sugestão de localização.

public getLocation() : string

Veja OpenTok->createSession().

Valores de retorno

string —

getMediaMode()

Retorna MediaMode::RELAYED se os fluxos da sessão forem transmitidos diretamente entre pares; retorna MediaMode::ROUTED se os fluxos da sessão forem transmitidos por meio do OpenTok Media Router.

public getMediaMode() : MediaMode

Veja OpenTok->createSession() e MediaMode.

Valores de retorno

MediaMode —

getSessionId()

Retorna o ID da sessão, que identifica a sessão de forma exclusiva.

public getSessionId() : string

Valores de retorno

string —