A classe `Error` é usada para definir o objeto de erro passado aos manipuladores de conclusão. Cada um dos métodos a seguir, que são executados de forma assíncrona, inclui um completionHandler parâmetro:

A classe `Error` também define o erro lançado quando a promessa retornada por um dos seguintes métodos é rejeitada:

O completionHandler O parâmetro é uma função que é chamada quando a chamada ao método assíncrono é bem-sucedida ou falha. Se a chamada assíncrona falhar, à função de tratamento de conclusão é passado um objeto de erro (definido pela classe Error). O code e message As propriedades do objeto de erro fornecem detalhes sobre o erro.

Aviso de descontinuação: OT.Error não será definido em uma versão futura da Video API da Vonage. Quando isso ocorrer, os erros emitidos pelo SDK serão simplesmente instâncias de erros padrão Error objetos. Se o seu código atualmente verifica if (error instanceof OT.Error) por favor, substitua-o if (/^OT_/.test(error.name)). (O name propriedade para todos os erros da Video API da Vonage que começam com 'OT_'.) Observe, no entanto, que esse código tem como objetivo facilitar a atualização, e talvez seja mais adequado que seu código simplesmente compare com o erro específico que você deseja tratar, como, por exemplo, if (error.name === 'OT_USER_MEDIA_ACCESS_DENIED').

Propriedades

Nome Tipo Descrição
code Número Obsoleto — o código de erro. Use o name propriedade, e não o code propriedade, para identificar o erro programaticamente. O code A propriedade do objeto Error pode ser definida como um dos valores listados abaixo. Essa propriedade também pode ser definida com outros valores, e talvez seja recomendável informar esse valor ao discutir um problema com o suporte da API da Vonage. Erros ao chamar Session.connect(): --- --- code Descrição 1004 Erro de autenticação. Verifique a mensagem de erro para obter mais detalhes. Esse erro pode ocorrer se você passar um token vencido ao tentar se conectar a uma sessão. Ele também pode ocorrer se você passar um token ou uma chave de API inválida. Certifique-se de estar gerando o token usando a versão atual de um dos SDKs do servidor da Video API da Vonage. 1005 ID de sessão inválido. Certifique-se de gerar o ID de sessão usando a versão atual de um dos SDKs do servidor da Video API da Vonage. 1006 Falha na conexão. Não foi possível conectar-se à sessão. Recomenda-se que o cliente verifique a conexão de rede. 1026 Violação dos Termos de Serviço: conformidade com as normas de exportação. Consulte o Termos de Serviço. 1027 Limite de conexões excedido. O cliente tentou se conectar a uma sessão que excedeu o limite de conexões simultâneas. 2001 Falha na conexão. Resposta inesperada do servidor da Video API da Vonage. Tente se conectar novamente mais tarde. Erros após a chamada Session.connect(): --- --- code Descrição 3001 - 3007 Por favor, verifique o nome do erro OT_HTTP_ERROR. 4020 Sessão desconectada. Parece que a conexão com a internet caiu. Erros ao chamar Session.forceDisconnect(): --- --- code Descrição 1010 O cliente não está conectado à sessão da Video API da Vonage. Verifique se o cliente se conectou com sucesso e se não se desconectou antes de chamar o método forceDisconnect(). 1520 Não foi possível forçar o desligamento. O token do cliente não possui a função de moderador definida. Assim que o cliente se conectar à sessão, o capabilities A propriedade do objeto Session lista os recursos do cliente. Erros ao chamar Session.forceUnpublish(): --- --- code Descrição 1010 O cliente não está conectado à sessão da Video API da Vonage. Verifique se o cliente se conectou com sucesso e se não se desconectou antes de chamar o método forceUnpublish(). 1530 Não foi possível forçar a retirada da publicação. O token do cliente não possui a função de moderador definida. Assim que o cliente se conectar à sessão, o capabilities A propriedade do objeto Session lista os recursos do cliente. Erros ao chamar Session.publish(): --- --- code Descrição 1010 O cliente não está conectado à sessão da Video API da Vonage. Verifique se o cliente se conecta corretamente antes de tentar publicar. Além disso, verifique se o cliente não se desconectou antes de tentar publicar. 1500 Não foi possível publicar. Isso pode ser causado pelos seguintes motivos: - O token do cliente não possui a função definida como “publicar” ou “moderador”. Assim que o cliente se conectar à sessão, o capabilities A propriedade do objeto Session lista os recursos do cliente. - O usuário final negou acesso à câmera ou ao microfone. - A página foi carregada via HTTP no Chrome, o que exige HTTPS para acessar a câmera e o microfone. 1553 Erro no fluxo de trabalho do WebRTC ICE. Esse é um erro que ocorre ao tentar estabelecer comunicação entre os clientes na sessão. Tente publicar novamente ou se reconectar à sessão. 2001 Falha na publicação. Resposta inesperada do servidor da Video API da Vonage. Tente publicar novamente mais tarde. Erros ao chamar Session.signal(): --- --- code Descrição 400 Uma das propriedades do sinal — “data”, “type” ou “to” — é inválida. Ou os dados não podem ser analisados como JSON. 404 A conexão indicada não existe. 413 A sequência de caracteres do tipo excede o comprimento máximo (128 bytes) ou a sequência de dados excede o tamanho máximo (8 kB). 500 O cliente não está conectado à sessão da Video API da Vonage. Verifique se o cliente se conecta corretamente antes de tentar enviar um sinal. E verifique se o cliente não se desconectou antes de tentar enviar um sinal. 2001 Falha no sinal. Resposta inesperada do servidor da Video API da Vonage. Tente enviar o sinal novamente mais tarde. Erros ao chamar Session.subscribe(): --- --- code Descrição 0009 Formato de mídia não compatível. 0011 Erro na decodificação. 1013 Erro de PeerConnection do WebRTC. Tente republicar o stream, se inscrever novamente no stream ou se reconectar à sessão. 1501 Não foi possível assinar o stream em um prazo razoável. 1502 Este navegador não suporta esse formato de vídeo. 1554 Erro no fluxo de trabalho do WebRTC ICE. Esse erro ocorre ao tentar estabelecer comunicação entre os clientes na sessão. Tente se inscrever novamente no fluxo ou se reconectar à sessão. 1600 Erro interno — Erro de assinante do WebRTC. Tente se inscrever novamente no fluxo ou se reconectar à sessão. 1605 Limite de transmissões excedido. O cliente tentou se inscrever em uma transmissão em uma sessão que já havia excedido o limite de transmissões simultâneas. 2001 Falha na inscrição. Resposta inesperada do servidor da Video API da Vonage. Tente se inscrever novamente mais tarde. Erros ao chamar OT.initPublisher(): --- --- code Descrição 1004 Erro de autenticação. Verifique a mensagem de erro para obter mais detalhes. Esse erro pode ocorrer se você passar um token vencido ao tentar se conectar a uma sessão. Ele também pode ocorrer se você passar um token ou uma chave de API inválida. Certifique-se de estar gerando o token usando a versão atual de um dos SDKs do servidor da Video API da Vonage. Erros ao chamar OT.reportIssue(): --- --- code Descrição 2011 Erro ao chamar OT.reportIssue(). Verifique a conexão de rede do cliente. Erros ao chamar OT.setProxyUrl(): --- --- code Descrição 2021 Tentativa de definir a URL do proxy após a inicialização de um objeto Session ou Publisher. 2022 Tentativa de definir a URL do proxy depois que ela já foi definida (por uma chamada anterior a OT.setProxyUrl()). Erros ao chamar Publisher.setVideoSource(): --- --- code Descrição 1040 A tentativa de alterar a fonte de vídeo de um editor não utiliza a entrada da câmera. 1041 O videoSourceId O parâmetro não é uma string nem o ID de um dispositivo de entrada de vídeo válido. Erros gerais que podem ocorrer ao chamar qualquer método: --- --- code Descrição 1011 Parâmetro inválido. Verifique se você passou valores válidos de parâmetros na chamada do método. 2000 Erro interno. Tente se reconectar à sessão da Video API da Vonage e repita a ação.
message String A mensagem fornece detalhes sobre o erro. Use o name propriedade (não a message (propriedade) para identificar o erro programaticamente.
name String Uma string que identifica o erro. Use esta propriedade (e não a code propriedade) para identificar o erro. Observe que, para todos os erros, essa string começa com 'OT_'. O name A propriedade do objeto Error pode ser definida como um dos valores listados abaixo. Em caso de erros inesperados, essa propriedade pode estar indefinida ou assumir outros valores. Recomenda-se informar esse valor ao discutir um problema com o suporte da API da Vonage. Erros que podem ocorrer ao chamar OT.initPublisher(): --- --- name Descrição 'OT_HARDWARE_UNAVAILABLE' O hardware necessário para atender à solicitação de mídia do usuário parece existir, mas não foi possível obtê-lo. Ele pode estar sendo utilizado por outro aplicativo. 'OT_INVALID_PARAMETER' Um ou mais parâmetros não eram válidos ou não foram fornecidos. 'OT_MEDIA_ENDED' O evento “ended” do elemento de vídeo foi disparado. 'OT_MEDIA_ERR_ABORTED' A obtenção do fluxo para o elemento de vídeo foi interrompida. 'OT_MEDIA_ERR_DECODE' Ocorreu um erro de decodificação ao tentar reproduzir o stream no elemento de vídeo. 'OT_MEDIA_ERR_NETWORK' Um erro de rede fez com que a transmissão parasse de ser carregada. 'OT_MEDIA_ERR_SRC_NOT_SUPPORTED' Foi detectado que o stream não é adequado para reprodução. 'OT_NOT_SUPPORTED' Algum elemento da solicitação de mídia do usuário não é compatível. 'OT_NO_DEVICES_FOUND' Não foram encontrados dispositivos para transmitir o conteúdo multimídia. 'OT_NO_VALID_CONSTRAINTS' O vídeo e o áudio estavam desativados. É preciso ativar pelo menos um deles. 'OT_PROXY_URL_ALREADY_SET_ERROR' O proxyUrl já foi definido. Definir novamente não terá nenhum efeito. 'OT_REQUESTED_DEVICE_PERMISSION_DENIED' O dispositivo de áudio solicitado não possui permissões para ser utilizado. 'OT_SCREEN_SHARING_NOT_SUPPORTED' O compartilhamento de tela não é compatível com este navegador. 'OT_UNABLE_TO_CAPTURE_SCREEN' O compartilhamento de tela não é compatível (e você configurou o videoSource propriedade do options parâmetro de OT.initPublisher() para "application", "screen", ou "window"). Antes de chamar OT.initPublisher(), você pode ligar para OT.checkScreenSharingCapability() para verificar se o compartilhamento de tela é compatível. 'OT_SCREEN_SHARING_EXTENSION_NOT_REGISTERED' O suporte ao compartilhamento de tela neste navegador requer uma extensão, mas ainda não há nenhuma registrada. 'OT_SCREEN_SHARING_EXTENSION_NOT_INSTALLED' O recurso de compartilhamento de tela neste navegador requer uma extensão, mas a extensão não está instalada. Erros que podem ocorrer ao chamar OT.reportIssue(): --- --- name Descrição 'OT_REPORT_ISSUE_FAILED' Erro ao chamar OT.reportIssue(). Verifique a conexão de rede do cliente. Erros que podem ocorrer ao chamar o OT.setProxyUrl() método: --- --- name Descrição 'SET_PROXY_URL_TIMING_ERROR' Tentativa de definir a URL do proxy após a inicialização de um objeto Session ou Publisher. 'PROXY_URL_ALREADY_SET_ERROR' Tentativa de definir a URL do proxy depois que ela já foi definida (por uma chamada anterior a OT.setProxyUrl()). Erros que podem ocorrer ao chamar Publisher.setVideoSource(): --- --- name Descrição 'OT_INVALID_VIDEO_SOURCE' O videoSourceId O parâmetro não é uma string nem o ID de um dispositivo de entrada de vídeo válido. 'OT_SET_VIDEO_SOURCE_FAILURE' A tentativa de alterar a fonte de vídeo de um editor não utiliza a entrada da câmera. Erros que podem ocorrer ao chamar Session.connect(): --- --- name Descrição 'OT_AUTHENTICATION_ERROR' A chave da API não corresponde ao token ou à sessão. 'OT_BADLY_FORMED_RESPONSE' A resposta JSON do servidor da Video API da Vonage estava com formato incorreto. 'OT_CONNECT_FAILED' Não foi possível conectar-se à sessão. 'OT_CONNECTION_LIMIT_EXCEEDED' O cliente tentou se conectar a uma sessão que ultrapassou o limite de conexões simultâneas. 'OT_EMPTY_RESPONSE_BODY' Recebi uma resposta vazia inesperada do servidor da Video API da Vonage. 'OT_INVALID_SESSION_ID' O ID da sessão estava inválido. 'OT_INVALID_PARAMETER' Um ou mais parâmetros não eram válidos ou não foram fornecidos. 'OT_NOT_CONNECTED' Não foi possível realizar a ação porque você não está conectado à rede. 'OT_TERMS_OF_SERVICE_FAILURE' Não foi possível estabelecer conexão devido a uma violação dos termos de serviço. 'OT_INVALID_HTTP_STATUS' Recebeu um status HTTP inesperado. 'OT_XDOMAIN_OR_PARSING_ERROR' Ocorreu um erro entre domínios ou o servidor respondeu com um JSON inválido. 'OT_INVALID_ENCRYPTION_SECRET' A chave de criptografia é inválida. 'OT_UNSUPPORTED_BROWSER' O navegador não oferece suporte à criptografia de ponta a ponta. Erros que podem ocorrer ao chamar Session.forceDisconnect(): --- --- name Descrição 'OT_INVALID_PARAMETER' Um ou mais parâmetros não eram válidos ou não foram fornecidos. 'OT_NOT_CONNECTED' Não foi possível realizar a ação porque você não está conectado à rede. 'OT_PERMISSION_DENIED' Este token não permite essa ação. A função deve ser, no mínimo, a de moderador. Erros que podem ocorrer ao chamar Session.forceMuteAll(): --- --- name Descrição 'OT_INVALID_PARAMETER' Um ou mais parâmetros não eram válidos ou não foram fornecidos. 'OT_NOT_CONNECTED' Não foi possível realizar a ação porque você não está conectado à rede. 'OT_PERMISSION_DENIED' Este token não permite essa ação. A função deve ser, no mínimo, a de moderador. 'OT_UNEXPECTED_SERVER_RESPONSE' Erro interno do servidor. Erros que podem ocorrer ao chamar Session.forceMuteStream(): --- --- name Descrição 'OT_INVALID_PARAMETER' Um ou mais parâmetros não eram válidos ou não foram fornecidos. 'OT_NOT_CONNECTED' Não foi possível realizar a ação porque você não está conectado à rede. 'OT_NOT_FOUND' O ID da transmissão não foi encontrado nesta sessão. 'OT_PERMISSION_DENIED' O token não permite essa ação. A função deve ser, no mínimo, de moderador. 'OT_UNEXPECTED_SERVER_RESPONSE' Erro interno do servidor. Erros que podem ocorrer ao chamar Session.forceUnpublish(): --- --- name Descrição 'OT_INVALID_PARAMETER' Um ou mais parâmetros não eram válidos ou não foram fornecidos. 'OT_NOT_CONNECTED' Não foi possível realizar a ação porque você não está conectado à rede. 'OT_PERMISSION_DENIED' Este token não permite essa ação. A função deve ser, no mínimo, a de moderador. Erros que podem ocorrer ao chamar Session.publish(): --- --- name Descrição 'OT_CHROME_MICROPHONE_ACQUISITION_ERROR' O Chrome não consegue acessar o microfone devido a um erro do próprio Chrome. Para contornar esse problema, o usuário final deve reiniciar o Chrome e recarregar o seu site. Trata-se de um problema conhecido a ser corrigido no Chrome. 'OT_CONSTRAINTS_NOT_SATISFIED' Não foi possível atender às restrições para a obtenção da mídia do usuário. 'OT_CREATE_PEER_CONNECTION_FAILED' Não foi possível estabelecer uma conexão entre este cliente e o assinante ou o Media Router da Video API da Vonage. 'OT_HARDWARE_UNAVAILABLE' O hardware necessário para atender à solicitação de mídia do usuário parece existir, mas não foi possível obtê-lo. Ele pode estar sendo utilizado por outro aplicativo. 'OT_STREAM_CREATE_FAILED' O usuário tentou publicar em uma sessão com criptografia de ponta a ponta ativada sem especificar uma chave de criptografia. 'OT_ICE_WORKFLOW_FAILED' Ocorreu um erro ao estabelecer a conexão WebRTC. 'OT_INVALID_AUDIO_OUTPUT_SOURCE' ID inválido do dispositivo de saída de áudio. Deve ser um ID válido de dispositivo de saída de vídeo. 'OT_INVALID_PARAMETER' Um ou mais parâmetros não eram válidos ou não foram fornecidos. 'OT_MEDIA_ERR_ABORTED' A obtenção do fluxo para o elemento de vídeo foi interrompida. 'OT_MEDIA_ERR_DECODE' Ocorreu um erro de decodificação ao tentar reproduzir o stream no elemento de vídeo. 'OT_MEDIA_ERR_NETWORK' Um erro de rede fez com que a transmissão parasse de ser carregada. 'OT_MEDIA_ERR_SRC_NOT_SUPPORTED' Foi detectado que o stream não é adequado para reprodução. 'OT_NO_DEVICES_FOUND' Não foram encontrados dispositivos para transmitir o conteúdo multimídia. 'OT_NO_VALID_CONSTRAINTS' O vídeo e o áudio estavam desativados. É preciso ativar pelo menos um deles. 'OT_NOT_CONNECTED' Não foi possível realizar a ação porque você não está conectado à rede. 'OT_NOT_SUPPORTED' Algum elemento da solicitação de mídia do usuário não é compatível. 'OT_PERMISSION_DENIED' Este token não permite a publicação. É necessário ter, no mínimo, a função de editor para habilitar essa funcionalidade. 'OT_SCREEN_SHARING_NOT_SUPPORTED' O compartilhamento de tela não é compatível com este navegador. 'OT_SCREEN_SHARING_EXTENSION_NOT_REGISTERED' O suporte ao compartilhamento de tela neste navegador requer uma extensão, mas ainda não há nenhuma registrada. 'OT_SCREEN_SHARING_EXTENSION_NOT_INSTALLED' O recurso de compartilhamento de tela neste navegador requer uma extensão, mas a extensão não está instalada. 'OT_SET_REMOTE_DESCRIPTION_FAILED' A conexão WebRTC falhou durante a execução do método setDescription. 'OT_STREAM_CREATE_FAILED' Não foi possível criar o fluxo no modelo de servidor. 'OT_TIMEOUT' Não foi possível publicar dentro de um prazo razoável. 'OT_USER_MEDIA_ACCESS_DENIED' O usuário final negou permissão para acessar dispositivos de hardware ou negou o acesso à tela (no caso de uma transmissão de compartilhamento de tela). 'OT_UNABLE_TO_CAPTURE_MEDIA' Não foi possível capturar a mídia. Ocorreu um erro desconhecido. 'OT_UNEXPECTED_SERVER_RESPONSE' Isso indica um erro inesperado no servidor da Video API da Vonage. Erros que podem ocorrer ao chamar Session.signal(): --- --- name Descrição 'OT_INVALID_PARAMETER' Um ou mais parâmetros não eram válidos ou não foram fornecidos. 'OT_NOT_CONNECTED' Não foi possível realizar a ação porque você não está conectado à rede. 'OT_NOT_FOUND' Não foi encontrado nenhum recurso. 'OT_RATE_LIMIT_EXCEEDED' O sinal não pôde ser enviado devido ao limite de taxa. Erros que podem ocorrer ao chamar Session.subscribe(): --- --- name Descrição 'OT_CREATE_PEER_CONNECTION_FAILED' Não foi possível estabelecer uma conexão entre este cliente e o emissor do stream ou o Media Router da Video API da Vonage. 'OT_DISCONNECTED' A ação falhou porque o cliente não está conectado à sessão. 'OT_UNABLE_TO_SUBSCRIBE' O usuário tentou se inscrever em uma sessão com criptografia de ponta a ponta ativada sem ter especificado um segredo de criptografia. 'OT_INVALID_PARAMETER' Um ou mais parâmetros não eram válidos ou não foram fornecidos. 'OT_ICE_WORKFLOW_FAILED' Ocorreu um erro ao estabelecer a conexão WebRTC. 'OT_MEDIA_ERR_ABORTED' A obtenção do fluxo para o elemento de vídeo foi interrompida. 'OT_MEDIA_ERR_DECODE' Ocorreu um erro de decodificação ao tentar reproduzir o stream no elemento de vídeo. 'OT_MEDIA_ERR_NETWORK' Um erro de rede fez com que a transmissão parasse de ser carregada. 'OT_MEDIA_ERR_SRC_NOT_SUPPORTED' Foi detectado que o stream não é adequado para reprodução. 'OT_NOT_CONNECTED' Não foi possível realizar a ação porque você não está conectado à rede. 'OT_SET_REMOTE_DESCRIPTION_FAILED' A conexão WebRTC falhou durante a execução do método setDescription. 'OT_STREAM_DESTROYED' A transmissão foi encerrada antes que fosse possível se inscrever nela. 'OT_STREAM_LIMIT_EXCEEDED' O cliente tentou se inscrever em uma transmissão em uma sessão que já havia excedido o limite de transmissões simultâneas. 'OT_STREAM_NOT_FOUND' Não foi possível assinar o stream porque ele não foi encontrado. 'OT_UNABLE_TO_SUBSCRIBE' Não foi possível se inscrever no stream devido a um erro inesperado. Erros que podem ocorrer ao chamar Subscriber.getStats(): --- --- name Descrição 'OT_HTTP_ERROR' A ação falhou. Foi recebida uma resposta inválida do servidor da Video API da Vonage. 'OT_NOT_CONNECTED' Não foi possível realizar a ação porque você não está conectado à rede. Erros que podem ocorrer quando a Promise retornada pela OT.unblockAudio() O método é rejeitado: --- --- name Descrição 'OT_MEDIA_ERR_ABORTED' A obtenção de um fluxo de áudio foi interrompida. 'OT_MEDIA_ERR_NETWORK' Um erro de rede fez com que a obtenção de um stream fosse interrompida. 'OT_MEDIA_ERR_DECODE' Ocorreu um erro de decodificação ao tentar reproduzir um stream. 'OT_MEDIA_ERR_SRC_NOT_SUPPORTED' Foi detectado que um stream não é adequado para reprodução. Erros que podem ocorrer quando a Promise retornada pela Publisher.getRtcStatsReport() ou Subscriber.getRtcStatsReport() O método é rejeitado: --- --- name Descrição 'OT_PEER_CONNECTION_NOT_CONNECTED' O PeerConnection pois o Editor ou o Assinante não está conectado. 'OT_GET_RTC_STATS_REPORT_NOT_SUPPORTED' O navegador não suporta esse método (por exemplo, no Chrome versão 57 e anteriores, que não suportam o RTCPeerConnection.getStats() (padrão).

Métodos

Nome Descrição
isDefaultPrevented() → {Boolean} Se o comportamento padrão do evento foi impedido por meio de uma chamada para preventDefault() (true) ou não (false).
preventDefault() Impede que o comportamento padrão associado ao evento ocorra.

isDefaultPrevented() → {Boolean}

Se o comportamento padrão do evento foi impedido por meio de uma chamada para preventDefault() (true) ou não (false). Veja preventDefault().

Devoluções:

preventDefault()

Impede que o comportamento padrão associado ao evento ocorra.

Para verificar se um evento possui um comportamento padrão, verifique o cancelable propriedade do objeto do evento.

Ligue para o preventDefault() método na função de retorno de chamada do evento.

Os eventos a seguir possuem comportamentos padrão: