Contém métodos para criar sessões da Video API da Vonage, gerar tokens e trabalhar com arquivos. Mais...

Descrição detalhada

Contém métodos para criar sessões da Video API da Vonage, gerar tokens e trabalhar com arquivos.

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

Documentação sobre construtores e destrutores

OpenTok() [1/2]

Cria um OpenTok objeto.

Parâmetros : | | | | --- | --- | | apiKey | Sua chave da Video API do Vonage. (Consulte o Página da conta do TokBox | | apiSecret | Seu segredo da Video API do Vonage. (Consulte o Página da conta do TokBox |

OpenTok() [2/2]

Para uso interno da TokBox.

Parâmetros : | | | | --- | --- | | apiKey | | | apiSecret | | | apiUrl | |

Documentação das funções de membro

AddStreamToArchive()

Adiciona um fluxo a um arquivo composto que está sendo executado no momento e que foi iniciado com o comando streamMode definir como StreamMode.Manual. Você pode 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.

Parâmetros : | | | | --- | --- | | archiveId | O ID do arquivo. | | streamId | O ID do stream. | | hasAudio | Se o arquivo composto deve incluir o áudio do stream (true, padrão) ou não (false). | | hasVideo | Se o arquivo composto deve incluir o vídeo do stream (true, padrão) ou não (false). |

AddStreamToArchiveAsync()

Adiciona um fluxo a um arquivo composto que está sendo executado no momento e que foi iniciado com o comando streamMode definir como StreamMode.Manual. Você pode 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.

Parâmetros : | | | | --- | --- | | archiveId | O ID do arquivo. | | streamId | O ID do stream. | | hasAudio | Se o arquivo composto deve incluir o áudio do stream (true, padrão) ou não (false). | | hasVideo | Se o arquivo composto deve incluir o vídeo do stream (true, padrão) ou não (false). |

AddStreamToBroadcast()

Adiciona um stream a uma transmissão em andamento que foi iniciada com o streamMode definir como StreamMode.Manual. Você pode chamar o método repetidamente com o mesmo ID de stream para ativar ou desativar o áudio ou o vídeo do stream na transmissão.

Parâmetros : | | | | --- | --- | | broadcastId | O ID da transmissão. | | streamId | O ID do stream. | | hasAudio | Se a transmissão deve incluir o áudio do stream (true, padrão) ou não (false). | | hasVideo | Se a transmissão deve incluir o vídeo do stream (true, padrão) ou não (false). |

Exceções : | | | | --- | --- | | OpenTokArgumentException | |

AddStreamToBroadcastAsync()

Adiciona um stream a uma transmissão em andamento que foi iniciada com o streamMode definir como StreamMode.Manual. Você pode chamar o método repetidamente com o mesmo ID de stream para ativar ou desativar o áudio ou o vídeo do stream na transmissão.

Parâmetros : | | | | --- | --- | | broadcastId | O ID da transmissão. | | streamId | O ID do stream. | | hasAudio | Se a transmissão deve incluir o áudio do stream (true, padrão) ou não (false). | | hasVideo | Se a transmissão deve incluir o vídeo do stream (true, padrão) ou não (false). |

Exceções : | | | | --- | --- | | OpenTokArgumentException | |

CreateSession()

Cria uma nova sessão da Video API da Vonage.

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

Uma sequência de caracteres de ID de sessão pode ter até 255 caracteres.

A chamada a este método gera uma exceção OpenTokException em caso de erro. Verifique a mensagem de erro para obter mais detalhes.

Você também pode criar uma sessão usando o API REST do OpenTok ou fazendo login na sua Account do TokBox.

Parâmetros : | | | | --- | --- | | location | Um endereço IP que os servidores da Video API da Vonage usarão para posicionar a sessão em sua rede global. Se você não definir uma sugestão de localização, os servidores da Video API da Vonage se basearão no primeiro cliente que se conectar à sessão. | | mediaMode | Se a sessão transmitirá fluxos usando o Roteador de Mídia da Video API da Vonage (MediaMode.ROUTED) ou não (MediaMode.RELAYED). Por padrão, a configuração é MediaMode.RELAYED. Com o parâmetro definido como MediaMode.RELAYED, a sessão tentará transmitir fluxos diretamente entre os clientes. Se os clientes não conseguirem se conectar devido a restrições do firewall, a sessão utiliza o OpenTok Ative o servidor para retransmitir transmissões. O Roteador de mídia OpenTok oferece os seguintes benefícios: - O Media Router da Video API da Vonage pode reduzir o uso de largura de banda em sessões com vários participantes. (Quando o mediaMode o parâmetro está definido como MediaMode.ROUTED, cada cliente deve enviar um fluxo de áudio e vídeo separado para cada cliente que o assina.) - O Media Router da Video API da Vonage 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á assinando, o vídeo é interrompido nesse cliente (sem afetar outros clientes), e o cliente recebe apenas o áudio. Se a conectividade do cliente melhorar, o vídeo é restabelecido. - O Media Router da Video API da Vonage suporta o arquivamento recurso que permite gravar, salvar e recuperar sessões da Video API da Vonage. | | archiveMode | Se a sessão é arquivada automaticamente (ArchiveMode.ALWAYS) ou não (ArchiveMode.MANUAL). Por padrão, a configuração é ArchiveMode.MANUAL e você deve ligar para o Iniciar Arquivo método do OpenTok objeto para iniciar o arquivamento. Para arquivar a sessão (seja automaticamente ou não), é necessário definir o parâmetro mediaMode como MediaMode.ROUTED | | criptografia | Ativa criptografia de ponta a ponta de mídia em sessões roteadas. | | archiveName | Nome dos arquivos nas sessões arquivadas automaticamente. Uma sessão que inicie com o modo de arquivamento “always” utilizará esse nome de arquivo para todos os arquivos dessa sessão. Passar o parâmetro “archiveName” com o modo de arquivamento “manual” resultará em uma resposta de erro. | | archiveResolution | Resolução dos arquivos em sessões arquivadas automaticamente. Uma sessão que inicie com o modo de arquivamento “always” utilizará essa resolução para todos os arquivos dessa sessão. Passar “archiveResolution” com o modo de arquivamento “manual” resultará em uma resposta de erro. |

Devoluções : A Sessão objeto que representa a nova sessão. O Session.Id propriedade do Sessão é o ID da sessão, que identifica a sessão de forma exclusiva. Você utilizará esse ID de sessão nos SDKs do cliente para identificar a sessão. 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 da Video API da Vonage).

CreateSessionAsync()

Cria uma nova sessão da Video API da Vonage.

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

Uma sequência de caracteres de ID de sessão pode ter até 255 caracteres.

A chamada a este método gera uma exceção OpenTokException em caso de erro. Verifique a mensagem de erro para obter mais detalhes.

Você também pode criar uma sessão usando o API REST do OpenTok ou fazendo login na sua Account do TokBox.

Parâmetros : | | | | --- | --- | | location | Um endereço IP que os servidores da Video API da Vonage usarão para posicionar a sessão em sua rede global. Se você não definir uma sugestão de localização, os servidores da Video API da Vonage se basearão no primeiro cliente que se conectar à sessão. | | mediaMode | Se a sessão transmitirá fluxos usando o Roteador de Mídia da Video API da Vonage (MediaMode.ROUTED) ou não (MediaMode.RELAYED). Por padrão, a configuração é MediaMode.RELAYED. Com o parâmetro definido como MediaMode.RELAYED, a sessão tentará transmitir fluxos diretamente entre os clientes. Se os clientes não conseguirem se conectar devido a restrições do firewall, a sessão utiliza o OpenTok Ative o servidor para retransmitir transmissões. O Roteador de mídia OpenTok oferece os seguintes benefícios: - O Media Router da Video API da Vonage pode reduzir o uso de largura de banda em sessões com vários participantes. (Quando o mediaMode o parâmetro está definido como MediaMode.ROUTED, cada cliente deve enviar um fluxo de áudio e vídeo separado para cada cliente que o assina.) - O Media Router da Video API da Vonage 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á assinando, o vídeo é interrompido nesse cliente (sem afetar outros clientes), e o cliente recebe apenas o áudio. Se a conectividade do cliente melhorar, o vídeo é restabelecido. - O Media Router da Video API da Vonage suporta o arquivamento recurso que permite gravar, salvar e recuperar sessões da Video API da Vonage. | | archiveMode | Se a sessão é arquivada automaticamente (ArchiveMode.ALWAYS) ou não (ArchiveMode.MANUAL). Por padrão, a configuração é ArchiveMode.MANUAL e você deve ligar para o Iniciar Arquivo método do OpenTok objeto para iniciar o arquivamento. Para arquivar a sessão (seja automaticamente ou não), é necessário definir o parâmetro mediaMode como MediaMode.ROUTED | | criptografia | Ativa criptografia de ponta a ponta de mídia em sessões roteadas. | | archiveName | Nome dos arquivos nas sessões arquivadas automaticamente. Uma sessão que inicie com o modo de arquivamento “always” utilizará esse nome de arquivo para todos os arquivos dessa sessão. Passar o parâmetro “archiveName” com o modo de arquivamento “manual” resultará em uma resposta de erro. | | archiveResolution | Resolução dos arquivos em sessões arquivadas automaticamente. Uma sessão que inicie com o modo de arquivamento “always” utilizará essa resolução para todos os arquivos dessa sessão. Passar “archiveResolution” com o modo de arquivamento “manual” resultará em uma resposta de erro. |

Devoluções : A Sessão objeto que representa a nova sessão. O Session.Id propriedade do Sessão é o ID da sessão, que identifica a sessão de forma exclusiva. Você utilizará esse ID de sessão nos SDKs do cliente para identificar a sessão. 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 da Video API da Vonage).

DeleteArchive()

Exclui um OpenTok arquivo.

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 : | | | | --- | --- | | archiveId | O ID do arquivo que você deseja excluir. |

DeleteArchiveAsync()

Exclui um OpenTok arquivo.

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 : | | | | --- | --- | | archiveId | O ID do arquivo que você deseja excluir. |

Dial()

Conecta uma plataforma SIP a uma sessão da Video API da Vonage.

Para obter mais informações, incluindo detalhes técnicos e considerações de segurança, consulte o Guia do desenvolvedor para interconexão SIP do OpenTok.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão correspondente à sessão à qual o usuário se conectará. | | token | O token da ID de sessão que o usuário SIP utilizará para se conectar. | | sipUri | O URI SIP a ser usado como destino da chamada SIP iniciada a partir de OpenTok para sua plataforma SIP. Se o URI SIP contiver um cabeçalho ​transport=tls​, a negociação entre OpenTok e a conexão com o terminal SIP será estabelecida de forma segura. Observe que isso se aplica apenas à negociação em si, e não à transmissão de áudio. Se você também quiser que a transmissão de áudio seja criptografada, defina o Secure propriedade do do Opções de discagem objeto passado ao parâmetro `options` para ​true​. Este é um exemplo de configuração sipUri para uma negociação segura da chamada: "sip:user@sip.partner.com;transport=tls". Este é um exemplo de negociação de chamada não segura: "sip:user@sip.partner.com". | | opções | Parâmetros opcionais para discagem SIP. |

DialAsync()

Conecta uma plataforma SIP a uma sessão da Video API da Vonage.

Para obter mais informações, incluindo detalhes técnicos e considerações de segurança, consulte o Guia do desenvolvedor para interconexão SIP do OpenTok.

Veja também OpenTok.Dial.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão correspondente à sessão à qual o usuário se conectará. | | token | O token da ID de sessão que o usuário SIP utilizará para se conectar. | | sipUri | O URI SIP a ser usado como destino da chamada SIP iniciada a partir de OpenTok para sua plataforma SIP. Se o URI SIP contiver um cabeçalho ​transport=tls​, a negociação entre OpenTok e a conexão com o terminal SIP será estabelecida de forma segura. Observe que isso se aplica apenas à negociação em si, e não à transmissão de áudio. Se você também quiser que a transmissão de áudio seja criptografada, defina o Secure propriedade do do Opções de discagem objeto passado ao parâmetro `options` para ​true​. Este é um exemplo de configuração sipUri para uma negociação segura da chamada: "sip:user@sip.partner.com;transport=tls". Este é um exemplo de negociação de chamada não segura: "sip:user@sip.partner.com". | | opções | Parâmetros opcionais para discagem SIP. |

DisableForceMute()

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 ForceMuteAll método, quaisquer transmissões publicadas após a chamada serão publicadas com o áudio silenciado. Chame o DisableForceMute() método para desativar o silêncio de uma sessão, de modo que os novos fluxos publicados não sejam automaticamente silenciados.

Veja também o DesativarForçarSilenciamentoAssíncrono método.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão. |

Exceções : | | | | --- | --- | | OpenTokArgumentException | Lançada quando o ID da sessão é inválido. | | OpenTokWebException | Lançada quando ocorre um erro HTTP. |

DisableForceMuteAsync()

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 ForceMuteAllAsync método, quaisquer transmissões publicadas após a chamada serão publicadas com o áudio silenciado. Chame o DisableForceMuteAsync() método para desativar o silêncio de uma sessão, de modo que os novos fluxos publicados não sejam automaticamente silenciados.

Veja também o DesativarForçarSilêncio método.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão. |

Exceções : | | | | --- | --- | | OpenTokArgumentException | Lançada quando o ID da sessão é inválido. | | OpenTokWebException | Lançada quando ocorre um erro HTTP. |

ForceDisconnect()

Forçar um cliente específico a se desconectar de uma sessão da Video API da Vonage.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão correspondente à sessão. | | connectionId | O ID da conexão dentro de uma sessão. |

ForceDisconnectAsync()

Forçar um cliente específico a se desconectar de uma sessão da Video API da Vonage.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão correspondente à sessão. | | connectionId | O ID da conexão dentro de uma sessão. |

ForceMuteAll()

Obliga todas as transmissões (exceto uma lista 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 a este método são publicadas com o áudio silenciado. É possível desativar o silenciamento de uma sessão chamando o método DesativarForçarSilêncio método.

Veja também o ForceMuteAllAsync e ForceMuteStream métodos.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão. | | excludedStreamIds | Os IDs dos streams que não serão silenciados. |

Exceções : | | | | --- | --- | | OpenTokArgumentException | Lançada quando o ID da sessão é inválido. | | OpenTokWebException | Lançada quando ocorre um erro HTTP. |

ForceMuteAllAsync()

Obliga todas as transmissões (exceto uma lista 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 a este método são publicadas com o áudio silenciado. É possível desativar o silenciamento de uma sessão chamando o método DesativarForçarSilenciamentoAssíncrono método.

Veja também o ForceMuteAll e ForceMuteStreamAsync métodos.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão. | | excludedStreamIds | Os IDs dos streams que não serão silenciados. |

Exceções : | | | | --- | --- | | OpenTokArgumentException | Lançada quando o ID da sessão é inválido. | | OpenTokWebException | Lançada quando ocorre um erro HTTP. |

ForceMuteStream()

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

Veja também o ForceMuteAll e ForceMuteStreamAsync métodos.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão que inclui o stream. | | streamId | O ID do stream. |

Exceções : | | | | --- | --- | | OpenTokArgumentException | Lançada quando o ID da sessão ou do fluxo é inválido. | | OpenTokWebException | Lançada quando ocorre um erro HTTP. |

ForceMuteStreamAsync()

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

Veja também o ForceMuteAll e ForceMuteStream métodos.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão que inclui o stream. | | streamId | O ID do stream. |

Exceções : | | | | --- | --- | | OpenTokArgumentException | Lançada quando o ID da sessão ou do fluxo é inválido. | | OpenTokWebException | Lançada quando ocorre um erro HTTP. |

GenerateToken()

Cria um token para se conectar a uma sessão da Video API do Vonage. Para autenticar um usuário que se conecta a uma sessão da Video API do Vonage, o cliente envia um token ao se conectar à sessão.

Para fins de teste, você também pode gerar tokens de teste fazendo login na sua Account do TokBox.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão correspondente à sessão à qual o usuário se conectará. | | role | A função do token. Os valores válidos estão definidos na enumeração Role: - Função.ASSINANTE (Um assinante só pode se inscrever em canais) - Função.PUBLISHER (Um editor pode publicar fluxos, assinar fluxos e enviar sinais. (Esse é o valor padrão caso você não especifique uma função.)) - Função.MODERADOR (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 publicação de transmissões ou silenciar o áudio em transmissões publicadas. Consulte o Guia do desenvolvedor sobre moderação. | | expireTime | O tempo de validade do token, em segundos desde a época UNIX. Insira 0 para usar o tempo de validade padrão de 24 horas após a hora de criação do token. O tempo máximo de validade é de 30 dias após a hora de criação. | | data | Uma string contendo metadados de conexão que descrevem o usuário final. Por exemplo, você pode 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 | Uma lista de valores de string contendo o layout inicial do fluxo. |

Devoluções

GetArchive()

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

Parâmetros : | | | | --- | --- | | archiveId | O ID do arquivo. |

Devoluções : O Arquivo objeto.

GetArchiveAsync()

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

Parâmetros : | | | | --- | --- | | archiveId | O ID do arquivo. |

Devoluções : O Arquivo objeto.

GetBroadcast()

Use este método para obter um objeto de transmissão ao vivo de uma sessão da Video API do Vonage.

Para obter mais informações sobre transmissão, consulte o Guia do desenvolvedor de transmissões.

Parâmetros : | | | | --- | --- | | broadcastId | O ID da transmissão da sessão de transmissão |

Devoluções : O Transmissão objeto. Esse objeto inclui propriedades que definem a transmissão, incluindo o ID da transmissão.

GetBroadcastAsync()

Use este método para obter um objeto de transmissão ao vivo de uma sessão da Video API do Vonage.

Para obter mais informações sobre transmissão, consulte o Guia do desenvolvedor de transmissões.

Parâmetros : | | | | --- | --- | | broadcastId | O ID da transmissão da sessão de transmissão |

Devoluções : O Transmissão objeto. Esse objeto inclui propriedades que definem a transmissão, incluindo o ID da transmissão.

GetRenderAsync()

Recupera um renderizador do Experience Composer.

Parâmetros : | | | | --- | --- | | renderId | O ID da renderização. |

GetStream()

Obtém um Transmissão objeto correspondente ao ID do fluxo indicado.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão da Video API da Vonage. | | streamId | O ID do stream. |

Devoluções : O Transmissão objeto.

GetStreamAsync()

Obtém um Transmissão objeto correspondente ao ID do fluxo indicado.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão da Video API da Vonage. | | streamId | O ID do stream. |

Devoluções : O Transmissão objeto.

ListArchives()

Retorna uma lista de Arquivo objetos, representando arquivos concluídos e em andamento, para sua chave de API.

Parâmetros : | | | | --- | --- | | offset | O deslocamento do índice do primeiro arquivo. 0 corresponde ao deslocamento do arquivo iniciado mais recentemente. 1 corresponde ao deslocamento do arquivo iniciado antes do mais recente. | | count | O número de arquivos a serem retornados. O número máximo de arquivos retornados é 1.000. | | sessionId | O ID da sessão. |

Devoluções : Uma lista de Arquivo objetos.

ListArchivesAsync()

Retorna uma lista de Arquivo objetos, representando arquivos concluídos e em andamento, para sua chave de API.

Parâmetros : | | | | --- | --- | | offset | O deslocamento do índice do primeiro arquivo. 0 corresponde ao deslocamento do arquivo iniciado mais recentemente. 1 corresponde ao deslocamento do arquivo iniciado antes do mais recente. | | count | O número de arquivos a serem retornados. O número máximo de arquivos retornados é 1.000. | | sessionId | O ID da sessão. |

Devoluções : Uma lista de Arquivo objetos.

ListRendersAsync()

Recupera todos os renderizadores do Experience Composer que correspondem à solicitação fornecida.

Parâmetros : | | | | --- | --- | | solicitação | A solicitação que contém as opções de filtragem. |

Retorna : A lista de renderizações.

ListStreams()

Retorna uma lista de Transmissão objetos, que representam transmissões em andamento, para o ID da sessão.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão correspondente à sessão. |

Devoluções : Uma lista de Transmissão objetos.

Exceções : | | | | --- | --- | | OpenTokArgumentException | |

ListStreamsAsync()

Retorna uma lista de Transmissão objetos, que representam transmissões em andamento, para o ID da sessão.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão correspondente à sessão. |

Devoluções : Uma lista de Transmissão objetos.

Exceções : | | | | --- | --- | | OpenTokArgumentException | |

PlayDTMF()

Envie dígitos DTMF para todos os participantes de uma sessão ativa da Video API da Vonage ou para um cliente específico conectado a essa sessão.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão correspondente à sessão que receberá a sequência DTMF. | | connectionId | O ID da 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 0-9, '*', '#' e 'p'. Um 'p' indica uma pausa de 500 ms (caso seja necessário adicionar um atraso no envio dos dígitos). |

PlayDTMFAsync()

Envie dígitos DTMF para todos os participantes de uma sessão ativa da Video API da Vonage ou para um cliente específico conectado a essa sessão.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão correspondente à sessão que receberá a sequência DTMF. | | connectionId | O ID da 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 0-9, '*', '#' e 'p'. Um 'p' indica uma pausa de 500 ms (caso seja necessário adicionar um atraso no envio dos dígitos). |

RemoveStreamFromArchive()

Remove um fluxo de um arquivo composto que foi iniciado com o comando streamMode definir como StreamMode.Manual.

Parâmetros : | | | | --- | --- | | archiveId | O ID do arquivo. | | streamId | O ID do fluxo. |

RemoveStreamFromArchiveAsync()

Remove um fluxo de um arquivo composto que foi iniciado com o comando streamMode definir como StreamMode.Manual.

Parâmetros : | | | | --- | --- | | archiveId | O ID do arquivo. | | streamId | O ID do fluxo. |

RemoveStreamFromBroadcast()

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

Parâmetros : | | | | --- | --- | | broadcastId | O ID da transmissão. | | streamId | O ID do stream. |

Exceções : | | | | --- | --- | | OpenTokArgumentException | |

RemoveStreamFromBroadcastAsync()

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

Parâmetros : | | | | --- | --- | | broadcastId | O ID da transmissão. | | streamId | O ID do stream. |

Exceções : | | | | --- | --- | | OpenTokArgumentException | |

SetArchiveLayout()

Permite alterar dinamicamente o layout de um arquivo composto enquanto ele está sendo gravado. Consulte Personalização do layout do vídeo para arquivos compostos para obter detalhes sobre como personalizar um layout.

Parâmetros : | | | | --- | --- | | archiveId | | | layout | |

Devoluções

SetArchiveLayoutAsync()

Permite alterar dinamicamente o layout de um arquivo composto enquanto ele está sendo gravado. Consulte Personalização do layout do vídeo para arquivos compostos para obter detalhes sobre como personalizar um layout.

Parâmetros : | | | | --- | --- | | archiveId | | | layout | |

Devoluções

SetBroadcastLayout()

Define o tipo de layout para a transmissão. Para obter uma descrição dos tipos de layout, consulte Configurando o layout de vídeo para transmissões ao vivo no OpenTok.

Parâmetros : | | | | --- | --- | | broadcastId | O ID da transmissão da sessão de transmissão. | | layout | O BroadcastLayout que define as opções de layout para a transmissão. |

SetBroadcastLayoutAsync()

Define o tipo de layout para a transmissão. Para obter uma descrição dos tipos de layout, consulte Configurando o layout de vídeo para transmissões ao vivo no OpenTok.

Parâmetros : | | | | --- | --- | | broadcastId | O ID da transmissão da sessão de transmissão. | | layout | O BroadcastLayout que define as opções de layout para a transmissão. |

SetCustomUserAgent()

Define um valor personalizado para o user-agent. O HttpClient acrescentará esse valor, caso exista, ao valor inicial do user-agent.

Parâmetros : | | | | --- | --- | | valor | O valor personalizado do user-agent. |

SetDefaultRequestTimeout()

Define o tempo limite padrão da solicitação (em milissegundos) para todas as solicitações WebRequest enviadas pelo SDK

Parâmetros : | | | | --- | --- | | tempo limite | |

SetStreamClassLists()

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 Configuração do layout de vídeo para transmissões ao vivo no OpenTok.

É possível definir a lista inicial de classes de layout para os fluxos publicados por um cliente ao gerar os arquivos utilizados por ele. Consulte o GerarToken método.

Parâmetros : | | | | --- | --- | | sessionId | O sessionId | | streams | Uma lista de StreamsProperties que define listas de classes para um ou mais fluxos na sessão. |

SetStreamClassListsAsync()

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 Configuração do layout de vídeo para transmissões ao vivo no OpenTok.

É possível definir a lista inicial de classes de layout para os fluxos publicados por um cliente ao gerar os arquivos utilizados por ele. Consulte o GerarToken método.

Parâmetros : | | | | --- | --- | | sessionId | O sessionId | | streams | Uma lista de StreamsProperties que define listas de classes para um ou mais fluxos na sessão. |

Signal()

Envia um sinal aos clientes (ou a um cliente específico) conectados a uma sessão da Video API da Vonage.

Parâmetros : | | | | --- | --- | | sessionId | O sessionId da Video API da Vonage para o qual o sinal será enviado. | | signalProperties | Este signalProperties define a carga útil do sinal. | | connectionId | Um parâmetro opcional usado para enviar o sinal a uma conexão específica em uma sessão. |

SignalAsync()

Envia um sinal aos clientes (ou a um cliente específico) conectados a uma sessão da Video API da Vonage.

Parâmetros : | | | | --- | --- | | sessionId | O sessionId da Video API da Vonage para o qual o sinal será enviado. | | signalProperties | Este signalProperties define a carga útil do sinal. | | connectionId | Um parâmetro opcional usado para enviar o sinal a uma conexão específica em uma sessão. |

StartArchive()

Inicia o arquivamento de uma sessão da Video API da Vonage.

Os clientes devem estar ativamente conectados à sessão da Video API da Vonage 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 Media Router da Video API da Vonage (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”.

Observe que é possível fazer com que a sessão seja arquivada automaticamente definindo o parâmetro archiveMode do CreateSession método para ArchiveMode.ALWAYS.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão da Video API do Vonage a ser arquivada. | | name | O nome do arquivo. Você pode usar esse nome para identificar o arquivo. É uma propriedade do Arquivo objeto, e é uma propriedade dos eventos relacionados a arquivos no OpenTok bibliotecas de clientes. | | hasVideo | Se o arquivo irá gravar vídeo (true) ou não (false). O valor padrão é true (o vídeo é gravado). Se você definir ambos hasAudio e hasVideo para “false”, a chamada para o Iniciar Arquivo O método gera um erro. | | hasAudio | Se o arquivo irá gravar áudio (true) ou não (false). O valor padrão é true (o áudio é gravado). Se você definir ambos hasAudio e hasVideo para “false”, a chamada para o Iniciar Arquivo O método gera um erro. | | outputMode | Indica se todos os fluxos do arquivo são gravados em um único arquivo (OutputMode.COMPOSED, o padrão) ou a arquivos específicos (OutputMode.INDIVIDUAL). | | resolução | A resolução do arquivo. O valor padrão para OutputMode.COMPOSED é “640x480”. Não é possível especificar a resolução para OutputMode.INDIVIDUAL. | | layout | O layout que você deseja usar para o seu arquivo. Se o tipo estiver definido como LayoutType.custom Você deve fornecer à Vonage uma string de StyleSheet indicando como organizar o layout do seu arquivo. | | streamMode | Se os fluxos incluídos no arquivo são selecionados automaticamente (StreamMode.Auto, o padrão) ou manualmente (StreamMode.Manual). Com StreamMode.Manual, você deverá especificar os fluxos a serem incluídos no arquivo usando o OpenTok.AddStreamToArchive e OpenTok.RemoveStreamFromArchive métodos (ou o OpenTok.AddStreamToArchiveAsync e OpenTok.RemoveStreamFromArchiveAsync métodos). | | multiArchiveTag | Defina esse parâmetro para permitir a gravação simultânea de vários arquivos para a mesma sessão. Defina-o como uma sequência de caracteres exclusiva para cada arquivo simultâneo de uma sessão em andamento. Você também deve definir essa opção ao iniciar manualmente um arquivo em uma sessão que é arquivada automaticamente. Se você não especificar um multiArchiveTag exclusivo, só poderá gravar um arquivo por vez para uma determinada sessão. Consulte Arquivos simultâneos. |

Devoluções : O Arquivo objeto. Esse objeto inclui propriedades que definem o arquivo, incluindo o ID do arquivo.

StartArchiveAsync()

Inicia o arquivamento de uma sessão da Video API da Vonage.

Os clientes devem estar ativamente conectados à sessão da Video API da Vonage 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 Media Router da Video API da Vonage (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”.

Observe que é possível fazer com que a sessão seja arquivada automaticamente definindo o parâmetro archiveMode do CreateSession método para ArchiveMode.ALWAYS.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão da Video API do Vonage a ser arquivada. | | name | O nome do arquivo. Você pode usar esse nome para identificar o arquivo. É uma propriedade do Arquivo objeto, e é uma propriedade dos eventos relacionados a arquivos no OpenTok bibliotecas de clientes. | | hasVideo | Se o arquivo irá gravar vídeo (true) ou não (false). O valor padrão é true (o vídeo é gravado). Se você definir ambos hasAudio e hasVideo para “false”, a chamada para o Iniciar Arquivo O método gera um erro. | | hasAudio | Se o arquivo irá gravar áudio (true) ou não (false). O valor padrão é true (o áudio é gravado). Se você definir ambos hasAudio e hasVideo para “false”, a chamada para o Iniciar Arquivo O método gera um erro. | | outputMode | Indica se todos os fluxos do arquivo são gravados em um único arquivo (OutputMode.COMPOSED, o padrão) ou a arquivos específicos (OutputMode.INDIVIDUAL). | | resolução | A resolução do arquivo. O valor padrão para OutputMode.COMPOSED é “640x480”. Não é possível especificar a resolução para OutputMode.INDIVIDUAL. | | layout | O layout que você deseja usar para o seu arquivo. Se o tipo estiver definido como LayoutType.custom Você deve fornecer à Vonage uma string de StyleSheet indicando como organizar o layout do seu arquivo. | | streamMode | Se os fluxos incluídos no arquivo são selecionados automaticamente (StreamMode.Auto, o padrão) ou manualmente (StreamMode.Manual). Com StreamMode.Manual, você deverá especificar os fluxos a serem incluídos no arquivo usando o OpenTok.AddStreamToArchive e OpenTok.RemoveStreamFromArchive métodos (ou o OpenTok.AddStreamToArchiveAsync e OpenTok.RemoveStreamFromArchiveAsync métodos). | | multiArchiveTag | Defina esse parâmetro para permitir a gravação simultânea de vários arquivos para a mesma sessão. Defina-o como uma sequência de caracteres exclusiva para cada arquivo simultâneo de uma sessão em andamento. Você também deve definir essa opção ao iniciar manualmente um arquivo em uma sessão que é arquivada automaticamente. Se você não especificar um multiArchiveTag exclusivo, só poderá gravar um arquivo por vez para uma determinada sessão. Consulte Arquivos simultâneos. |

Devoluções : O Arquivo objeto. Esse objeto inclui propriedades que definem o arquivo, incluindo o ID do arquivo.

StartAudioConnectorAsync()

Envia áudio de uma sessão da Video API da Vonage para um WebSocket. Para obter mais informações, consulte o Guia do desenvolvedor do Audio Connector.

Parâmetros : | | | | --- | --- | | solicitação | A solicitação para iniciar o conector de áudio. |

Retorna : O objeto de resposta do servidor.

StartBroadcast()

Use este método para iniciar uma transmissão ao vivo para uma sessão da Video API da Vonage. Isso transmite a sessão para um fluxo HLS (HTTP Live Streaming) ou para um fluxo RTMP.

Para iniciar com sucesso a transmissão de uma sessão, é necessário que pelo menos um cliente esteja conectado à sessão.

É possível ter apenas uma transmissão ao vivo ativa por vez para uma sessão (no entanto, ter mais de uma não seria útil). A transmissão ao vivo pode ser direcionada a um endpoint HLS e a até cinco servidores RTMP simultaneamente para uma sessão. Você só pode iniciar a transmissão ao vivo para sessões que utilizem o Vonage Video API Media Router (com o modo de mídia definido como “routed”); não é possível usar a transmissão ao vivo com sessões que tenham o modo de mídia definido como “relayed” no Vonage Video API Media Router. Consulte O OpenTok Media Router e os modos de mídia.

Para obter mais informações sobre transmissão, consulte o Guia do desenvolvedor de transmissões.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão correspondente à sessão. | | hls | Se deve incluir uma transmissão HLS. | | rtmpList | Uma lista de RTMP objetos, definindo os fluxos RTMP a serem transmitidos (até cinco). | | resolução | A resolução do vídeo transmitido. As resoluções válidas são “640x480”, “1280x720”, “1920x1080”, “480x640”, “720x1280” e “1080x1920”. | | maxDuration | 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 2 horas (7.200 segundos). | | layout | Especifique isso BroadcastLayout objeto para atribuir o tipo de layout inicial à transmissão. | | streamMode | Se os fluxos incluídos na transmissão são selecionados automaticamente (StreamMode.Auto, o padrão) ou manualmente (StreamMode.Manual). Com StreamMode.Manual, você deverá especificar os streams a serem incluídos na transmissão usando o OpenTok.AddStreamToBroadcast e OpenTok.RemoveStreamFromBroadcast métodos (ou o OpenTok.AddStreamToBroadcastAsync e OpenTok.RemoveStreamFromBroadcastAsync métodos). | | dvr | Indica se a funcionalidade de DVR — retrocesso, pausa e retomada — deve ser ativada nos reprodutores compatíveis (true) ou não (false, valor padrão). Com o DVR ativado, a URL HLS incluirá uma string de consulta ?DVR anexada ao final. Consulte Funcionalidade de DVR | | lowLatency | Se o modo de baixa latência deve ser ativado para a transmissão 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. Consulte Transmissões HLS de baixa latência | | multiBroadcastTag | Defina esse 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. Consulte Transmissões simultâneas. | | hasAudio | Se a transmissão possui áudio (o padrão é true). | | hasVideo | Se a transmissão possui vídeo (o padrão é true). |

Devoluções : O Transmissão objeto. Esse objeto inclui propriedades que definem o arquivo, incluindo o ID do arquivo.

StartBroadcastAsync()

Use este método para iniciar uma transmissão ao vivo para uma sessão da Video API da Vonage. Isso transmite a sessão para um fluxo HLS (HTTP Live Streaming) ou para um fluxo RTMP.

Para iniciar com sucesso a transmissão de uma sessão, é necessário que pelo menos um cliente esteja conectado à sessão.

É possível ter apenas uma transmissão ao vivo ativa por vez para uma sessão (no entanto, ter mais de uma não seria útil). A transmissão ao vivo pode ser direcionada a um endpoint HLS e a até cinco servidores RTMP simultaneamente para uma sessão. Você só pode iniciar a transmissão ao vivo para sessões que utilizem o Vonage Video API Media Router (com o modo de mídia definido como “routed”); não é possível usar a transmissão ao vivo com sessões que tenham o modo de mídia definido como “relayed” no Vonage Video API Media Router. Consulte O OpenTok Media Router e os modos de mídia.

Para obter mais informações sobre transmissão, consulte o Guia do desenvolvedor de transmissões.

Parâmetros : | | | | --- | --- | | sessionId | O ID da sessão correspondente à sessão. | | hls | Se deve incluir uma transmissão HLS. | | rtmpList | Uma lista de RTMP objetos, definindo os fluxos RTMP a serem transmitidos (até cinco). | | resolução | A resolução do vídeo transmitido. As resoluções válidas são “640x480”, “1280x720”, “1920x1080”, “480x640”, “720x1280” e “1080x1920”. | | maxDuration | 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 2 horas (7.200 segundos). | | layout | Especifique isso BroadcastLayout objeto para atribuir o tipo de layout inicial à transmissão. | | streamMode | Se os fluxos incluídos na transmissão são selecionados automaticamente (StreamMode.Auto, o padrão) ou manualmente (StreamMode.Manual). Com StreamMode.Manual, você deverá especificar os streams a serem incluídos na transmissão usando o OpenTok.AddStreamToBroadcast e OpenTok.RemoveStreamFromBroadcast métodos (ou o OpenTok.AddStreamToBroadcastAsync e OpenTok.RemoveStreamFromBroadcastAsync métodos). | | dvr | Indica se a funcionalidade de DVR — retrocesso, pausa e retomada — deve ser ativada nos reprodutores compatíveis (true) ou não (false, valor padrão). Com o DVR ativado, a URL HLS incluirá uma string de consulta ?DVR anexada ao final. Consulte Funcionalidade de DVR | | lowLatency | Se o modo de baixa latência deve ser ativado para a transmissão 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. Consulte Transmissões HLS de baixa latência | | multiBroadcastTag | Defina esse 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. Consulte Transmissões simultâneas. | | hasAudio | Se a transmissão possui áudio (o padrão é true). | | hasVideo | Se a transmissão possui vídeo (o padrão é true). |

Devoluções : O Transmissão objeto. Esse objeto inclui propriedades que definem o arquivo, incluindo o ID do arquivo.

StartRenderAsync()

Inicia um novo renderizador do Experience Composer para uma sessão da Video API da Vonage.

Para obter mais informações, consulte o . Guia do desenvolvedor do Experience Composer.

Parâmetros : | | | | --- | --- | | request | A solicitação de renderização. |

Retorna : A renderização gerada.

StopArchive()

Interrompe um OpenTok arquivo 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.

Parâmetros : | | | | --- | --- | | archiveId | O ID do arquivo cuja gravação você deseja interromper. |

Devoluções : O Arquivo objeto correspondente ao arquivo que está sendo interrompido.

StopArchiveAsync()

Interrompe um OpenTok arquivo 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.

Parâmetros : | | | | --- | --- | | archiveId | O ID do arquivo cuja gravação você deseja interromper. |

Devoluções : O Arquivo objeto correspondente ao arquivo que está sendo interrompido.

StopAudioConnectorAsync()

Interrompe o envio de áudio para uma sessão da Video API da Vonage.

Parâmetros : | | | | --- | --- | | connectionId | O OpenTok ID da conexão para a conexão WebSocket do Audio Connector na sessão da Video API da Vonage. Consulte [AudioConnector.ConnectionId]. |

StopBroadcast()

Use este método para interromper uma transmissão ao vivo de uma sessão da Video API da Vonage. Observe que as transmissões são interrompidas automaticamente 120 minutos após o início.

Para obter mais informações sobre transmissão, consulte o Guia do desenvolvedor de transmissões.

Parâmetros : | | | | --- | --- | | broadcastId | O ID da transmissão da sessão de transmissão |

Devoluções : O Transmissão objeto. Esse objeto inclui propriedades que definem a transmissão, incluindo o ID da transmissão.

StopBroadcastAsync()

Use este método para interromper uma transmissão ao vivo de uma sessão da Video API da Vonage. Observe que as transmissões são interrompidas automaticamente 120 minutos após o início.

Para obter mais informações sobre transmissão, consulte o Guia do desenvolvedor de transmissões.

Parâmetros : | | | | --- | --- | | broadcastId | O ID da transmissão da sessão de transmissão |

Devoluções : O Transmissão objeto. Esse objeto inclui propriedades que definem a transmissão, incluindo o ID da transmissão.

StopRenderAsync()

Interrompe um renderizador do Experience Composer.

Parâmetros : | | | | --- | --- | | renderId | O ID da renderização. |

Documentação do imóvel

ApiKey

A chave da Video API da Vonage passada para o OpenTok() construtor.

ApiSecret

A chave secreta da Video API da Vonage passada para o OpenTok() construtor.

Cliente

Para uso interno

Depuração

Habilita a exibição dos detalhes das solicitações e respostas no console. Não utilize em um ambiente de produção.