Transmissão

Representa uma transmissão de uma sessão do OpenTok.

Índice

$broadcastUrls  : objeto

$createdAt  : int

$id  : string

$isDvr  : bool

$isHls  : bool

$isLowLatency  : bool

$isStopped  : bool

$maxBitRate  : string

$multiBroadcastTag  : string

$partnerId  : string

$resolução  : string

$sessionId  : string

$status  : string

$streamMode  : string

$updatedAt  : int

__construct()  : misto

addStreamToBroadcast()  : bool : Adiciona uma transmissão a uma transmissão em andamento que foi iniciada com o streamMode definido como StreamMode.Manual. É possível chamar o método repetidamente com o mesmo ID de transmissão para ativar ou desativar o áudio ou o vídeo da transmissão na transmissão em andamento.

jsonSerialize()  : misto

removeStreamFromBroadcast()  : bool : Remove um stream de uma transmissão em andamento que foi iniciada com o streamMode definido como StreamMode.Manual.

stop()  : misto : Interrompe a transmissão.

updateLayout()  : misto : Atualiza o layout da transmissão.

Propriedades

$broadcastUrls

public object $broadcastUrls

Detalhes sobre os fluxos de transmissão HLS e RTMP. Para um fluxo HLS, a URL é fornecida. Consulte o Guia do desenvolvedor para transmissão ao vivo do OpenTok Para obter mais informações sobre como usar essa URL. Para cada transmissão RTMP, são fornecidos a URL do servidor RTMP e o nome da transmissão, juntamente com o status da transmissão RTMP.

$createdAt

public int $createdAt

O carimbo de data e hora em que a transmissão foi criada, expresso em segundos desde a época Unix.

$id

public string $id

O ID exclusivo da transmissão.

$isDvr

public bool $isDvr

Se a transmissão oferece suporte à funcionalidade de DVR para o fluxo HLS.

$isHls

public bool $isHls

Se a transmissão é compatível com HLS.

$isLowLatency

public bool $isLowLatency

Se a transmissão suporta o modo de baixa latência para o fluxo HLS.

$isStopped

public bool $isStopped

Se a transmissão está interrompida (verdadeiro) ou em andamento (falso).

$maxBitRate

public string $maxBitRate

Taxa de bits máxima permitida para a composição da transmissão. Deve estar entre 400.000 e 2.000.000

$multiBroadcastTag

public string $multiBroadcastTag

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

$partnerId

public string $partnerId

Sua chave da API do OpenTok.

$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.

$status

public string $status

Estado da transmissão. Pode ser started ou stopped

$streamMode

public string $streamMode

Se os streams incluídos na transmissão 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 na transmissão. Quando as transmissões são selecionadas manualmente (StreamMode.MANUAL), você especifica os fluxos a serem incluídos com base nas chamadas à função Broadcast.addStreamToBroadcast() e Broadcast.removeStreamFromBroadcast() métodos. No modo manual, é possível especificar se o áudio, o vídeo ou ambos de um stream serão incluídos na transmissão. Tanto no modo automático quanto no manual, o compositor de transmissão inclui os streams com base em fluxo regras de priorização.

$updatedAt

public int $updatedAt

A hora em que a transmissão foi iniciada ou encerrada, expressa em segundos desde a época Unix.

Métodos

__construct()

public __construct(mixed $broadcastData[, mixed $options = array() ]) : mixed

Parâmetros

$broadcastData : mixed

$options : mixed = array()

Valores de retorno

misto —

addStreamToBroadcast()

Adiciona um stream a uma transmissão em andamento que foi iniciada 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 na transmissão.

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

Parâmetros

$streamId : string : O ID do stream.

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

$hasVideo : bool : Se a transmissão 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.

jsonSerialize()

public jsonSerialize() : mixed

Valores de retorno

misto —

removeStreamFromBroadcast()

Remove uma transmissão de uma transmissão em andamento que foi iniciada com o streamMode definido como StreamMode.Manual.

public removeStreamFromBroadcast(string $streamId) : bool

Parâmetros

$streamId : string : O ID do stream.

Valores de retorno

bool —

Retorna `true` em caso de sucesso.

stop()

Interrompe a transmissão.

public stop() : mixed

Valores de retorno

misto —

updateLayout()

Atualiza o layout da transmissão.

public updateLayout(Layout $layout) : mixed

Veja Configurando o layout de vídeo para transmissões ao vivo pelo OpenTok.

Parâmetros

$layout : Layout : Um objeto que define o tipo de layout da transmissão.

Valores de retorno

misto —