Referencia de OpenTok.js
OpenTok.js incluye las siguientes clases:
| Clase | Descripción |
|---|---|
| Archivo de eventos | Define los objetos de evento para los eventos «archiveStarted» y «archiveStopped». El objeto «Session» emite estos eventos cuando se inicia y se detiene la grabación de archivo de la sesión. |
| Evento de cambio de dispositivo de entrada de audio | Se envía cuando se cambia el dispositivo de entrada de audio. Para obtener más información, consulta esta documentación. |
| Evento de actualización del nivel de audio | Lo envía periódicamente un objeto «Subscriber» o «Publisher» para indicar el nivel de audio. Este evento se envía hasta 60 veces por segundo, dependiendo del navegador. |
| Capacidades | Una clase que define las propiedades de la propiedad «capabilities» de un objeto «Session». Véase «Session.capabilities». Todas las propiedades de «capabilities» están sin definir hasta que te hayas conectado a una sesión y el objeto «Session» haya disparado el evento «sessionConnected». Para obtener más información sobre los roles de los tokens, consulta la sección «Token» |
| CaptionReceivedEvent | Define un objeto de evento para el evento «captionReceived» enviado por el objeto «Subscriber». El objeto «Subscriber» envía un evento «captionReceived» cuando el suscriptor recibe una leyenda del servicio de transcripción. |
| Conexión | El objeto `Connection` representa una conexión a una sesión de la Video API de Vonage. Cada cliente que se conecta a una sesión tiene una conexión única, con un identificador de conexión único (representado por la propiedad `id` del objeto `Connection` del cliente). El objeto `Session` tiene una propiedad `connection` que es un Co |
| ConnectionEvent | Define los eventos `connectionCreated` y `connectionDestroyed` que envía el objeto {@link Session}. El objeto Session envía un evento `connectionCreated` cuando un cliente (incluido el tuyo propio) se conecta a una sesión. También envía un evento `connectionCreated` para cada cliente de la sesión cuando tú f |
| CpuPerformanceChangedEvent | El objeto «Session» emite un evento «cpuPerformanceChanged» cuando cambia el estado de rendimiento de la CPU. El evento solo se emite en los navegadores basados en Chromium (Chrome 125 o superior, Edge 125 o superior y Opera 111 o superior). Los eventos no se emiten tras desconectarse de una sesión, pero se reanudan tras volver a conectarse. |
| Evento «Cifrado no habilitado» | Define el evento «encryptionNotEnabled» enviado por un objeto Publisher o Subscriber. Este evento se envía cuando se establece un secreto de cifrado en una sesión que no tiene habilitado el cifrado de extremo a extremo a nivel de servidor. Cuando se envía este evento, el objeto Publisher o Subscriber se configura automáticamente |
| Error | La clase `Error` se utiliza para definir el objeto de error que se pasa a los controladores de finalización. Cada uno de los siguientes métodos, que se ejecutan de forma asíncrona, incluye un parámetro `completionHandler`: `OT.initPublisher()`, `OT.reportIssue()`, `OT.setProxyUrl()`, `Publisher.setVideoSource()`, `Session.connect()` y `Session.forceDisc`. |
| Evento | El objeto `Event` define el objeto de evento básico de la Video API de Vonage que se pasa a los detectores de eventos. Otras clases de eventos de la Video API de Vonage implementan las propiedades y los métodos del objeto `Event`. Por ejemplo, el objeto `Stream` envía un evento `streamPropertyChanged` cuando las propiedades de la transmisión son |
| EventDispatcher | Esta clase base define los métodos «on», «once» y «off» de los objetos capaces de enviar eventos. |
| ExceptionEvent | La clase {@link OT} envía eventos de excepción cuando la Video API detecta una excepción (error). El objeto ExceptionEvent define las propiedades del objeto de evento que se envía. Ten en cuenta que para configurar una llamada de retorno para el evento de excepción hay que llamar al método OT.on(). |
| MediaStoppedEvent | Enviado por un editor cuando el usuario ha dejado de compartir uno o todos los tipos de contenido multimedia (vídeo, audio o pantalla). |
| MediaStreamAvailableEvent | Define un objeto de evento para el evento «mediaStreamAvailable», que envían tanto el objeto Publisher como el objeto Subscriber. Tanto el objeto Publisher como el objeto Subscriber envían un evento «mediaStreamAvailable» cuando el MediaStream está disponible para su uso en elementos de vídeo personalizados. Los objetos Publisher y Subscriber |
| MuteForcedEvent | Define el evento «muteForced» que emite un objeto «Session». El objeto «Session» emite este evento cuando un moderador obliga a los clientes que publican transmisiones en la sesión a silenciar el audio (la propiedad «active» del objeto «MuteForcedEvent» se establece en «true»), o cuando un moderador desactiva el estado de silencio del audio. |
| OT | El primer paso para utilizar la Video API de Vonage es llamar al método OT.initSession(). Otros métodos del objeto OT comprueban los requisitos del sistema y configuran el registro de errores. |
| Editorial | El objeto `Publisher` proporciona el mecanismo mediante el cual se lleva a cabo el control del flujo publicado. Al llamar al método `OT.initPublisher()` se crea un objeto `Publisher`. 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: var apiKey = ''; |
| Evento de cambio en la puntuación de calidad | El objeto «Subscriber» emite un evento «qualityScoreChanged» cuando cambia la puntuación de calidad de audio o vídeo para el suscriptor. Las puntuaciones son un valor heurístico que representa la experiencia esperada del suscriptor. Los valores son números enteros que van del 1 al 5, y se corresponden con «malo», p |
| Sesión | El objeto «Session» devuelto por el método OT.initSession() permite acceder a gran parte de las funcionalidades de la Video API de Vonage. |
| SessionConnectEvent | El objeto `Session` envía un objeto `SessionConnectEvent` cuando una sesión se ha conectado correctamente, en respuesta a una llamada al método `connect()` del objeto `Session`. 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 objeto `Session` emite un objeto `SessionDisconnectEvent` cuando una sesión se ha desconectado. Este evento puede emitirse de forma asíncrona en respuesta a una llamada correcta al método `disconnect()` del objeto de sesión. Ejemplo: El siguiente código inicializa una sesión y configura un detector de eventos f |
| SignalEvent | El objeto «Session» emite un evento de señal cuando el cliente recibe una señal de la sesión. |
| Transmisión | Especifica un flujo. Un flujo es una representación de un flujo publicado en una sesión. Cuando un cliente invoca el método Session.publish(), se crea un nuevo flujo. Las propiedades del objeto Stream proporcionan información sobre el flujo. Cuando se añade un flujo a una sesión, el objeto Session envía un s |
| StreamEvent | StreamEvent es un evento que puede tener el tipo «streamCreated» o «streamDestroyed». El objeto Session envía estos eventos cuando otro cliente inicia o detiene la publicación de una transmisión en una {@link Session}. En el caso de la transmisión de un cliente local, es el objeto Publisher el que envía el evento. Ejemplo: strea |
| StreamPropertyChangedEvent | El objeto Session emite un evento streamPropertyChanged en las siguientes circunstancias: un stream ha comenzado o ha dejado de publicar audio o vídeo (véanse Publisher.publishAudio() y Publisher.publishVideo()). Este cambio se produce como resultado de una llamada a los métodos publishAudio() o publishVideo() de Pu |
| Suscriptor | El objeto `Subscriber` es una representación del elemento de vídeo local que reproduce un flujo remoto. El objeto `Subscriber` incluye métodos que permiten desactivar y activar la reproducción de audio local para el flujo al que se está suscrito. El método `subscribe()` del objeto {@link Session} devuelve un objeto `Subscriber`. |
| Evento de navegador no compatible | Define el evento «unsupportedBrowser» enviado por un objeto Publisher o Subscriber. Este evento se envía cuando se establece un secreto de cifrado, pero el navegador no es compatible con el cifrado de extremo a extremo. Cuando se envía este evento, el SDK elimina automáticamente el objeto Publisher o Subscriber (ther |
| Evento de cambio de dimensiones del vídeo | Se activa cuando cambian las dimensiones de vídeo de una transmisión publicada. En el editor, este evento se activa cuando el elemento local del editor detecta un cambio en las dimensiones. Cuando el editor está publicando activamente, esto también actualiza la propiedad `stream.videoDimensions`. Ejemplos de lo que puede provocar el cambio local |
| Evento de creación de un elemento de vídeo | Lo envía un objeto «Subscriber» o «Publisher» para indicar que se ha creado el elemento de vídeo (o el elemento «object» en Internet Explorer). Añade un oyente para este evento cuando establezcas la opción «insertDefaultUI» en «false» en la llamada al método OT.initPublisher() o al método Session.subscribe(). El elemen |
| Evento VideoEnabledChangedEvent | Define el objeto de evento para los eventos «videoDisabled» y «videoEnabled» enviados por el suscriptor. |