Arquivo

addStreamToArchive() : bool : Adiciona um stream a um arquivo que está sendo reproduzido no momento e que foi iniciado com o parâmetro streamMode definido como StreamMode.Manual. É possível chamar o método repetidamente com o mesmo ID de stream para ativar ou desativar o áudio ou o vídeo do stream no arquivo.

delete() : misto : Exclui um arquivo do OpenTok.

getPermittedResolutions() : misto

jsonSerialize() : misto

removeStreamFromArchive() : bool : Remove um fluxo de um arquivo em execução no momento, que foi iniciado com o parâmetro streamMode definido como StreamMode.Manual.

stop() : misto : Interrompe a gravação do OpenTok, caso esteja sendo gravado.

toArray() : misto : Retorna uma representação em forma de matriz associativa deste objeto Archive.

toJson() : misto : Retorna uma representação em JSON deste objeto Archive.

Constantes

RESOLUÇÕES AUTOMÁTICAS PERMITIDAS

private mixed|null PERMITTED_AUTO_RESOLUTIONS = ['480x640', "640x480", "720x1280", "1280x720", "1080x1920", "1920x1080"]

Propriedades

$createdAt

public int $createdAt

A hora em que o arquivo foi criado, em milissegundos desde a época UNIX.

$duration

public string $duration

A duração do arquivo, em segundos.

$hasAudio

public bool $hasAudio

Se o arquivo possui uma faixa de áudio (true) ou não (false).

$hasVideo

public bool $hasVideo

Se o arquivo possui uma trilha de vídeo (true) ou não (false).

$id

public string $id

O ID do arquivo.

$multiArchiveTag

public string $multiArchiveTag

Se a opção “Arquivamento Múltiplo” estiver ativada, será gerada uma sequência de caracteres exclusiva para cada arquivamento simultâneo de uma sessão em andamento. Veja https://tokbox.com/developer/guides/archiving/#simultaneous-archives para mais informações.

$name

public string $name

O nome do arquivo. Se nenhum nome tiver sido fornecido na criação do arquivo, esse valor é definido como nulo.

$outputMode

public string $outputMode

O nome do arquivo. Se nenhum nome tiver sido fornecido na criação do arquivo, esse valor é definido como nulo.

$partnerId

public string $partnerId

A chave de API associada ao arquivo.

$motivo

public string $reason

Para arquivos com o status “interrompido” ou “falha”, esta string descreve o motivo pelo qual o arquivo foi interrompido (como “duração máxima excedida”) ou apresentou falha.

$resolução

public string $resolution

A resolução do arquivo pode ser “640x480” (SD paisagem, padrão), “1280x720” (HD paisagem), “1920x1080” (FHD paisagem), “480x640” (SD retrato), “720x1280” (HD retrato) ou “1080x1920” (FHD retrato). Pode ser recomendável usar a proporção retrato para arquivos que incluam transmissões de vídeo de dispositivos móveis (que geralmente usam a proporção retrato).

$sessionId

public string $sessionId

O ID da sessão do OpenTok associada a este arquivo.

$size

public string $size

O tamanho do arquivo MP4. Para arquivos que ainda não foram gerados, esse valor é definido como 0.

$status

public string $status

O status do arquivo, que pode ser um dos seguintes:

"disponível" — O arquivo está disponível para download na nuvem da OpenTok.
"expirado" — O arquivo não está mais disponível para download na nuvem da OpenTok .
"falha" — A gravação do arquivo falhou.
"em pausa" — O arquivamento está em andamento e nenhum cliente está publicando fluxos para a sessão. Quando um arquivamento está em andamento e algum cliente publica um fluxo, o status passa a ser "iniciado". Quando um arquivamento está "em pausa", nada é gravado. Quando um cliente começa a publicar um fluxo, a gravação inicia (ou é retomada). Se todos os clientes se desconectarem de uma sessão que está sendo arquivada, o status muda para “em pausa” e, após 60 segundos, a gravação do arquivo é interrompida (e o status muda para “parado”).
"iniciado" — O arquivo foi iniciado e está sendo gravado.
"parou" — O arquivo parou de gravar.
"enviado" — O arquivo está disponível para download no destino de envio — o bucket do Amazon S3 ou o contêiner do Windows Azure que você configurou para o seu Projeto OpenTok.

$streamMode

public string $streamMode

Se os streams incluídos no arquivo são selecionados automaticamente (StreamMode.AUTO) ou manualmente (StreamMode.MANUAL). Quando os fluxos são selecionados automaticamente (StreamMode.AUTO), todas as transmissões da sessão podem ser incluídas no arquivo. Quando as transmissões são selecionadas manualmente (StreamMode.MANUAL), você especifica os fluxos a serem incluídos com base nas chamadas à função Archive.addStreamToArchive() e Archive.removeStreamFromArchive() métodos. No modo manual, é possível especificar se o áudio, o vídeo ou ambos de um fluxo serão incluídos no arquivo. Tanto no modo automático quanto no manual, o criador de arquivos inclui os fluxos com base em fluxo regras de priorização.

$url

public string $url

A URL de download do arquivo MP4 disponível. Essa propriedade só é definida para um arquivo cujo status esteja definido como “disponível”; para outros arquivos (incluindo aqueles com o status “enviado”), essa propriedade é definida como nula. A URL de download é ofuscada, e o arquivo fica disponível nessa URL por apenas 10 minutos. Para gerar uma nova URL, chame o método Archive.listArchives() ou OpenTok.getArchive().

Métodos

addStreamToArchive()

Adiciona um stream a um arquivo que está sendo reproduzido no momento e que foi iniciado com o streamMode definido como StreamMode.Manual. É possível chamar o método repetidamente com o mesmo ID do stream para ativar ou desativar o áudio ou o vídeo do stream no arquivo.

public addStreamToArchive(string $streamId, bool $hasAudio, bool $hasVideo) : bool

Parâmetros

$streamId : string : O ID do stream.

$hasAudio : bool : Se o arquivo deve incluir o áudio da transmissão (true, valor padrão) ou não (false).

$hasVideo : bool : Se o arquivo deve incluir o vídeo da transmissão (true, valor padrão) ou não (false).

Valores de retorno

bool —

Retorna `true` em caso de sucesso.

delete()

Exclui um arquivo do OpenTok.

public delete() : mixed

Você só pode excluir um arquivo que tenha o status “disponível”, “enviado” ou “excluído”. A exclusão de um arquivo remove seu registro da lista de arquivos. No caso de um arquivo “disponível”, também remove o arquivo em si, tornando-o indisponível para download. No caso de um arquivo “excluído”, o arquivo permanece excluído.

Valores de retorno

misto —

getPermittedResolutions()

public static getPermittedResolutions() : mixed

Valores de retorno

misto —

jsonSerialize()

public jsonSerialize() : mixed

Valores de retorno

misto —

removeStreamFromArchive()

Remove um fluxo de um arquivo em execução que foi iniciado com o parâmetro streamMode definido como StreamMode.Manual.

public removeStreamFromArchive(string $streamId) : bool

Parâmetros

$streamId : string : O ID do stream.

Valores de retorno

bool —

Retorna `true` em caso de sucesso.

stop()

Interrompe a gravação do OpenTok, caso esteja em andamento.

public stop() : mixed

Os arquivos param automaticamente de gravar após 120 minutos ou quando todos os clientes tiverem se desconectado da sessão que está sendo arquivada.

Valores de retorno

misto —

toArray()

Retorna uma representação em forma de array associativo deste objeto Archive.

public toArray() : mixed

Valores de retorno

misto —

toJson()

Retorna uma representação JSON deste objeto Archive.

public toJson() : mixed

Valores de retorno

misto —

Arquivo

Índice

Constantes

RESOLUÇÕES AUTOMÁTICAS PERMITIDAS

Propriedades

$createdAt

$duration

$hasAudio

$hasVideo

$id

$multiArchiveTag

$name

$outputMode

$partnerId

$motivo

$resolução

$sessionId

$size

$status

$streamMode

$url

Métodos

addStreamToArchive()

Parâmetros

Valores de retorno

delete()

Tags

Valores de retorno

getPermittedResolutions()

Valores de retorno

jsonSerialize()

Valores de retorno

removeStreamFromArchive()

Parâmetros

Valores de retorno

stop()

Tags

Valores de retorno

toArray()

Tags

Valores de retorno

toJson()

Valores de retorno