Construtor

new OpenTok(apiKey, apiSecret)

Contém métodos para criar sessões do OpenTok, gerar tokens, trabalhar com arquivos e muito mais.

Para criar um novo objeto OpenTok, chame o construtor do OpenTok com sua chave de API do OpenTok e o segredo da API do seu Account da Video API da Vonage. Não compartilhe publicamente seu segredo da API. Você o utilizará com o construtor do OpenTok (apenas no seu servidor web) para criar sessões do OpenTok.

Certifique-se de incluir o SDK completo do OpenTok para Node.js no seu servidor web.

Parâmetros:
Nome Tipo Descrição
apiKey String Sua chave da API do OpenTok. (Consulte sua Página da conta da Video API da Vonage.)
apiSecret String Seu segredo da API do OpenTok. (Consulte seu Página da conta da Video API da Vonage.)

Métodos

Nome Descrição
addArchiveStream(archiveId, streamId, archiveOptions, callback) Adiciona um fluxo a um arquivo cujo `streamMode` está definido como “manual”.
addBroadcastStream(broadcastId, streamId, broadcastOptions, callback) Adiciona um stream a uma transmissão cujo `streamMode` está definido como “manual”.
createSession(options, callback) Cria uma nova sessão do OpenTok.
deleteArchive(archiveId, callback) Exclui um arquivo do OpenTok.
dial(sessionId, token, sipUri, options) Liga a um gateway SIP para inserir um fluxo apenas de áudio na sua sessão do OpenTok.
disableForceMute(sessionId, callback) Desativa o estado de mudo ativo da sessão.
forceDisconnect(sessionId, connectionId, callback) Desconecta um participante de uma sessão do OpenTok.
forceMuteAll(sessionId, opts, callback) Faz com que todos os fluxos (exceto uma matriz opcional de fluxos) em uma sessão silenciem o áudio publicado.
forceMuteStream(sessionId, streamId, callback) Forçar a silenciar o áudio de uma transmissão específica em uma sessão.
generateToken(sessionId, options, generateT1Token) Cria um token para se conectar a uma sessão do OpenTok.
getArchive(archiveId, callback) Obtém um Arquivo objeto correspondente ao ID de arquivo fornecido.
getBroadcast(broadcastId, callback) Retorna informações sobre uma transmissão ao vivo.
getRender(renderId, callback) Obtém um Renderizar objeto correspondente ao ID de renderização fornecido.
getStream(sessionId, options, callback) Obtém informações sobre um fluxo.
listArchives(options, callback) Recupera uma lista de Arquivo objetos, representando arquivos concluídos e em andamento, para sua chave de API.
listBroadcasts(options, callback) Recupera uma lista de Transmissão objetos, representando transmissões concluídas e em andamento, associados à sua chave de API.
listRenders(options, callback) Recupera uma lista de Renderizar objetos, representando quaisquer renderizações nos estados “inicial”, “em execução”, “parado” ou “com falha”, para sua chave de API.
listStreams(sessionId, callback) Recupera uma lista de Transmissão objetos que representam fluxos atuais em uma sessão.
playDTMF(sessionId, connectionId, digits, callback) Envie dígitos DTMF para todos os participantes de uma sessão ativa do OpenTok ou para um cliente específico conectado a essa sessão.
removeArchiveStream(archiveId, streamId, callback) Remove um fluxo de um arquivo composto cujo `streamMode` esteja definido como “manual”.
removeBroadcastStream(broadcastId, streamId, callback) Remove um stream de uma transmissão cujo streamMode esteja definido como “manual”.
setArchiveLayout(archiveId, type, stylesheet, screenshareType, callback) Define o tipo de layout para um arquivo composto.
setBroadcastLayout(broadcastId, type, stylesheet, screenshareType, callback) Define (ou atualiza) o layout da transmissão.
setStreamClassLists(sessionId, classListArray, callback) Define a lista de classes de layout para fluxos em uma sessão.
signal(sessionId, connectionId, payload, callback) Envia um sinal para todas as conexões de uma sessão ou para uma conexão específica.
startArchive(sessionId, options, callback) Inicia o arquivamento de uma sessão do OpenTok.
startBroadcast(sessionId, options, callback) Inicia uma transmissão ao vivo.
startCaptions(sessionId, token, options, callback) Ativa as legendas em tempo real para uma sessão do OpenTok.
startCaptions(captionId, callback)
startRender(options, callback) Inicia um Experience Composer para uma sessão do OpenTok.
stopArchive(archiveId, callback) Interrompe um arquivo do OpenTok que está sendo gravado.
stopBroadcast(broadcastId, callback) Interrompe uma transmissão ao vivo.
stopRender(renderId, callback) Interrompe um Experience Composer que está sendo renderizado.
websocketConnect(sessionId, token, websocketUri, options, callback) Envia áudio de uma sessão da Video API da Vonage para um WebSocket.

addArchiveStream(archiveId, streamId, archiveOptions, callback)

Adiciona um stream a um arquivo cujo `streamMode` está definido como “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.

Parâmetros:
Nome Tipo Descrição
archiveId String O ID do arquivo.
streamId String O ID do stream a ser adicionado ao arquivo.
archiveOptions Objeto Um objeto que possui estas propriedades: - hasAudio — Se o arquivo gerado deve incluir o áudio do stream (true, valor padrão) ou não (false). - hasVideo — Se o arquivo gerado deve incluir o vídeo da transmissão (true, valor padrão) ou não (false).
callback função A função a ser chamada ao concluir a operação. É passado um argumento para a função - error — Um objeto de erro (caso a chamada ao método falhe).

addBroadcastStream(broadcastId, streamId, broadcastOptions, callback)

Adiciona um stream a uma transmissão cujo `streamMode` está definido como “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.

Parâmetros:
Nome Tipo Descrição
broadcastId String O ID da transmissão.
streamId String O ID da transmissão a ser adicionado à transmissão em direto.
broadcastOptions Objeto Um objeto que possui estas propriedades: - hasAudio — Se a transmissão deve incluir o áudio da transmissão em streaming (true, valor padrão) ou não (false). - hasVideo — Se a transmissão deve incluir o vídeo da transmissão ao vivo (verdadeiro, valor padrão) ou não (falso).
callback função Um método de retorno de chamada que recebe dois parâmetros: error, que é atribuído a um objeto Error em caso de erro, e broadcast, que está definido para um Transmissão objeto em caso de sucesso.

createSession(opções, callback)

Cria uma nova sessão do OpenTok. A sessão é passada como Sessão objeto na função de retorno de chamada . A sessionId A propriedade é o ID da sessão, que identifica de forma exclusiva a sessão. Em caso de erro, um objeto Error é passado para a função de retorno de chamada.

Por exemplo, ao usar a biblioteca OpenTok.js, utilize o ID da sessão ao chamar o OT.initSession() método (para inicializar uma sessão do OpenTok).

As sessões do OpenTok não expiram. No entanto, os tokens de autenticação expiram (consulte o método generateToken(String, TokenOptions)). Observe também que as sessões não podem ser encerradas explicitamente.

Uma string de ID de sessão pode ter até 255 caracteres. Você também pode criar uma sessão usando o API REST do OpenTok ou fazendo login na sua Account da Video API da Vonage.

Parâmetros:
Nome Tipo Descrição
options Objeto Este objeto define opções para a sessão, incluindo as seguintes propriedades (ambas opcionais): - location (String) — Um endereço IP que os servidores do OpenTok usarão para localizar a sessão na rede global do OpenTok. Se você não definir uma indicação de localização, os servidores do OpenTok se basearão no primeiro cliente que se conectar à sessão. - e2ee (Booleano) — Determina se [end-to-end encryption](https://tokbox.com/developer/guides/end-to-end-encryption/) for the OpenTok session. Set to "verdadeiro"or"falso". - mediaMode (String) — Determines whether the session will transmit streams using the OpenTok Media Router ("derrotado") or not ("transmitido"). By default, the setting is "transmitido". With the mediaModeparameter set to"transmitido", the session will attempt to transmit streams directly between clients. If clients cannot connect due to firewall restrictions, the session uses the OpenTok TURN server to relay audio-video streams. The [OpenTok Media Router](/opentok/guides/create-session/#media-mode) provides the following benefits: - archiveMode (String) — Whether the session is automatically archived ("sempre") or not ("manual"). By default, the setting is "manual", and you must call the StartArchive()method of the OpenTok object to start archiving. To archive the session (either automatically or not), you must set themediaModeparameter to "derrotado". - nome do arquivo(String) — The name of the archives to be used in auto-archived sessions. The length of the archive name can be up to 80 chars. Due to encoding limitations the following special characters are translated to a colon (:) character: ~, -, \_. -resolução do arquivo(Enum) — The resolution of archives in an auto-archived session. Valid values are "480x640", "640x480", "720x1280", "1280x720", "1080x1920", and "1920x1080". - The OpenTok Media Router can decrease bandwidth usage in multiparty sessions. (When themediaModeparameter is set to"retransmitido", cada cliente deve enviar um fluxo de áudio e vídeo separado para cada cliente inscrito nele.) - O OpenTok Media Router pode melhorar a qualidade da experiência do usuário por meio de solução alternativa para áudio e recuperação de vídeo. Com esses recursos, se a conectividade de um cliente se deteriorar a ponto de não suportar o vídeo de uma transmissão à qual ele está inscrito, o vídeo é interrompido para esse cliente (sem afetar os demais), e o cliente passa a receber apenas o áudio. Se a conectividade do cliente melhorar, o vídeo é restabelecido. - O OpenTok Media Router suporta o arquivamento recurso que permite gravar, salvar e recuperar sessões do OpenTok.
callback função A função que é chamada quando a operação é concluída. Essa função recebe dois argumentos: - error — Em caso de falha, este parâmetro é definido como um objeto Error. Verifique a mensagem de erro para obter mais detalhes. Em caso de sucesso, ele é definido como null. - session — Em caso de sucesso, esse parâmetro é definido como um Sessão objeto. A propriedade sessionId desse objeto é o ID da sessão. Em caso de erro, esse parâmetro não é definido.

deleteArchive(archiveId, callback)

Exclui um arquivo do OpenTok.

Só é possível excluir um arquivo cujo status seja “disponível” ou “carregado”. A exclusão de um arquivo remove seu registro da lista de arquivos. No caso de um arquivo “disponível”, isso também remove o arquivo em si, tornando-o indisponível para download.

Parâmetros:
Nome Tipo Descrição
archiveId String O ID do arquivo que você deseja excluir.
callback função A função a ser chamada ao concluir a operação. Se a exclusão do arquivo for bem-sucedida, a função será chamada sem que nenhum argumento seja passado. Em caso de falha, um objeto de erro será passado para a função.

dial(sessionId, token, sipUri, options)

Liga para um gateway SIP para inserir um fluxo apenas de áudio na sua sessão do OpenTok. Faz parte do recurso SIP .

Parâmetros:
Nome Tipo Descrição
sessionId O ID da sessão correspondente à sessão à qual o usuário se conectará.
token O token correspondente ao ID da sessão que o usuário SIP utilizará para se conectar.
sipUri O URI SIP que o recurso de interconexão SIP irá discar.
options Objeto Um objeto de opções opcional com as seguintes propriedades (todas opcionais): - headers (Objeto) — Cabeçalhos personalizados a serem adicionados à solicitação SIP INVITE iniciada pelo OpenTok para a plataforma SIP de terceiros. - auth (Objeto) — As credenciais a serem utilizadas para a autenticação HTTP Digest, caso isso seja exigido pela plataforma SIP de terceiros. - "username" -- O nome de usuário a ser utilizado na solicitação SIP INVITE. - “password” — A senha a ser usada na solicitação SIP INVITE. - secure (Booleano) — Se os fluxos de mídia SIP devem ser transmitidos criptografados ou não. - from (String) — O número ou a sequência de caracteres que será enviada ao número SIP final como identificador do chamador. Deve ser uma sequência de caracteres no formato from@example.com, onde from pode ser uma sequência de caracteres ou um número. Se from é definido como um número (por exemplo, "14155550101@example.com"), ele aparecerá como o número de origem nos telefones PSTN. Se from não está definido ou está definido como uma string (por exemplo, "joe@example.com"), +00000000 aparecerá como o número de origem nos telefones da rede PSTN. - video (Booleano) — Um indicador booleano que indica se a chamada SIP incluirá vídeo (true) ou não (false, o padrão). Com o vídeo incluído, o vídeo do cliente SIP é incorporado ao fluxo do OpenTok que é enviado para a sessão do OpenTok. O cliente SIP receberá um fluxo de vídeo composto dinamicamente a partir dos fluxos publicados na sessão do OpenTok. Este é um recurso em fase beta. - observeForceMute (opcional) Se o terminal SIP aceita a ação de silenciamento forçado por outros clientes, como moderadores (true) ou não (false, o padrão). Consulte Silenciar o áudio das transmissões em uma sessão. - streams (opcional) Os IDs dos fluxos dos participantes que serão assinados pelo participante SIP. Se não forem fornecidos, todos os fluxos da sessão serão selecionados.
Devoluções:

A SipInterconnect objeto com as seguintes propriedades:

  • id -- O ID exclusivo da conferência da chamada SIP
  • connectionId -- O ID da conexão do fluxo apenas de áudio que representa a chamada SIP
  • streamId -- O ID do fluxo de áudio que representa a chamada SIP

desativarForçamentoDeSilenciamento(idDaSessão, callback)

Desativa o estado de mudo ativo da sessão. Após chamar esse método, os novos streams publicados na sessão não terão mais o áudio silenciado.

Depois de chamar a OpenTok.forceMuteAll() método, todas as transmissões publicadas após a chamada são publicadas com o áudio silenciado. Ao chamar o OpenTok.disableForceMute() Com esse método, as transmissões futuras publicadas na sessão não são silenciadas (mas quaisquer transmissões já silenciadas permanecem silenciadas).

Parâmetros:
Nome Tipo Descrição
sessionId O ID da sessão.
callback função A função a ser chamada ao concluir a operação. Um argumento é passado para a função error — um erro que indica que a chamada falhou. Esse valor é definido como nulo se a chamada for bem-sucedida.

forceDisconnect(sessionId, connectionId, callback)

Desconecta um participante de uma sessão do OpenTok. Este é o equivalente, no lado do servidor, ao Método `forceDisconnect()` no OpenTok.js

Parâmetros:
Nome Tipo Descrição
sessionId O ID da sessão do OpenTok à qual o cliente que você deseja desconectar está conectado.
connectionId O ID da conexão do cliente que você deseja desconectar.
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).

forceMuteAll(sessionId, opts, callback)

Obliga todas as transmissões (exceto um array opcional de transmissões) em uma sessão a silenciar o áudio publicado.

Além das transmissões existentes, todas as transmissões publicadas após a chamada deste método são publicadas com o áudio silenciado. É possível remover o estado de silêncio de uma sessão chamando o método OpenTok.disableForceMute() método.

Parâmetros:
Nome Tipo Descrição
sessionId O ID da sessão.
opts Um objeto que contém as seguintes propriedades: - excudedStreamIds (Matriz de strings) — Uma matriz de IDs de stream a serem excluídos do silenciamento. Isso é opcional. Se você não definir essa propriedade, todas as matrizes da sessão serão silenciadas.
callback função A função a ser chamada ao concluir a operação. Um argumento é passado para a função error — um erro que indica que a chamada falhou. Esse valor é definido como nulo se a chamada for bem-sucedida.

forceMuteStream(sessionId, streamId, callback)

Forçar a silenciar o áudio de uma transmissão específica em uma sessão.

Parâmetros:
Nome Tipo Descrição
sessionId String O ID da sessão.
streamId String O ID do stream.
callback função A função a ser chamada ao concluir a operação. Um argumento é passado para a função error — um erro que indica que a chamada falhou. Esse valor é definido como nulo se a chamada for bem-sucedida.

generateToken(sessionId, options, generateT1Token)

Cria um token para se conectar a uma sessão do OpenTok. Para autenticar um usuário que está se conectando a uma sessão do OpenTok, o cliente envia um token ao se conectar à sessão.

Para fins de teste, você também pode gerar um token fazendo login na sua Account da Video API da Vonage.

Parâmetros:
Nome Tipo Descrição
sessionId O ID da sessão correspondente à sessão à qual o usuário se conectará.
options Um objeto que define opções para o token (cada uma delas é opcional): - role (String) — A função do token. Cada função define um conjunto de permissões concedidas ao token: - 'subscriber' — Um assinante só pode se inscrever em canais. - 'publisher' — Um editor pode publicar fluxos, assinar fluxos e enviar sinais. (Esse é o valor padrão caso você não especifique uma função.) - 'publisheronly' — Um editor só pode publicar transmissões, mas não pode se inscrever em transmissões. - 'moderator' — Além dos privilégios concedidos a um editor, um moderador pode desempenhar funções de moderação, como forçar clientes a se desconectarem, interromper a transmissão de streams ou silenciar o áudio em streams publicados. Consulte o Guia do desenvolvedor sobre moderação. - expireTime (Número) — O tempo de validade do token, em segundos desde a época UNIX. O tempo máximo de validade é de 30 dias após a data de criação. Se for especificado um número fracionário, ele será arredondado para baixo para o número inteiro mais próximo. O tempo de validade padrão é de 24 horas após a data de criação do token. - data (String) — Uma string contendo metadados de conexão que descrevem o usuário final. Por exemplo, é possível passar o ID do usuário, o nome ou outros dados que descrevam o usuário final. O comprimento da string é limitado a 1.000 caracteres. Esses dados não podem ser atualizados depois de definidos. - initialLayoutClassList (Matriz) — Uma matriz de nomes de classes (cadeias de caracteres) a serem usadas como classes de layout iniciais para os streams publicados pelo cliente. As classes de layout são utilizadas para personalizar o layout dos vídeos em transmissões ao vivo e arquivos compilados.
generateT1Token Os tokens de conexão agora são JWTs assinados com SHA-256. Defina isso como true para criar um token usando o formato T1 antigo.
Devoluções:

A string do token.

getArchive(archiveId, callback)

Obtém um Arquivo objeto correspondente ao ID de arquivo fornecido.

Parâmetros:
Nome Tipo Descrição
archiveId String O ID do arquivo.
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). - archive — O Arquivo objeto.

getBroadcast(broadcastId, callback)

Retorna informações sobre uma transmissão ao vivo.

Parâmetros:
Nome Tipo Descrição
broadcastId String O ID da transmissão.
callback função Um método de retorno de chamada que recebe dois parâmetros: error, que é atribuído a um objeto Error em caso de erro, e broadcast, que está definido para um Transmissão objeto em caso de sucesso.

getRender(renderId, callback)

Obtém um Renderizar objeto correspondente ao ID de renderização fornecido.

Parâmetros:
Nome Tipo Descrição
renderId String O ID da renderizaçã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). - render — O Renderizar objeto.

getStream(sessionId, options, callback)

Obtém informações sobre um stream. O stream deve estar ativo em uma sessão do OpenTok.

Parâmetros:
Nome Tipo Descrição
sessionId String O ID da sessão do OpenTok que contém a transmissão.
options String O ID do stream.
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). Esse objeto é definido como `null` se não houver erro. A chamada a este método resulta em um erro se for passado um ID de fluxo inválido ou um ID de sessão inválido. - stream — O Transmissão objeto. Esse objeto inclui propriedades que definem o fluxo. Seu valor fica indefinido caso ocorra um erro.

listArchives(opções, callback)

Recupera uma lista de Arquivo objetos, representando arquivos que estão tanto concluídos quanto em andamento, para sua chave de API.

Parâmetros:
Nome Tipo Descrição
options Objeto Um parâmetro de opções com três propriedades: - count — O número máximo de arquivos a serem retornados. O número padrão de arquivos retornados é 50 (ou menos, se houver menos de 50 arquivos). O método retorna no máximo 1.000 arquivos. - offset — O deslocamento do primeiro arquivo da lista (começando pelo primeiro arquivo registrado como deslocamento 0). 1 é o deslocamento do arquivo que começou antes do arquivo mais recente. Essa propriedade é opcional; o valor padrão é 0. - sessionId — Especifique o ID de uma sessão para recuperar arquivos especificamente dessa sessão. Essa propriedade é opcional. Quando nenhum ID de sessão for especificado, o método retornará arquivos de qualquer sessão criada com sua chave de API. Se você não passar um options argumento, o método retorna até 1.000 arquivos, começando pelo primeiro arquivo registrado.
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). - archives — Uma variedade de Arquivo objetos.

listBroadcasts(options, callback)

Recupera uma lista de Transmissão objetos, representando transmissões que estão tanto concluídas quanto em andamento, para sua chave de API.

Parâmetros:
Nome Tipo Descrição
options Objeto Um parâmetro de opções com três propriedades: - count — O número máximo de transmissões a serem retornadas. O número padrão de transmissões retornadas é 50 (ou menos, se houver menos de 50 transmissões). O método retorna no máximo 1.000 transmissões. - offset — O deslocamento da primeira transmissão da lista (começando pela primeira transmissão registrada como deslocamento 0). 1 é o deslocamento da transmissão que começou antes da transmissão mais recente. Essa propriedade é opcional; o valor padrão é 0. - sessionId — Especifique o ID de uma sessão para recuperar transmissões específicas dessa sessão. Essa propriedade é opcional. Quando nenhum ID de sessão for especificado, o método retornará transmissões de qualquer sessão criada com sua chave de API. Se você não passar um options Com esse argumento, o método retorna até 1.000 transmissões, começando pela primeira transmissão registrada.
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). - broadcasts — Uma variedade de Transmissão objetos.

listRenders(options, callback)

Recupera uma lista de Renderizar objetos, representando quaisquer renderizações nos estados inicial, em execução, interrompido ou com falha, para sua chave de API.

Parâmetros:
Nome Tipo Descrição
options Objeto Um parâmetro de opções com três propriedades: - count — O número máximo de renderizações a serem retornadas. O número padrão de renderizações retornadas é 50 (ou menos, se houver menos de 50 renderizações). O método retorna no máximo 1.000 renderizações. - offset — O deslocamento da primeira renderização da lista (começando pela primeira renderização registrada como deslocamento 0). 1 é o deslocamento da renderização que começou antes da renderização mais recente. Essa propriedade é opcional; o valor padrão é 0. - sessionId — Especifique o ID de uma sessão para recuperar renderizações específicas dessa sessão. Essa propriedade é opcional. Quando nenhum ID de sessão for especificado, o método retornará renderizações de qualquer sessão criada com sua chave de API. Se você não passar um options argumento, o método retorna até 1.000 renderizações, começando pela primeira renderização registrada.
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). - renders — Uma variedade de Renderizar objetos.

listStreams(sessionId, callback)

Recupera uma lista de Transmissão objetos que representam fluxos atuais em uma sessão.

Parâmetros:
Nome Tipo Descrição
sessionId String O ID da sessão do OpenTok que contém as transmissões.
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). Esse objeto é definido como nulo se não houver erro. A chamada a este método resulta em um erro se for passado um ID de sessão inválido. - streams — Uma variedade de Transmissão objetos. Cada objeto Stream inclui propriedades que definem o fluxo. Esse valor fica indefinido se ocorrer um erro.

playDTMF(sessionId, connectionId, digits, callback)

Enviar dígitos DTMF para todos os participantes de uma sessão ativa do OpenTok ou para um cliente específico conectado a essa sessão.

Parâmetros:
Nome Tipo Descrição
sessionId O ID da sessão correspondente à sessão que receberá a sequência DTMF.
connectionId O ID de conexão do cliente para o qual você está enviando o sinal DTMF. Deixe este campo em branco para enviar um sinal DTMF a todos os clientes conectados à sessão.
digits Esta é a sequência de dígitos DTMF a ser enviada. Ela pode incluir os números de 0 a 9, '*', '#' e 'p'. Um 'p' indica uma pausa de 500 ms (caso seja necessário adicionar um atraso no envio dos dígitos).
callback função A função a ser chamada ao concluir a operação. É passado um argumento para a função: - error — Um objeto de erro (caso a chamada ao método falhe). Esse objeto é definido como nulo se não houver erro.

removeArchiveStream(archiveId, streamId, callback)

Remove um fluxo de um arquivo composto cujo `streamMode` esteja definido como “manual”.

Parâmetros:
Nome Tipo Descrição
archiveId String O ID do arquivo.
streamId String O ID do stream a ser removido do arquivo.
callback função A função a ser chamada ao concluir a operação. Se a chamada falhar, um erro é passado para a função.

removeBroadcastStream(broadcastId, streamId, callback)

Remove um stream de uma transmissão cujo streamMode esteja definido como “manual”.

Parâmetros:
Nome Tipo Descrição
broadcastId String O ID da transmissão.
streamId String O ID da transmissão a ser removido da transmissão ao vivo.
callback função A função a ser chamada ao concluir a operação. Se a chamada falhar, um erro é passado para a função.

setArchiveLayout(archiveId, type, stylesheet, screenshareType, callback)

Define o tipo de layout para um arquivo composto. Para obter uma descrição dos tipos de layout, consulte Personalização do layout do vídeo para arquivos compostos.

Parâmetros:
Nome Tipo Descrição
archiveId String O ID do arquivo.
type String O tipo de layout. Defina-o como “bestFit”, “pip”, “verticalPresentation”, “horizontalPresentation”, “focus” ou “custom”. Para obter uma descrição desses tipos de layout, consulte Personalização do layout do vídeo para arquivos compostos.
stylesheet String (Opcional) A folha de estilo para um layout personalizado. Defina este parâmetro se você definir type para "custom". Caso contrário, deixe-o sem definir ou defina-o como nulo.
screenshareType String (Opcional) O tipo de layout a ser usado quando houver uma transmissão de compartilhamento de tela na sessão. Observe que, para usar esse parâmetro, é necessário definir o type parâmetro para “bestFit” e definir o stylesheet parâmetro para null.
callback função A função a ser chamada ao concluir a operação. Em caso de erro, um error O objeto é passado para a função. Em caso de sucesso, a função é chamada sem que nenhum objeto de erro seja passado.

setBroadcastLayout(broadcastId, type, stylesheet, screenshareType, callback)

Define (ou atualiza) o layout da transmissão. Consulte Configuração do layout de vídeo para transmissões ao vivo no OpenTok.

Parâmetros:
Nome Tipo Descrição
broadcastId String O ID da transmissão.
type String O tipo de layout. Defina-o como “bestFit”, “pip”, “verticalPresentation”, “horizontalPresentation”, “focus” ou “custom”. Para obter uma descrição desses tipos de layout, consulte Configurando o layout para transmissões ao vivo pelo OpenTok.
stylesheet String (Opcional) A folha de estilo para um layout personalizado. Defina este parâmetro se você definir type para “custom”. Caso contrário, deixe-o sem definição ou defina-o como null.
screenshareType String (Opcional) O tipo de layout a ser usado quando houver uma transmissão de compartilhamento de tela na sessão. Observe que, para usar esse parâmetro, é necessário definir o type parâmetro para “bestFit” e definir o stylesheet parâmetro para null.
callback função A função a ser chamada ao concluir a operação. Em caso de erro, um objeto Error é passado para a função. Em caso de sucesso, a função é chamada sem que nenhum objeto Error seja passado para ela.

setStreamClassLists(sessionId, classListArray, callback)

Define a lista de classes de layout para streams em uma sessão. As classes de layout são utilizadas no layout de arquivos compostos e transmissões ao vivo. Para obter mais informações, consulte Personalização do layout do vídeo para arquivos compostos e Configurando o layout de vídeo para transmissões ao vivo pelo OpenTok.

É possível definir a lista inicial de classes de layout para os fluxos publicados por um cliente ao gerar usados pelo cliente. Consulte o OpenTok.generateToken() método.

Parâmetros:
Nome Tipo Descrição
sessionId String O ID da sessão à qual os fluxos pertencem.
classListArray Matriz (Opcional) Um array que define as listas de classes a serem aplicadas aos fluxos. Cada elemento do array é um objeto com duas propriedades: id e layoutClassList. O id A propriedade é o ID do stream (uma String), e o layoutClassList é uma matriz de nomes de classes (Strings) a serem aplicados ao fluxo. Defina layoutClassList para um array vazio, a fim de limpar a lista de classes de layout de um fluxo. Por exemplo, isto streamClassArray array define a lista de classes de layout para três fluxos: const classListArray = [ { id: '7b09ec3c-26f9-43d7-8197-f608f13d4fb6', layoutClassList: ['focus'] }, { id: '567bc941-6ea0-4c69-97fc-70a740b68976', layoutClassList: ['top'] }, { id: '307dc941-0450-4c09-975c-705740d08970', layoutClassList: ['bottom'] } ];
callback função A função a ser chamada ao concluir a operação. Em caso de erro, um error O objeto é passado para a função. Em caso de sucesso, a função é chamada sem que nenhum objeto de erro seja passado.

signal(sessionId, connectionId, payload, callback)

Envia um sinal para todas as conexões de uma sessão ou para uma conexão específica.

Os clientes devem estar ativamente conectados à sessão do OpenTok para que você consiga enviar um sinal a eles.

Para obter mais informações, consulte o Sinalização do OpenTok guia de programação.

Parâmetros:
Nome Tipo Descrição
sessionId O ID da sessão do OpenTok para a qual você deseja enviar o sinal.
connectionId O ID de conexão de um cliente conectado à sessão. Deixe este campo em branco se desejar enviar um sinal para todas as conexões da sessão.
payload Um objeto com data e type propriedades: - data — Os dados a serem enviados. O limite para o comprimento da sequência de dados é de 8 kB. Não defina a sequência de dados como nula ou indefinida. - type — O tipo do sinal. Os clientes podem usar o tipo para filtrar sinais. O comprimento máximo da sequência de caracteres do tipo é de 128 caracteres.
callback função A função de retorno de chamada invocada quando a chamada ao método é bem-sucedida ou falha. Se a chamada falhar, um objeto de erro é passado para a função de retorno de chamada.

startArchive(sessionId, opções, callback)

Inicia o arquivamento de uma sessão do OpenTok.

Os clientes devem estar ativamente conectados à sessão do OpenTok para que você consiga iniciar a gravação de um arquivo.

É possível gravar apenas um arquivo por vez para uma determinada sessão. Só é possível gravar arquivos de sessões que utilizem o OpenTok Media Router (sessões com o modo de mídia definido como “routed”); não é possível arquivar sessões com o modo de mídia definido como “relayed”.

Parâmetros:
Nome Tipo Descrição
sessionId O ID da sessão do OpenTok a ser arquivada.
options Objeto Um objeto de opções opcional com as seguintes propriedades (cada uma delas é opcional): - name (String) — o nome do arquivo, que você pode usar para identificá-lo. O nome é definido como uma propriedade do objeto Archive e é uma propriedade dos eventos relacionados ao arquivo nas bibliotecas de clientes do OpenTok. - hasAudio (Booleano) — Se o arquivo incluirá uma faixa de áudio (true) ou não (false). O valor padrão é true (há uma faixa de áudio incluída). Se você definir ambas hasAudio e hasVideo para false, a chamada para o startArchive() O método gera um erro. - hasVideo (Booleano) — Se o arquivo incluirá uma trilha de vídeo (true) ou (não false). O valor padrão é true (está incluída uma faixa de vídeo). Se você definir ambas hasAudio e hasVideo para false, a chamada para o startArchive() O método gera um erro. - outputMode (String) — Se todos os fluxos do arquivo são gravados em um único arquivo (“composto”, o padrão) ou em arquivos individuais (“individual”). - layout (Objeto) — Um objeto que define as opções iniciais de layout para um arquivo composto. Esse objeto possui três propriedades: type, stylesheet, e screenshareType, que são, cada uma, uma sequência de caracteres. Definir type para “bestFit”, “pip”, “verticalPresentation”, “horizontalPresentation” ou “custom”. Defina o stylesheet propriedade se type está definido como “personalizado” e defina-o para a folha de estilo que define o layout personalizado. Por exemplo, defina o layout opor-se a { type: "pip" } para definir o layout inicial do arquivo como “imagem na imagem”. Defina o screenshareType propriedade que define o tipo de layout a ser usado quando houver uma transmissão de compartilhamento de tela na sessão (Essa propriedade é opcional.) Observe que, se você definir a screenshareType propriedade, é necessário definir o type atribuir a propriedade a “bestFit” e deixar o stylesheet propriedade não definida. Para mais detalhes, consulte Personalização do layout de vídeo para arquivos compostos. - resolution (String) — Para um arquivo composto, defina este parâmetro com a resolução do arquivo. Os valores válidos são “1920x1080”, “1280x720” ou “640x480” (o padrão). - streamMode (opcional) — O modo de transmissão para o arquivo. Pode ser definido como uma das seguintes opções: - “auto” — As transmissões incluídas no arquivo são selecionadas automaticamente (padrão). - “manual” — Especifique os fluxos a serem incluídos com base nas chamadas para o OpenTok.addArchiveStream() e OpenTok.removeArchiveStream() métodos. - multiArchiveTag (String) — Defina este parâmetro para permitir a gravação simultânea de vários arquivos para a mesma sessão. Defina uma string exclusiva para cada arquivo simultâneo de uma sessão em andamento. Você também deve definir esta opção ao iniciar manualmente um arquivo que é gravado automaticamente. Observe que o multiArchiveTag O valor não está incluído na resposta dos métodos para listar arquivos e recuperar informações sobre arquivos. Se você não especificar um valor exclusivo multiArchiveTag É possível gravar apenas um arquivo por vez em uma determinada sessão. - maxBitrate (Número) — A taxa de bits máxima de vídeo para o arquivo, em bits por segundo. Essa opção é válida apenas para arquivos compostos. Defina a taxa de bits máxima de vídeo para controlar o tamanho do arquivo composto. Essa taxa de bits máxima se aplica apenas à taxa de bits de vídeo. Se o arquivo de saída contiver áudio, esses bits serão excluídos do limite. Para obter mais informações sobre arquivamento e os formatos de arquivo, consulte o Arquivamento do OpenTok guia de programaçã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). - archive — O Arquivo objeto. Esse objeto inclui propriedades que definem o arquivo, incluindo o ID do arquivo.

startBroadcast(sessionId, options, callback)

Inicia uma transmissão ao vivo. Consulte o transmissão ao vivo guia do desenvolvedor.

Parâmetros:
Nome Tipo Descrição
sessionId String O ID da sessão a ser transmitida.
options Objeto Um objeto com a seguinte forma: { outputs: { hls: { dvr: false, lowLatency: false, }, rtmp: [{ id: "foo", serverUrl: "rtmp://myfooserver/myfooapp", streamName: "myfoostream" }, { id: "bar", serverUrl: "rtmp://mybarserver/mybarapp", streamName: "mybarstream" }] }, maxDuration: 5400, resolution: "640x480", layout: { type: "custom", stylesheet: "the layout stylesheet (only used with type == custom)", screenshareType: "the layout type to use when there is a screen-sharing stream (optional)" }, streamMode: "manual" } O options O objeto inclui as seguintes propriedades: - outputs (obrigatório) — Este objeto define os tipos de fluxos de transmissão que você deseja iniciar. É possível incluir HLS, RTMP ou ambos como fluxos de transmissão. Se você incluir a transmissão por RTMP, poderá especificar até cinco fluxos RTMP de destino (ou apenas um). Para HLS, inclua um único hls propriedade no objeto `outputs`. Esse objeto inclui as seguintes propriedades opcionais: - dvr (Booleano) — Se deve ser ativado Funcionalidade de DVR — retroceder, pausar e retomar — em reprodutores que ofereçam esses recursos (true), ou não (false, (padrão). Com o DVR ativado, a URL HLS incluirá um ?DVR sequência de consulta anexada ao final. - lowLatency (Booleano) — Se deve ser ativado modo de baixa latência para o fluxo HLS. Alguns reprodutores HLS não oferecem suporte ao modo de baixa latência. Esse recurso é incompatível com transmissões HLS no modo DVR. A URL do HLS é retornada no broadcastUrls como o hls propriedade na Transmissão objeto passado para os métodos de retorno de chamada do OpenTok#getBroadcast e os métodos #listBroadcast do OpenTok. Para cada fluxo RTMP, especifique serverUrl (a URL do servidor RTMP), streamName (o nome da transmissão, como o nome da transmissão ao vivo do YouTube ou a chave da transmissão do Facebook) e (opcionalmente) id (um ID exclusivo para o stream). Se você especificar um ID, ele será incluído como o id propriedade do Transmissão objeto passado para os métodos de retorno de chamada do startBroadcast() método e o OpenTok.getBroadcast() método. O OpenTok transmite a sessão para cada URL RTMP que você especificar. Observe que a transmissão ao vivo do OpenTok é compatível com RTMP e RTMPS. - maxDuration (opcional) — A duração máxima da transmissão, em segundos. A transmissão será interrompida automaticamente quando a duração máxima for atingida. Você pode definir a duração máxima para um valor entre 60 (60 segundos) e 36.000 (10 horas). A duração máxima padrão é de 4 horas (14.400 segundos). - resolution (opcional) — A resolução da transmissão: pode ser "640x480" (SD, o padrão), "1280x720" (HD) ou "1920x1080" (FHD). layout (opcional) — Especifique isso para atribuir o tipo de layout inicial à transmissão. Esse objeto possui três propriedades: type, stylesheet, e screenshareType, sendo cada um deles uma sequência de caracteres. Os valores válidos para o type as propriedades são "bestFit" (melhor ajuste), "custom" (personalizado), "horizontalPresentation" (apresentação horizontal), "pip" (imagem na imagem), e "verticalPresentation" (apresentação vertical)). Se você especificar um "custom" tipo de layout, defina o stylesheet propriedade do layout atribuir a folha de estilo. (Para outros tipos de layout, não defina um stylesheet propriedade.) Se você não especificar um tipo de layout inicial, o fluxo de transmissão utilizará o tipo de layout “Best Fit”. Defina o screenshareType propriedade que define o tipo de layout a ser usado quando houver uma transmissão de compartilhamento de tela na sessão. (Essa propriedade é opcional.) Observe que, se você definir a screenshareType propriedade, é necessário definir o type atribuir a propriedade “bestFit” e deixar o stylesheet propriedade não definida. Para obter mais informações, consulte Configuração do layout de vídeo para transmissões ao vivo no OpenTok).- streamMode (opcional) — 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. - multiBroadcastTag (opcional) — 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 para listar transmissões ao vivo e obter informações sobre uma transmissão ao vivo.
callback função Um método de retorno de chamada que recebe dois parâmetros: error, que é atribuído a um objeto Error em caso de erro, e broadcast, que está definido para um Transmissão objeto em caso de sucesso.

startCaptions(sessionId, token, options, callback)

Ativa as legendas em tempo real para uma sessão do OpenTok.

A duração máxima permitida é de 4 horas; após esse período, a legenda de áudio será interrompida sem nenhum efeito sobre a sessão do OpenTok em andamento. Um evento será enviado para sua URL de retorno de chamada, caso tenha sido fornecida ao iniciar as legendas.

Cada sessão do OpenTok suporta apenas uma sessão de legenda de áudio.

Parâmetros:
Nome Tipo Descrição
sessionId O ID da sessão do OpenTok a ser arquivada.
token Um token válido do OpenTok com a função definida como “Moderador”.
options Objeto Um objeto de opções opcional com as seguintes propriedades (cada uma delas é opcional): - languageCode (String) — O código BCP-47 da língua falada utilizada nesta chamada. O valor padrão é “en-US”. Os seguintes códigos de idioma são suportados: “en-AU” (inglês, Austrália), “en-GB” (inglês, Reino Unido), “en-us” (inglês, EUA), “es-US” (espanhol, EUA), “zh-CN” (chinês simplificado), “fr-FR” (francês), “fr-CA” (francês, Canadá), “de-DE” (alemão), “hi-IN” (hindi, Índia), “it-IT” (italiano), “ja-JP” (japonês), “ko-KR” (coreano), “pt-BR” (português do Brasil), “th-TH” (tailandês). - maxDuration (Número inteiro) — A duração máxima da legenda de áudio, em segundos. O valor padrão é 14.400 segundos (4 horas), que é a duração máxima permitida. O valor mínimo para maxDuration é 300 (300 segundos, ou 5 minutos). - partialCaptions (Booleano) — Indica se essa opção deve ser ativada para agilizar a geração de legendas, em troca de um certo grau de imprecisão. O valor padrão é true. Para obter mais informações sobre legendas, consulte o Legendas do OpenTok guia de programaçã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). - captionID — O ID das legendas

startCaptions(captionId, callback)

Desativa as legendas em tempo real de uma sessão do OpenTok

Parâmetros:
Nome Tipo Descrição
captionId O ID da sessão do OpenTok a ser arquivada. Para obter mais informações sobre legendas, consulte o Legendas do OpenTok guia de programaçã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). - success — É sempre verdade

startRender(opções, callback)

Inicia um Experience Composer para uma sessão do OpenTok. A instância do Experience Composer é representada como um objeto Render. Para obter mais informações, consulte o Guia do desenvolvedor do Experience Composer.

Os clientes devem estar ativamente conectados à sessão do OpenTok para que você consiga iniciar a renderização de uma sessão.

Parâmetros:
Nome Tipo Descrição
options Objeto Um objeto de opções opcional com as seguintes propriedades (cada uma delas é opcional): - sessionId (String) — O ID de uma sessão (gerado com o mesmo APIKEYconforme especificado na URL) na qual você deseja iniciar a renderização — token (String) — Um token válido do OpenTok com a função de Editor e (opcionalmente) dados de conexão a serem associados ao fluxo de saída. - url (String) — Uma URL acessível ao público, controlada pelo cliente e capaz de gerar o conteúdo a ser exibido sem a intervenção do usuário. - properties (Objeto) — Configuração inicial das propriedades do Publisher para o fluxo de saída composto. - maxDuration (Número) — O tempo máximo permitido para a renderização, em segundos. Após esse tempo, a renderização será interrompida automaticamente, caso ainda esteja em execução. - resolution (String) — Resolução da área de exibição da composiçã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). - render — O Renderizar objeto. Esse objeto inclui propriedades que definem a renderização, incluindo o ID da renderização.

stopArchive(archiveId, callback)

Interrompe um arquivo do OpenTok que está sendo gravado.

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

Não é possível interromper um arquivo que não esteja sendo gravado.

Parâmetros:
Nome Tipo Descrição
archiveId String O ID do arquivo cuja gravação você deseja interromper.
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). - archive — O Arquivo objeto.
Devoluções:

O Arquivo objeto correspondente ao arquivo que está sendo INTERROMPIDO.

stopBroadcast(broadcastId, callback)

Interrompe uma transmissão ao vivo.

Parâmetros:
Nome Tipo Descrição
broadcastId String O ID da transmissão.
callback função Um método de retorno de chamada que recebe dois parâmetros: error, que é atribuído a um objeto Error em caso de erro, e broadcast, que está definido para um Transmissão objeto em caso de sucesso.

stopRender(renderId, callback)

Interrompe um Experience Composer que está sendo renderizado.

Parâmetros:
Nome Tipo Descrição
renderId String O ID do render que você deseja interromper.
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). - render — O Renderizar objeto.
Devoluções:

O Arquivo objeto correspondente ao arquivo que está sendo INTERROMPIDO.

websocketConnect(sessionId, token, websocketUri, options, callback)

Envia áudio de uma sessão da Video API da Vonage para um WebSocket. Consulte o Conector de áudio guia do desenvolvedor.

Parâmetros:
Nome Tipo Descrição
sessionId String (obrigatório) O ID da sessão do OpenTok que inclui os fluxos do OpenTok que você deseja incluir no fluxo do WebSocket
token String (obrigatório) O token do OpenTok a ser usado para a conexão do Audio Streamer à sessão do OpenTok. É possível adicionar dados ao token para identificar que a conexão é do terminal do Audio Streamer ou para outros dados de identificação
websocketUri String (obrigatório) Um URI de WebSocket acessível ao público a ser usado como destino do fluxo de áudio (como “wss://service.com/ws-endpoint”).
options Objeto Um objeto de opções opcional com as seguintes propriedades (todas opcionais): - streams (Matriz) — Uma matriz de IDs de transmissões do OpenTok que você deseja incluir na transmissão do WebSocket. Se você omitir essa propriedade, todas as transmissões da sessão serão incluídas. - headers (Objeto) — Um objeto composto por pares chave-valor de cabeçalhos a serem enviados ao seu servidor WebSocket a cada mensagem, com comprimento máximo de 512 bytes.
callback função A função a ser chamada ao concluir a operação. Em caso de erro, um error O objeto é passado como primeiro parâmetro da função. Em caso de sucesso, a função é chamada sem que nenhum objeto de erro seja passado (como primeiro parâmetro), e o segundo parâmetro é um objeto com as seguintes propriedades: - id -- Um ID exclusivo que identifica a conexão WebSocket do Audio Streamer. - connectionId -- O ID de conexão do OpenTok para a conexão WebSocket do Audio Streamer na sessão do OpenTok.