Referencia de OpenTok.js
OpenTok.js incluye las siguientes clases:
| Clase | Descripción |
|---|---|
| Archivo de eventos | Para saber si un evento tiene un comportamiento predeterminado, comprueba la propiedad «cancelable» del objeto del evento. |
| Evento de cambio de dispositivo de entrada de audio | Para obtener más información, consulta esta documentación. |
| Evento de actualización del nivel de audio | Para saber si un evento tiene un comportamiento predeterminado, comprueba la propiedad «cancelable» del objeto del evento. |
| Capacidades | Todas las propiedades de Capabilities permanecen sin definir hasta que te hayas conectado a una sesión y el objeto Session haya activado el evento sessionConnected. |
| CaptionReceivedEvent | Para saber si un evento tiene un comportamiento predeterminado, comprueba la propiedad «cancelable» del objeto del evento. |
| Conexión | El objeto `Session` tiene una propiedad `connection` que es un objeto `Connection`. Representa la conexión del cliente local. (Un cliente solo dispone de una conexión una vez que ha llamado correctamente al método `connect()` del objeto `Session`.) |
| ConnectionEvent | El objeto Session emite un evento «connectionCreated» cuando un cliente (incluido el tuyo propio) se conecta a una sesión. También emite un evento «connectionCreated» para cada cliente de la sesión cuando te conectas por primera vez. (Cuando tu cliente local se conecta, el objeto Session también emite un evento «sessionConnect» |
| CpuPerformanceChangedEvent | Para saber si un evento tiene un comportamiento predeterminado, comprueba la propiedad «cancelable» del objeto del evento. |
| Error | La clase `Error` también define el error que se lanza cuando se rechaza la promesa devuelta por uno de los siguientes métodos: |
| Evento | Por ejemplo, el objeto `Stream` emite un evento `streamPropertyChanged` cuando se actualizan las propiedades del flujo. Para añadir una llamada de retorno para un evento, se utiliza el método `on()` del objeto `Stream`: |
| EventDispatcher | Obsoleto: utiliza «on()» o «once()» en su lugar. |
| ExceptionEvent | Ten en cuenta que se configura una función de devolución de llamada para el evento de excepción llamando al método OT.on(). |
| MediaStoppedEvent | Para saber si un evento tiene un comportamiento predeterminado, comprueba la propiedad «cancelable» del objeto del evento. |
| MediaStreamAvailableEvent | Ten en cuenta que el audio se reproducirá tanto a través del elemento personalizado como del widget «Publisher» o «Subscriber». Los elementos personalizados deben silenciarse para evitar el eco. |
| MuteForcedEvent | Para saber si un evento tiene un comportamiento predeterminado, comprueba la propiedad «cancelable» del objeto del evento. |
| OT | Inicializa y devuelve un objeto Publisher. |
| Editorial | El siguiente código crea una instancia de una sesión y publica un flujo de audio y vídeo al conectarse a la sesión: |
| Evento de cambio en la puntuación de calidad | Para saber si un evento tiene un comportamiento predeterminado, comprueba la propiedad «cancelable» del objeto del evento. |
| Sesión | Obsoleto: utiliza «on()» o «once()» en su lugar. |
| SessionConnectEvent | En la versión 2.2, el `completionHandler` del método `Session.connect()` indica si la conexión a la sesión se ha realizado con éxito o ha fallado. |
| SessionDisconnectEvent | El siguiente código inicializa una sesión y configura un detector de eventos para cuando se desconecte la sesión. |
| SignalEvent | Para saber si un evento tiene un comportamiento predeterminado, comprueba la propiedad «cancelable» del objeto del evento. |
| Transmisión | Cuando se añade un flujo a una sesión, el objeto Session emite un evento streamCreatedEvent. Cuando se elimina un flujo, el objeto Session emite un evento streamDestroyed. El objeto StreamEvent, que define estos objetos de evento, tiene una propiedad stream, que es una matriz de objetos Stream. Para más detalles |
| StreamEvent | El siguiente código se conecta a una sesión y configura un detector de eventos para cuando se cree un flujo publicado por otro cliente: |
| StreamPropertyChangedEvent | Para saber si un evento tiene un comportamiento predeterminado, comprueba la propiedad «cancelable» del objeto del evento. |
| Suscriptor | Obsoleto: utiliza «on()» o «once()» en su lugar. |
| Evento de cambio de dimensiones del vídeo | En el Publisher, este evento se activa cuando el elemento local del Publisher detecta un cambio de dimensiones. Cuando el Publisher está publicando de forma activa, esto también actualiza la propiedad `stream.videoDimensions`. Ejemplos de lo que puede provocar que el elemento de vídeo local cambie de tamaño: cambiar el tamaño de una ventana de pantalla compartida capturada. |
| Evento de creación de un elemento de vídeo | Añade un oyente para este evento solo si has establecido la opción `insertDefaultUI` en `false`. Si no has establecido la opción `insertDefaultUI` en `false`, no desplaces el elemento de vídeo (o el elemento `object` que contiene el vídeo en Internet Explorer) en el DOM de HTML. Si lo haces, provocará que el Publisher o el Subscriber |
| Evento VideoEnabledChangedEvent | Si la conectividad mejora y vuelve a permitir la reproducción de vídeo, el objeto «Subscriber» emite un evento «videoEnabled» y el «Subscriber» reanuda la recepción de vídeo. |