Referência do OpenTok.js
O OpenTok.js inclui as seguintes classes:
| Classe | Descrição |
|---|---|
| Arquivo de Eventos | Para verificar se um evento possui um comportamento padrão, verifique a propriedade `cancelable` do objeto do evento. |
| Evento de alteração do dispositivo de entrada de áudio | Para obter mais informações, consulte esta documentação. |
| Evento de atualização do nível de áudio | Para verificar se um evento possui um comportamento padrão, verifique a propriedade `cancelable` do objeto do evento. |
| Recursos | Todas as propriedades de Capabilities permanecem indefinidas até que você se conecte a uma sessão e o objeto Session tenha disparado o evento sessionConnected. |
| CaptionReceivedEvent | Para verificar se um evento possui um comportamento padrão, verifique a propriedade `cancelable` do objeto do evento. |
| Conexão | O objeto Session possui uma propriedade connection que é um objeto Connection. Ela representa a conexão do cliente local. (Um cliente só possui uma conexão depois de ter chamado com sucesso o método connect() do objeto Session.) |
| ConnectionEvent | O objeto Session dispara um evento `connectionCreated` quando um cliente (incluindo o seu próprio) se conecta a uma sessão. Ele também dispara um evento `connectionCreated` para cada cliente na sessão quando você se conecta pela primeira vez. (Quando seu cliente local se conecta, o objeto Session também dispara um evento `sessionConnect`) |
| CpuPerformanceChangedEvent | Para verificar se um evento possui um comportamento padrão, verifique a propriedade `cancelable` do objeto do evento. |
| Erro | A classe `Error` também define o erro lançado quando a promessa retornada por um dos métodos a seguir é rejeitada: |
| Evento | Por exemplo, o objeto `Stream` dispara um evento `streamPropertyChanged` quando as propriedades do stream são atualizadas. Você adiciona uma função de retorno de chamada para um evento usando o método `on()` do objeto `Stream`: |
| EventDispatcher | Obsoleto — use on() ou once() em vez disso. |
| ExceptionEvent | Observe que você configura um callback para o evento de exceção chamando o método OT.on(). |
| MediaStoppedEvent | Para verificar se um evento possui um comportamento padrão, verifique a propriedade `cancelable` do objeto do evento. |
| MediaStreamAvailableEvent | Observe que o áudio será reproduzido tanto pelo elemento personalizado quanto pelo widget Publisher ou Subscriber. Os elementos personalizados devem ser silenciados para evitar eco. |
| MuteForcedEvent | Para verificar se um evento possui um comportamento padrão, verifique a propriedade `cancelable` do objeto do evento. |
| OT | Inicializa e retorna um objeto Publisher. |
| Editora | O código a seguir instancia uma sessão e publica um fluxo de áudio e vídeo assim que a conexão com a sessão é estabelecida: |
| Evento de alteração do Quality Score | Para verificar se um evento possui um comportamento padrão, verifique a propriedade `cancelable` do objeto do evento. |
| Sessão | Obsoleto — use on() ou once() em vez disso. |
| SessionConnectEvent | Na versão 2.2, o `completionHandler` do método `Session.connect()` indica se a conexão com a sessão foi bem-sucedida ou falhou. |
| Event de Desconexão de Sessão | O código a seguir inicializa uma sessão e configura um ouvinte de eventos para o momento em que a sessão for desconectada. |
| SignalEvent | Para verificar se um evento possui um comportamento padrão, verifique a propriedade `cancelable` do objeto do evento. |
| Transmissão | Quando um stream é adicionado a uma sessão, o objeto Session dispara um evento streamCreatedEvent. Quando um stream é destruído, o objeto Session dispara um evento streamDestroyed. O objeto StreamEvent, que define esses objetos de evento, possui uma propriedade stream, que é uma matriz de objetos Stream. Para mais detalhes |
| StreamEvent | O código a seguir se conecta a uma sessão e configura um ouvinte de eventos para quando um stream publicado por outro cliente for criado: |
| StreamPropertyChangedEvent | Para verificar se um evento possui um comportamento padrão, verifique a propriedade `cancelable` do objeto do evento. |
| Assinante | Obsoleto — use on() ou once() em vez disso. |
| Evento de alteração das dimensões do vídeo | No Publisher, esse evento é disparado quando o elemento local do Publisher detecta uma alteração nas dimensões. Quando o Publisher está publicando ativamente, isso também atualiza a propriedade stream.videoDimensions. Exemplos do que pode fazer com que o elemento de vídeo local mude de tamanho: redimensionamento de uma janela de compartilhamento de tela capturada |
| Evento de criação do elemento de vídeo | Adicione um ouvinte para este evento somente se você tiver definido a opção `insertDefaultUI` como `false`. Se você não tiver definido a opção `insertDefaultUI` como `false`, não mova o elemento `video` (ou o elemento `object` que contém o vídeo no Internet Explorer) no DOM HTML. Fazer isso faz com que o Publisher ou o Subscriber |
| Evento de alteração da ativação de vídeo | Se a conectividade melhorar a ponto de permitir novamente a exibição de vídeo, o objeto Subscriber dispara um evento `videoEnabled`, e o Subscriber retoma a recepção do vídeo. |