Um objeto que representa uma transmissão ao vivo do OpenTok.

Não ligue para o new() construtor. Para iniciar uma transmissão ao vivo, chame o OpenTok.startBroadcast() método.

Características:
Nome Tipo Descrição
id String O ID da transmissão.
sessionId String O ID da sessão do OpenTok associada a esta transmissão.
projectId String A chave de API associada à transmissão.
createdAt Número A hora em que a transmissão foi criada, em milissegundos desde a época UNIX.
resolution String A resolução da transmissão: uma das seguintes opções: - “640x480” - “1280x720” - “1920x1080” - “480x640” - “720x1280” - “1080x1920” Pode ser recomendável usar uma proporção vertical para transmissões que incluam fluxos de vídeo de dispositivos móveis (que geralmente usam a proporção vertical). Essa propriedade é opcional.
broadcastUrls Objeto Um objeto que contém detalhes sobre as transmissões HLS e RTMP. - hls (String) — Se você especificou um endpoint HLS, o objeto inclui uma propriedade `hls`, que é definida como a URL da transmissão HLS. Observe que essa URL de transmissão HLS aponta para um arquivo de índice, uma lista de reprodução no formato .M3U8 que contém uma lista de URLs para arquivos de segmentos de mídia .ts (arquivos de fluxo de transporte MPEG-2). Embora as URLs tanto do arquivo de índice da lista de reprodução quanto dos arquivos de segmentos de mídia sejam fornecidas assim que a resposta HTTP for retornada, essas URLs não devem ser acessadas até 15 a 20 segundos depois, após o início da transmissão HLS, devido ao atraso entre a transmissão HLS e os fluxos ao vivo na sessão do OpenTok. Consulte https://developer.apple.com/library/ios/technotes/tn2288/\\_index.html Para obter mais informações sobre o arquivo de índice da lista de reprodução e os arquivos de segmentos de mídia para HLS. - hlsStatus (string) — Os estados possíveis para o campo “hlsStatus” são os seguintes: - 'connecting': o servidor OpenTok está iniciando os transcodificadores. Este é o estado inicial - 'ready': o servidor OpenTok foi inicializado com sucesso, mas a CDN não está consumindo mídia - 'live': o servidor OpenTok foi inicializado com sucesso e a CDN está consumindo mídia - 'ended': o fluxo de origem foi encerrado (se o DVR estiver habilitado e for solicitada mídia pré-gravada, o status mudará para 'live') - 'error': há um erro na plataforma OpenTok. - rtmp (Matriz de objetos) — Se você especificou pontos finais de fluxo RTMP, o objeto inclui uma propriedade rtmp. Trata-se de uma matriz de objetos que contém informações sobre cada um dos fluxos RTMP. Cada um desses objetos possui as seguintes propriedades: - id O ID que você atribuiu ao stream RTMP - serverUrl A URL do servidor - streamName O nome do stream - status O status do fluxo
maxDuration Número O tempo máximo permitido para a transmissão, em segundos. Após esse tempo, a transmissão será interrompida automaticamente, caso ainda esteja em andamento.
streamMode String O modo de transmissão para a transmissão. Pode ser definido como uma das seguintes opções: - "auto" — As transmissões incluídas na transmissão são selecionadas automaticamente (padrão). - "manual" — Especifique as transmissões a serem incluídas com base nas chamadas para o OpenTok.addBroadcastStream() e OpenTok.removeBroadcastStream() métodos.
streams Matriz Uma matriz de objetos correspondentes aos streams que estão sendo transmitidos no momento. Esse valor só é definido para uma transmissão cujo status esteja definido como “iniciado” e cujo streamMode esteja definido como “manual”. Cada objeto da matriz inclui as seguintes propriedades: - streamId -- O ID do stream incluído na transmissão. - hasAudio -- Se o áudio da transmissão está incluído na transmissão. - hasVideo -- Se o vídeo da transmissão está incluído na transmissão.
multiBroadcastTag String Defina este parâmetro para permitir a transmissão simultânea de várias transmissões para a mesma sessão. Defina-o como uma sequência de caracteres exclusiva para cada transmissão simultânea de uma sessão em andamento. Observe que o multiBroadcastTag O valor não está incluído na resposta dos métodos que listam transmissões ao vivo e obtêm informações sobre uma transmissão ao vivo.

Métodos

Nome Descrição
stop(callback) Interrompe a transmissão ao vivo.

stop(callback)

Interrompe a transmissão ao vivo.

As transmissões param automaticamente de gravar após 120 minutos ou quando todos os clientes se desconectarem da sessão que está sendo transmitida.

Parâmetros:
Nome Tipo Descrição
callback função A função a ser chamada ao concluir a operação. Dois argumentos são passados para a função: - error — Um objeto de erro (caso a chamada ao método falhe). - broadcast — O objeto Broadcast.