Constructor

new OpenTok(apiKey, apiSecret)

Incluye métodos para crear sesiones de OpenTok, generar tokens, trabajar con archivos y mucho más.

Para crear un nuevo objeto OpenTok, llama al constructor de OpenTok con tu clave API de OpenTok y el secreto API de tu Cuenta API de Video de Vonage. No compartas públicamente tu clave secreta de la API. La utilizarás con el constructor de OpenTok (solo en tu servidor web) para crear sesiones de OpenTok.

Asegúrate de incluir el SDK completo de OpenTok para Node.js en tu servidor web.

Parámetros:
Nombre Tipo Descripción
apiKey Cadena Tu clave de API de OpenTok. (Consulta tu Página de cuenta de Video API de Vonage.)
apiSecret Cadena Tu clave secreta de la API de OpenTok. (Consulta tu Página de cuenta de Video API de Vonage.)

Métodos

Nombre Descripción
addArchiveStream(archiveId, streamId, archiveOptions, callback) Añade un flujo a un archivo cuyo «streamMode» esté configurado en «manual».
addBroadcastStream(broadcastId, streamId, broadcastOptions, callback) Añade una transmisión a una emisión cuyo «streamMode» esté configurado en «manual».
createSession(options, callback) Crea una nueva sesión de OpenTok.
deleteArchive(archiveId, callback) Elimina un archivo de OpenTok.
dial(sessionId, token, sipUri, options) Se conecta a una pasarela SIP para introducir un flujo de solo audio en tu sesión de OpenTok.
disableForceMute(sessionId, callback) Desactiva el estado de silencio activo de la sesión.
forceDisconnect(sessionId, connectionId, callback) Desconecta a un participante de una sesión de OpenTok.
forceMuteAll(sessionId, opts, callback) Obliga a todas las transmisiones (excepto a una matriz opcional de transmisiones) de una sesión a silenciar el audio publicado.
forceMuteStream(sessionId, streamId, callback) Forzar que una transmisión concreta de una sesión silencie el audio.
generateToken(sessionId, options, generateT1Token) Crea un token para conectarse a una sesión de OpenTok.
getArchive(archiveId, callback) Obtiene un Archivo objeto correspondiente al ID de archivo indicado.
getBroadcast(broadcastId, callback) Devuelve información sobre una retransmisión en directo.
getRender(renderId, callback) Obtiene un Render objeto correspondiente al ID de renderizado indicado.
getStream(sessionId, options, callback) Obtiene información sobre un flujo.
listArchives(options, callback) Obtiene una lista de Archivo objetos, que representan archivos tanto finalizados como en curso, para tu clave API.
listBroadcasts(options, callback) Obtiene una lista de Emisión objetos, que representan transmisiones tanto finalizadas como en curso, para tu clave API.
listRenders(options, callback) Obtiene una lista de Render objetos, que representan cualquier renderizado en estado «inicial», «iniciado», «detenido» o «fallido», para tu clave API.
listStreams(sessionId, callback) Obtiene una lista de Transmisión objetos que representan los flujos actuales de una sesión.
playDTMF(sessionId, connectionId, digits, callback) Enviar dígitos DTMF a todos los participantes de una sesión activa de OpenTok o a un cliente concreto conectado a dicha sesión.
removeArchiveStream(archiveId, streamId, callback) Elimina un flujo de un archivo compuesto cuyo parámetro `streamMode` esté configurado en «manual».
removeBroadcastStream(broadcastId, streamId, callback) Elimina una transmisión de una emisión cuyo «streamMode» esté configurado en «manual».
setArchiveLayout(archiveId, type, stylesheet, screenshareType, callback) Establece el tipo de diseño de un archivo compuesto.
setBroadcastLayout(broadcastId, type, stylesheet, screenshareType, callback) Establece (o actualiza) el diseño de la emisión.
setStreamClassLists(sessionId, classListArray, callback) Establece la lista de clases de diseño para los flujos de una sesión.
signal(sessionId, connectionId, payload, callback) Envía una señal a todas las conexiones de una sesión o a una en concreto.
startArchive(sessionId, options, callback) Inicia el archivado de una sesión de OpenTok.
startBroadcast(sessionId, options, callback) Inicia una retransmisión en directo.
startCaptions(sessionId, token, options, callback) Activa los subtítulos en directo para una sesión de OpenTok.
startCaptions(captionId, callback)
startRender(options, callback) Inicia un «Experience Composer» para una sesión de OpenTok.
stopArchive(archiveId, callback) Detiene una grabación de OpenTok que se está realizando.
stopBroadcast(broadcastId, callback) Detiene una retransmisión en directo.
stopRender(renderId, callback) Detiene un Experience Composer que se está renderizando.
websocketConnect(sessionId, token, websocketUri, options, callback) Envía el audio de una sesión de la Video API de Vonage a un WebSocket.

addArchiveStream(id_archivo, id_flujo, opciones_archivo, llamada_de_retorno)

Añade una transmisión a un archivo cuyo «streamMode» esté configurado en «manual». Puedes llamar al método varias veces con el mismo ID de transmisión para activar o desactivar el audio o el vídeo de la transmisión en el archivo.

Parámetros:
Nombre Tipo Descripción
archiveId Cadena El identificador del archivo.
streamId Cadena El ID de la transmisión que se va a añadir al archivo.
archiveOptions Objeto Un objeto que tiene estas propiedades: - hasAudio — Si el archivo generado debe incluir el audio de la transmisión (verdadero, valor por defecto) o no (falso). - hasVideo — Si el archivo generado debe incluir el vídeo de la transmisión (verdadero, valor por defecto) o no (falso).
callback función La función que se debe llamar al finalizar la operación. Se pasa un argumento a la función: - error — Un objeto de error (si la llamada al método falla).

addBroadcastStream(broadcastId, streamId, broadcastOptions, callback)

Añade una transmisión a una emisión cuyo «streamMode» esté configurado en «manual». Puedes llamar al método varias veces con el mismo ID de transmisión para activar o desactivar el audio o el vídeo de la transmisión en la emisión.

Parámetros:
Nombre Tipo Descripción
broadcastId Cadena El identificador de emisión.
streamId Cadena El ID de la transmisión que se va a añadir a la retransmisión.
broadcastOptions Objeto Un objeto que tiene estas propiedades: - hasAudio — Si la emisión debe incluir el audio de la transmisión (verdadero, valor por defecto) o no (falso). - hasVideo — Si la retransmisión debe incluir el vídeo de la transmisión (verdadero, valor por defecto) o no (falso).
callback función Un método de devolución de llamada que admite dos parámetros: error, que se asigna a un objeto Error en caso de error, y broadcast, que está configurado en un Emisión objeto en caso de éxito.

createSession(opciones, callback)

Crea una nueva sesión de OpenTok. La sesión se pasa como Sesión objeto en la función de llamada de retorno. El sessionId La propiedad es el ID de sesión, que identifica de forma única la sesión. En caso de error, se pasa un objeto Error a la función de devolución de llamada.

Por ejemplo, al utilizar la biblioteca OpenTok.js, utiliza el ID de sesión al llamar a la OT.initSession() método (para inicializar una sesión de OpenTok).

Las sesiones de OpenTok no caducan. Sin embargo, los tokens de autenticación sí caducan (véase el método `generateToken(String, TokenOptions)`). Ten en cuenta también que las sesiones no pueden eliminarse de forma explícita.

Una cadena de identificación de sesión puede tener una longitud máxima de 255 caracteres. También puedes crear una sesión utilizando el API REST de OpenTok o iniciando sesión en tu Cuenta API de Video de Vonage.

Parámetros:
Nombre Tipo Descripción
options Objeto Este objeto define las opciones de la sesión, incluidas las siguientes propiedades (ambas opcionales): - location (Cadena) — Una dirección IP que los servidores de OpenTok utilizarán para ubicar la sesión en la red global de OpenTok. Si no se especifica una indicación de ubicación, los servidores de OpenTok se basarán en el primer cliente que se conecte a la sesión. - e2ee (Booleano) — Determina si se debe activar [end-to-end encryption](https://tokbox.com/developer/guides/end-to-end-encryption/) for the OpenTok session. Set to «verdadero»or"false". - mediaMode (String) — Determines whether the session will transmit streams using the OpenTok Media Router («derrotado») or not («transmitido»). By default, the setting is «transmitido». With the mediaModeparameter set to«transmitido», the session will attempt to transmit streams directly between clients. If clients cannot connect due to firewall restrictions, the session uses the OpenTok TURN server to relay audio-video streams. The [OpenTok Media Router](/opentok/guides/create-session/#media-mode) provides the following benefits: - archiveMode (String) — Whether the session is automatically archived («siempre») or not («manual»). By default, the setting is «manual», and you must call the StartArchive()method of the OpenTok object to start archiving. To archive the session (either automatically or not), you must set themediaModeparameter to «derrotado». - nombre_del_archivo(String) — The name of the archives to be used in auto-archived sessions. The length of the archive name can be up to 80 chars. Due to encoding limitations the following special characters are translated to a colon (:) character: ~, -, \_. -Resolución del archivo(Enum) — The resolution of archives in an auto-archived session. Valid values are "480x640", "640x480", "720x1280", "1280x720", "1080x1920", and "1920x1080". - The OpenTok Media Router can decrease bandwidth usage in multiparty sessions. (When themediaModeparameter is set to«retransmitido», cada cliente debe enviar un flujo de audio y vídeo independiente a cada cliente suscrito a él.) - El OpenTok Media Router puede mejorar la calidad de la experiencia del usuario mediante solución alternativa de audio y recuperación de vídeo. Gracias a estas características, si la conexión de un cliente se deteriora hasta tal punto que no permite la reproducción del vídeo de una transmisión a la que está suscrito, el vídeo se interrumpe para ese cliente (sin que ello afecte al resto de clientes), y el cliente solo recibe audio. Si la conexión del cliente mejora, el vídeo vuelve a mostrarse. - El OpenTok Media Router es compatible con el archivo función que te permite grabar, guardar y recuperar sesiones de OpenTok.
callback función La función que se invoca cuando finaliza la operación. A esta función se le pasan dos argumentos: - error — En caso de error, este parámetro se establece en un objeto Error. Consulta el mensaje de error para obtener más detalles. En caso de éxito, se establece en null. - session — Si se realiza correctamente, este parámetro se establece en un Sesión objeto. La propiedad sessionId de este objeto es el identificador de la sesión. En caso de error, este parámetro no se establece.

deleteArchive(archiveId, callback)

Elimina un archivo de OpenTok.

Solo se puede eliminar un archivo que tenga el estado «disponible» o «subido». Al eliminar un archivo, se elimina su entrada de la lista de archivos. En el caso de un archivo «disponible», también se elimina el archivo propiamente dicho, por lo que ya no estará disponible para su descarga.

Parámetros:
Nombre Tipo Descripción
archiveId Cadena El ID del archivo que deseas eliminar.
callback función La función que se debe llamar al finalizar la operación. Si se elimina correctamente el archivo, la función se llama sin pasarle ningún argumento. En caso de error, se pasa un objeto de error a la función.

dial(sessionId, token, sipUri, options)

Se conecta a una pasarela SIP para introducir un flujo de solo audio en tu sesión de OpenTok. Forma parte de la funcionalidad SIP.

Parámetros:
Nombre Tipo Descripción
sessionId El ID de sesión correspondiente a la sesión a la que se conectará el usuario.
token El token correspondiente al identificador de sesión que utilizará el usuario SIP para conectarse.
sipUri El URI SIP que marcará la función de interconexión SIP.
options Objeto Un objeto de opciones opcional con las siguientes propiedades (todas ellas opcionales): - headers (Objeto) — Encabezados personalizados que se añadirán a la solicitud SIP INVITE iniciada desde OpenTok hacia la plataforma SIP de terceros. - auth (Objeto) — Las credenciales que se utilizarán para la autenticación HTTP Digest en caso de que así lo requiera la plataforma SIP de terceros. - «username» -- El nombre de usuario que se utilizará en el mensaje SIP INVITE. - «contraseña» -- La contraseña que se utilizará en la solicitud SIP INVITE. - secure (Booleano) — Indica si los flujos multimedia SIP deben transmitirse cifrados o no. - from (Cadena) — El número o la cadena que se enviará al número SIP final como identificador de la persona que llama. Debe ser una cadena con el formato from@example.comdonde from puede ser una cadena o un número. Si from se establece en un número (por ejemplo, "14155550101@example.com"), aparecerá como el número de llamada entrante en los teléfonos de la red PSTN. Si from no está definido o tiene el valor de una cadena (por ejemplo, "joe@example.com"), +00000000 aparecerá como número de llamada entrante en los teléfonos de la red PSTN. - video (Booleano) — Un indicador booleano que indica si la llamada SIP incluirá vídeo (true) o no (false, el valor predeterminado). Si se incluye vídeo, el vídeo del cliente SIP se incorpora a la transmisión de OpenTok que se envía a la sesión de OpenTok. El cliente SIP recibirá una transmisión de vídeo compuesta dinámicamente a partir de las transmisiones publicadas en la sesión de OpenTok. Esta es una función en fase beta. - observeForceMute (opcional) Si el punto final SIP respeta la acción de silenciamiento forzado por parte de otros clientes, como los moderadores (true) o no (false, el valor por defecto). Véase Silenciar el audio de las transmisiones en una sesión. - streams (opcional) Los identificadores de las transmisiones de los participantes a las que se suscribirá el participante SIP. Si no se especifican, se seleccionarán todas las transmisiones de la sesión.
Devoluciones:

A SipInterconnect objeto con las siguientes propiedades:

  • id -- El identificador único de la conferencia de la llamada SIP
  • connectionId -- El identificador de conexión de la transmisión de solo audio que representa la llamada SIP
  • streamId -- El identificador de la transmisión de solo audio que representa la llamada SIP

disableForceMute(sessionId, callback)

Desactiva el estado de silencio activo de la sesión. Una vez que se llame a este método, las nuevas transmisiones publicadas en la sesión ya no tendrán el audio silenciado.

Después de llamar a la OpenTok.forceMuteAll() método, cualquier transmisión publicada tras la llamada se publica con el audio silenciado. Cuando se llama al OpenTok.disableForceMute() Con este método, las transmisiones futuras publicadas en la sesión no se silencian (pero las transmisiones que ya estén silenciadas siguen siéndolo).

Parámetros:
Nombre Tipo Descripción
sessionId El identificador de sesión.
callback función La función que se debe llamar al finalizar la operación. Se pasa un argumento a la función. error — un error que indica que la llamada ha fallado. Se establece en null si la llamada se realiza con éxito.

forceDisconnect(sessionId, connectionId, callback)

Desconecta a un participante de una sesión de OpenTok. Esto es el equivalente en el lado del servidor al Método `forceDisconnect()` en OpenTok.js

Parámetros:
Nombre Tipo Descripción
sessionId El ID de la sesión de OpenTok a la que está conectado el cliente del que quieres desconectarte.
connectionId El ID de conexión del cliente que deseas desconectar.
callback función La función que se debe llamar al finalizar la operación. Se pasan dos argumentos a la función: - error — Un objeto de error (si la llamada al método falla).

forceMuteAll(sessionId, opts, callback)

Obliga a todas las transmisiones (excepto a una matriz opcional de transmisiones) de una sesión a silenciar el audio publicado.

Además de las transmisiones existentes, cualquier transmisión que se publique tras la llamada a este método se publicará con el audio silenciado. Puedes desactivar el estado de silencio de una sesión llamando al método OpenTok.disableForceMute() método.

Parámetros:
Nombre Tipo Descripción
sessionId El identificador de sesión.
opts Un objeto que contiene las siguientes propiedades: - excudedStreamIds (Matriz de cadenas) — Una matriz de identificadores de transmisiones que se deben excluir del silenciamiento. Es opcional. Si no se configura esta propiedad, se silenciarán todas las transmisiones de la sesión.
callback función La función que se debe llamar al finalizar la operación. Se pasa un argumento a la función. error — un error que indica que la llamada ha fallado. Se establece en null si la llamada se realiza con éxito.

forceMuteStream(sessionId, streamId, callback)

Forzar que una transmisión concreta de una sesión silencie el audio.

Parámetros:
Nombre Tipo Descripción
sessionId Cadena El identificador de sesión.
streamId Cadena El identificador de la transmisión.
callback función La función que se debe llamar al finalizar la operación. Se pasa un argumento a la función. error — un error que indica que la llamada ha fallado. Se establece en null si la llamada se realiza con éxito.

generateToken(sessionId, options, generateT1Token)

Crea un token para conectarse a una sesión de OpenTok. Para autenticar a un usuario que se conecta a una sesión de OpenTok, el cliente envía un token al conectarse a la sesión.

Para realizar pruebas, también puedes generar un token iniciando sesión en tu Cuenta API de Video de Vonage.

Parámetros:
Nombre Tipo Descripción
sessionId El ID de sesión correspondiente a la sesión a la que se conectará el usuario.
options Un objeto que define las opciones del token (todas ellas opcionales): - role (Cadena) — El rol del token. Cada rol define un conjunto de permisos concedidos al token: - 'subscriber' — Un suscriptor solo puede suscribirse a transmisiones. - 'publisher' — Un editor puede publicar flujos, suscribirse a flujos y enviar señales. (Este es el valor predeterminado si no se especifica un rol.) - 'publisheronly' — Un editor solo puede publicar transmisiones, pero no puede suscribirse a ellas. - 'moderator' — Además de los privilegios concedidos a un editor, un moderador puede realizar funciones de moderación, como obligar a los clientes a desconectarse, a dejar de publicar transmisiones o a silenciar el audio en las transmisiones publicadas. Consulte la Guía para desarrolladores sobre moderación. - expireTime (Número) — El tiempo de caducidad del token, en segundos desde la época UNIX. El tiempo máximo de caducidad es de 30 días a partir de la fecha de creación. Si se especifica un número fraccionario, se redondea a la baja al número entero más cercano. El tiempo de caducidad predeterminado es de 24 horas a partir de la fecha de creación del token. - data (Cadena) — Una cadena que contiene metadatos de conexión que describen al usuario final. Por ejemplo, puedes pasar el ID de usuario, el nombre u otros datos que describan al usuario final. La longitud de la cadena está limitada a 1000 caracteres. Estos datos no se pueden actualizar una vez establecidos. - initialLayoutClassList (Matriz) — Una matriz de nombres de clases (cadenas de caracteres) que se utilizarán como clases de diseño iniciales para las transmisiones publicadas por el cliente. Las clases de diseño se utilizan para personalizar el diseño de los vídeos en retransmisiones en directo y archivos recopilados.
generateT1Token Los tokens de conexión son ahora JWT firmados con SHA-256. Configúralo así: true para crear un token utilizando el formato T1 heredado.
Devoluciones:

La cadena del token.

getArchive(archiveId, callback)

Obtiene un Archivo objeto correspondiente al ID de archivo indicado.

Parámetros:
Nombre Tipo Descripción
archiveId Cadena El identificador del archivo.
callback función La función que se debe llamar al finalizar la operación. Se pasan dos argumentos a la función: - error — Un objeto de error (si la llamada al método falla). - archive - La Archivo objeto.

getBroadcast(broadcastId, callback)

Devuelve información sobre una retransmisión en directo.

Parámetros:
Nombre Tipo Descripción
broadcastId Cadena El identificador de la emisión.
callback función Un método de devolución de llamada que admite dos parámetros: error, que se asigna a un objeto Error en caso de error, y broadcast, que está configurado en un Emisión objeto en caso de éxito.

getRender(renderId, callback)

Obtiene un Render objeto correspondiente al ID de renderizado indicado.

Parámetros:
Nombre Tipo Descripción
renderId Cadena El identificador de la representación.
callback función La función que se debe llamar al finalizar la operación. Se pasan dos argumentos a la función: - error — Un objeto de error (si la llamada al método falla). - render - La Render objeto.

getStream(sessionId, options, callback)

Obtiene información sobre una transmisión. La transmisión debe estar activa en una sesión de OpenTok.

Parámetros:
Nombre Tipo Descripción
sessionId Cadena El ID de la sesión de OpenTok que contiene la transmisión.
options Cadena El identificador de la transmisión.
callback función La función que se debe llamar al finalizar la operación. Se pasan dos argumentos a la función: - error — Un objeto de error (si la llamada al método falla). Se establece en null si no hay ningún error. La llamada a este método da lugar a un error si se pasa un ID de flujo o un ID de sesión no válido. - stream - La Transmisión objeto. Este objeto incluye propiedades que definen el flujo. Si se produce un error, este valor queda sin definir.

listArchives(opciones, callback)

Obtiene una lista de Archivo objetos, que representan archivos tanto finalizados como en curso, para tu clave API.

Parámetros:
Nombre Tipo Descripción
options Objeto Un parámetro de opciones con tres propiedades: - count — El número máximo de archivos que se van a devolver. El número predeterminado de archivos devueltos es 50 (o menos, si hay menos de 50 archivos). El método devuelve un máximo de 1000 archivos. - offset — El desplazamiento del primer archivo de la lista (empezando por el primer archivo registrado con el desplazamiento 0). 1 es el desplazamiento del archivo que comenzó antes que el archivo más reciente. Esta propiedad es opcional; el valor por defecto es 0. - sessionId — Especifica el ID de una sesión para recuperar archivos correspondientes específicamente a esa sesión. Esta propiedad es opcional. Si no se especifica ningún ID de sesión, el método devolverá archivos de cualquier sesión creada con tu clave API. Si no pasas un options argumento, el método devuelve hasta 1 000 archivos, empezando por el primer archivo registrado.
callback función La función que se debe llamar al finalizar la operación. Se pasan dos argumentos a la función: - error — Un objeto de error (si la llamada al método falla). - archives - Una matriz de Archivo objetos.

listBroadcasts(opciones, callback)

Obtiene una lista de Emisión objetos, que representan transmisiones tanto finalizadas como en curso, para tu clave API.

Parámetros:
Nombre Tipo Descripción
options Objeto Un parámetro de opciones con tres propiedades: - count — El número máximo de difusiones que se van a devolver. El número predeterminado de difusiones devueltas es 50 (o menos, si hay menos de 50 difusiones). El método devuelve un máximo de 1000 difusiones. - offset — El desplazamiento de la primera emisión de la lista (empezando por la primera emisión registrada como desplazamiento 0). 1 es el desplazamiento de la emisión que comenzó antes que la emisión más reciente. Esta propiedad es opcional; el valor por defecto es 0. - sessionId — Especifica el ID de una sesión para recuperar las transmisiones correspondientes específicamente a esa sesión. Esta propiedad es opcional. Si no se especifica ningún ID de sesión, el método devolverá las transmisiones de cualquier sesión creada con tu clave API. Si no pasas un options argumento, el método devuelve hasta 1000 emisiones, empezando por la primera emisión registrada.
callback función La función que se debe llamar al finalizar la operación. Se pasan dos argumentos a la función: - error — Un objeto de error (si la llamada al método falla). - broadcasts - Una matriz de Emisión objetos.

listRenders(opciones, callback)

Obtiene una lista de Render objetos, que representan cualquier renderizado en estado inicial, iniciado, detenido o fallido, para tu clave de API.

Parámetros:
Nombre Tipo Descripción
options Objeto Un parámetro de opciones con tres propiedades: - count — El número máximo de representaciones que se van a devolver. El número predeterminado de representaciones devueltas es 50 (o menos, si hay menos de 50 representaciones). El método devuelve un máximo de 1000 representaciones. - offset — El desplazamiento del primer renderizado de la lista (empezando por el primer renderizado registrado, cuyo desplazamiento es 0). 1 es el desplazamiento del renderizado que comenzó antes que el más reciente. Esta propiedad es opcional; el valor por defecto es 0. - sessionId — Especifica el ID de una sesión para recuperar los renders correspondientes específicamente a esa sesión. Esta propiedad es opcional. Si no se especifica ningún ID de sesión, el método devolverá los renders de cualquier sesión creada con tu clave API. Si no pasas un options argumento, el método devuelve hasta 1000 representaciones, empezando por la primera representación registrada.
callback función La función que se debe llamar al finalizar la operación. Se pasan dos argumentos a la función: - error — Un objeto de error (si la llamada al método falla). - renders - Una matriz de Render objetos.

listStreams(sessionId, callback)

Obtiene una lista de Transmisión objetos que representan los flujos actuales de una sesión.

Parámetros:
Nombre Tipo Descripción
sessionId Cadena El ID de la sesión de OpenTok que contiene las transmisiones.
callback función La función que se debe llamar al finalizar la operación. Se pasan dos argumentos a la función: - error — Un objeto de error (si la llamada al método falla). Se establece en null si no hay ningún error. La llamada a este método da lugar a un error si se pasa un ID de sesión no válido. - streams - Una matriz de Transmisión objetos. Cada objeto Stream incluye propiedades que definen el flujo. Este valor no está definido si se produce un error.

playDTMF(idSesión, idConexión, dígitos, llamada de retorno)

Enviar dígitos DTMF a todos los participantes de una sesión activa de OpenTok o a un cliente concreto conectado a dicha sesión.

Parámetros:
Nombre Tipo Descripción
sessionId El identificador de sesión correspondiente a la sesión que recibirá la secuencia DTMF.
connectionId El ID de conexión del cliente al que se envía la señal DTMF. Déjalo en blanco para enviar una señal DTMF a todos los clientes conectados a la sesión.
digits Esta es la secuencia de dígitos DTMF que hay que enviar. Puede incluir los números del 0 al 9, «*», «#» y «p». La letra «p» indica una pausa de 500 ms (si necesitas añadir un retraso al enviar los dígitos).
callback función La función que se debe llamar al finalizar la operación. Se pasa un argumento a la función: - error — Un objeto de error (si falla la llamada al método). Se establece en null si no hay ningún error.

removeArchiveStream(id_archivo, id_flujo, callback)

Elimina un flujo de un archivo compuesto cuyo parámetro `streamMode` esté configurado en «manual».

Parámetros:
Nombre Tipo Descripción
archiveId Cadena El identificador del archivo.
streamId Cadena El ID de la transmisión que se va a eliminar del archivo.
callback función La función que se debe llamar al finalizar la operación. Si la llamada falla, se pasa un error a la función.

removeBroadcastStream(broadcastId, streamId, callback)

Elimina una transmisión de una emisión cuyo «streamMode» esté configurado en «manual».

Parámetros:
Nombre Tipo Descripción
broadcastId Cadena El identificador de emisión.
streamId Cadena El ID de la transmisión que se va a eliminar de la emisión.
callback función La función que se debe llamar al finalizar la operación. Si la llamada falla, se pasa un error a la función.

setArchiveLayout(id_archivo, tipo, hoja_de_estilo, tipo_de_compartición_de_pantalla, función_de_retorno)

Establece el tipo de diseño de un archivo compuesto. Para obtener una descripción de los tipos de diseño, consulta Personalización del diseño de vídeo para los archivos compuestos.

Parámetros:
Nombre Tipo Descripción
archiveId Cadena El identificador del archivo.
type Cadena El tipo de diseño. Establece este valor en «bestFit», «pip», «verticalPresentation», «horizontalPresentation», «focus» o «custom». Para obtener una descripción de estos tipos de diseño, consulta Personalización del diseño de vídeo para los archivos compuestos.
stylesheet Cadena (Opcional) La hoja de estilos para un diseño personalizado. Establece este parámetro si configuras type a "custom". De lo contrario, déjalo sin definir o establécelo en «null».
screenshareType Cadena (Opcional) El tipo de diseño que se debe utilizar cuando hay una transmisión compartida de pantalla en la sesión. Ten en cuenta que, para utilizar este parámetro, debes configurar el type parámetro a «bestFit» y configura el stylesheet parámetro a null.
callback función La función que se debe llamar al finalizar la operación. En caso de error, un error Se pasa el objeto a la función. Si la operación se realiza correctamente, se llama a la función sin pasarle ningún objeto de error.

setBroadcastLayout(broadcastId, type, stylesheet, screenshareType, callback)

Establece (o actualiza) el diseño de la emisión. Véase Configuración del diseño de vídeo para las retransmisiones en directo de OpenTok.

Parámetros:
Nombre Tipo Descripción
broadcastId Cadena El identificador de la emisión.
type Cadena El tipo de diseño. Establece este valor en «bestFit», «pip», «verticalPresentation», «horizontalPresentation», «focus» o «custom». Para obtener una descripción de estos tipos de diseño, consulta Configuración del diseño para las retransmisiones en directo de OpenTok.
stylesheet Cadena (Opcional) La hoja de estilos para un diseño personalizado. Establece este parámetro si configuras type a «custom». De lo contrario, déjalo sin definir o configúralo en null.
screenshareType Cadena (Opcional) El tipo de diseño que se debe utilizar cuando hay una transmisión compartida de pantalla en la sesión. Ten en cuenta que, para utilizar este parámetro, debes configurar el type parámetro a «bestFit» y configura el stylesheet parámetro a null.
callback función La función que se debe llamar al finalizar la operación. En caso de error, se pasa un objeto Error a la función. En caso de éxito, la función se llama sin que se le pase ningún objeto Error.

setStreamClassLists(sessionId, classListArray, callback)

Establece la lista de clases de diseño para las transmisiones de una sesión. Las clases de diseño se utilizan en el diseño de archivos compuestos y retransmisiones en directo. Para obtener más información, consulta Personalización del diseño de vídeo para los archivos compuestos y Configuración del diseño de vídeo para las retransmisiones en directo de OpenTok.

Puedes configurar la lista inicial de clases de diseño para las secuencias publicadas por un cliente al generar las que utiliza el cliente. Consulta la OpenTok.generateToken() método.

Parámetros:
Nombre Tipo Descripción
sessionId Cadena El identificador de la sesión a la que pertenecen las transmisiones.
classListArray Matriz (Opcional) Una matriz que define las listas de clases que se aplicarán a los flujos. Cada elemento de la matriz es un objeto con dos propiedades: id y layoutClassList. En id La propiedad es el ID de la transmisión (una cadena de caracteres), y la layoutClassList es una matriz de nombres de clases (cadenas de caracteres) que se aplicarán al flujo. Establecer layoutClassList a un array vacío para borrar la lista de clases de diseño de un flujo. Por ejemplo, esto streamClassArray array establece la lista de clases de diseño para tres flujos: const classListArray = [ { id: '7b09ec3c-26f9-43d7-8197-f608f13d4fb6', layoutClassList: ['focus'] }, { id: '567bc941-6ea0-4c69-97fc-70a740b68976', layoutClassList: ['top'] }, { id: '307dc941-0450-4c09-975c-705740d08970', layoutClassList: ['bottom'] } ];
callback función La función que se debe llamar al finalizar la operación. En caso de error, un error Se pasa el objeto a la función. Si la operación se realiza correctamente, se llama a la función sin pasarle ningún objeto de error.

signal(sessionId, connectionId, payload, callback)

Envía una señal a todas las conexiones de una sesión o a una en concreto.

Los clientes deben estar conectados activamente a la sesión de OpenTok para que puedas enviarles una señal correctamente.

Para más información, consulte el Señalización de OpenTok guía de programación.

Parámetros:
Nombre Tipo Descripción
sessionId El ID de la sesión de OpenTok a la que quieres enviar la señal.
connectionId El ID de conexión de un cliente conectado a la sesión. Déjalo en blanco si quieres enviar una señal a todas las conexiones de la sesión.
payload Un objeto con un parámetro opcional data y type propiedades: - data — Los datos que se van a enviar. El límite de longitud de la cadena de datos es de 8 kB. No establezcas la cadena de datos en «null» ni en «undefined». - type — El tipo de la señal. Los clientes pueden utilizar el tipo para filtrar las señales. La longitud máxima de la cadena del tipo es de 128 caracteres.
callback función La función de devolución de llamada que se invoca cuando la llamada al método se realiza correctamente o falla. Si la llamada falla, se pasa un objeto de error a la función de devolución de llamada.

startArchive(sessionId, options, callback)

Inicia el archivado de una sesión de OpenTok.

Los clientes deben estar conectados activamente a la sesión de OpenTok para que puedas iniciar correctamente la grabación de un archivo.

Solo puedes grabar un archivo a la vez para una sesión determinada. Solo puedes grabar archivos de sesiones que utilicen el OpenTok Media Router (sesiones cuyo modo multimedia esté configurado como «routed»); no puedes archivar sesiones cuyo modo multimedia esté configurado como «relayed».

Parámetros:
Nombre Tipo Descripción
sessionId El ID de la sesión de OpenTok que se va a archivar.
options Objeto Un objeto de opciones opcional con las siguientes propiedades (cada una de ellas es opcional): - name (Cadena) — el nombre del archivo, que puedes utilizar para identificarlo. El nombre se establece como una propiedad del objeto Archive y es una propiedad de los eventos relacionados con el archivo en las bibliotecas de cliente de OpenTok. - hasAudio (Booleano) — Si el archivo incluirá una pista de audio (true) o no (false). El valor por defecto es true (se incluye una pista de audio). Si configuras ambas hasAudio y hasVideo a false, la llamada a la startArchive() El método da lugar a un error. - hasVideo (Booleano) — Si el archivo incluirá una pista de vídeo (true) o (no false). El valor por defecto es true (se incluye una pista de vídeo). Si configuras ambas hasAudio y hasVideo a false, la llamada a la startArchive() El método da lugar a un error. - outputMode (Cadena) — Indica si todas las secuencias del archivo se graban en un único archivo («compuesto», valor predeterminado) o en archivos individuales («individual»). - layout (Objeto) — Un objeto que define las opciones de diseño iniciales de un archivo compuesto. Este objeto tiene tres propiedades: type, stylesheety screenshareType, que son cadenas de caracteres. Establecer type a «bestFit», «pip», «verticalPresentation», «horizontalPresentation» o «custom». Establece el stylesheet propiedad si type está configurado en «personalizado», y configúralo en la hoja de estilos que define el diseño personalizado. Por ejemplo, configura el layout oponerse a { type: "pip" } para configurar el diseño inicial del archivo en «imagen en imagen». Configura el screenshareType propiedad del tipo de diseño que se utilizará cuando haya una transmisión compartida de pantalla en la sesión (Esta propiedad es opcional). Ten en cuenta que si configuras la screenshareType propiedad, debes configurar la type asigna la propiedad a «bestFit» y deja el stylesheet Propiedad no definida. Para más información, consulta Personalización del diseño de vídeo para los archivos compuestos. - resolution (Cadena) — En el caso de un archivo compuesto, establece este valor en la resolución del archivo. Los valores válidos son «1920x1080», «1280x720» o «640x480» (el valor por defecto). - streamMode (opcional) — El modo de transmisión para el archivo. Se puede establecer en una de las siguientes opciones: - «auto» — Las transmisiones incluidas en el archivo se seleccionan automáticamente (valor predeterminado). - «manual»: especifica las transmisiones que se van a incluir en función de las llamadas a la función OpenTok.addArchiveStream() y OpenTok.removeArchiveStream() métodos. - multiArchiveTag (Cadena) — Configura esta opción para permitir la grabación simultánea de varios archivos de la misma sesión. Establece una cadena única para cada archivo simultáneo de una sesión en curso. También debes configurar esta opción cuando inicies manualmente un archivo que se archiva automáticamente. Ten en cuenta que el multiArchiveTag El valor no se incluye en la respuesta de los métodos destinados a mostrar una lista de archivos y a recuperar información sobre los mismos. Si no se especifica un valor único multiArchiveTag Solo se puede grabar un archivo a la vez en una sesión determinada. - maxBitrate (Número) — La tasa de bits máxima de vídeo para el archivo, en bits por segundo. Esta opción solo es válida para archivos compuestos. Establezca la tasa de bits máxima de vídeo para controlar el tamaño del archivo compuesto. Esta tasa de bits máxima se aplica únicamente a la tasa de bits de vídeo. Si el archivo de salida contiene audio, esos bits quedarán excluidos del límite. Para obtener más información sobre la creación de archivos y los formatos de archivo, consulte la Archivado de OpenTok guía de programación.
callback función La función que se debe llamar al finalizar la operación. Se pasan dos argumentos a la función: - error — Un objeto de error (si la llamada al método falla). - archive - La Archivo objeto. Este objeto incluye propiedades que definen el archivo, entre ellas el identificador del archivo.

startBroadcast(sessionId, options, callback)

Inicia una retransmisión en directo. Consulta la retransmisión en directo guía del desarrollador.

Parámetros:
Nombre Tipo Descripción
sessionId Cadena El ID de la sesión que se va a retransmitir.
options Objeto Un objeto con la siguiente forma: { outputs: { hls: { dvr: false, lowLatency: false, }, rtmp: [{ id: "foo", serverUrl: "rtmp://myfooserver/myfooapp", streamName: "myfoostream" }, { id: "bar", serverUrl: "rtmp://mybarserver/mybarapp", streamName: "mybarstream" }] }, maxDuration: 5400, resolution: "640x480", layout: { type: "custom", stylesheet: "the layout stylesheet (only used with type == custom)", screenshareType: "the layout type to use when there is a screen-sharing stream (optional)" }, streamMode: "manual" } El options El objeto incluye las siguientes propiedades: - outputs (obligatorio) — Este objeto define los tipos de flujos de retransmisión que deseas iniciar. Puedes incluir HLS, RTMP o ambos como flujos de retransmisión. Si incluyes la retransmisión por RTMP, puedes especificar hasta cinco flujos RTMP de destino (o solo uno). Para HLS, incluye un único hls propiedad del objeto «outputs». Este objeto incluye las siguientes propiedades opcionales: - dvr (Booleano) — Si se debe habilitar Funcionalidad de grabación digital (DVR) — rebobinar, pausar y reanudar — en los reproductores que lo admiten (true), o no (false, el valor por defecto). Si la función DVR está activada, la URL HLS incluirá un ?DVR cadena de consulta añadida al final. - lowLatency (Booleano) — Si se debe habilitar modo de baja latencia para la transmisión HLS. Algunos reproductores HLS no admiten el modo de baja latencia. Esta función es incompatible con las transmisiones HLS en modo DVR. La URL HLS se devuelve en el broadcastUrls como el hls propiedad en el Emisión objeto pasado a los métodos de llamada de retorno de la OpenTok#getBroadcast y los métodos #listBroadcast de OpenTok. Para cada transmisión RTMP, especifica serverUrl (la URL del servidor RTMP), streamName (el nombre de la retransmisión, como el nombre de la retransmisión en directo de YouTube o la clave de la retransmisión de Facebook) y (opcionalmente) id (un identificador único para la transmisión). Si se especifica un identificador, se incluirá como el id propiedad de la Emisión objeto pasado a los métodos de llamada de retorno de la startBroadcast() método y el OpenTok.getBroadcast() método. OpenTok transmite la sesión a cada URL RTMP que especifiques. Ten en cuenta que la transmisión en directo de OpenTok es compatible con RTMP y RTMPS. - maxDuration (opcional) — La duración máxima de la retransmisión, en segundos. La retransmisión se detendrá automáticamente cuando se alcance la duración máxima. Puedes establecer la duración máxima en un valor comprendido entre 60 (60 segundos) y 36 000 (10 horas). La duración máxima por defecto es de 4 horas (14 400 segundos). - resolution (opcional) — La resolución de la emisión: o bien "640x480" (SD, el valor por defecto), "1280x720" (HD) o "1920x1080" (FHD). layout (opcional) — Indícalo para asignar el tipo de diseño inicial de la emisión. Este objeto tiene tres propiedades: type, stylesheety screenshareType, que son cadenas de caracteres. Los valores válidos para el type Las propiedades son "bestFit" (ajuste óptimo), "custom" (personalizado), "horizontalPresentation" (presentación horizontal), "pip" (imagen en imagen) y "verticalPresentation" (presentación vertical)). Si se especifica un "custom" tipo de diseño, establezca el stylesheet propiedad del layout objeto a la hoja de estilo. (Para otros tipos de diseño, no establezcas un stylesheet propiedad.) Si no se especifica un tipo de diseño inicial, la transmisión utiliza el tipo de diseño «Best Fit». Establece el screenshareType propiedad del tipo de diseño que se utilizará cuando haya una transmisión compartida de pantalla en la sesión. (Esta propiedad es opcional.) Ten en cuenta que si configuras la screenshareType propiedad, debes configurar la type a "bestFit" y dejar la propiedad stylesheet Propiedad no definida. Para obtener más información, consulta Configuración del diseño de vídeo para las retransmisiones en directo de OpenTok).- streamMode (opcional) — El modo de transmisión de la emisión. Se puede configurar en una de las siguientes opciones: - «auto» — Las transmisiones incluidas en la emisión se seleccionan automáticamente (valor predeterminado). - «manual» — Especifica las transmisiones que se van a incluir mediante llamadas a la OpenTok.addBroadcastStream() y OpenTok.removeBroadcastStream() métodos. - multiBroadcastTag (opcional) — Configura esta opción para permitir varias retransmisiones simultáneas de la misma sesión. Asigna una cadena única a cada retransmisión simultánea de una sesión en curso. Ten en cuenta que el multiBroadcastTag El valor no se incluye en la respuesta de los métodos destinados a mostrar una lista de retransmisiones en directo y a obtener información sobre una retransmisión en directo.
callback función Un método de devolución de llamada que admite dos parámetros: error, que se asigna a un objeto Error en caso de error, y broadcast, que está configurado en un Emisión objeto en caso de éxito.

startCaptions(sessionId, token, options, callback)

Activa los subtítulos en directo para una sesión de OpenTok.

La duración máxima permitida es de 4 horas; transcurrido ese tiempo, el subtitulado de audio se detendrá sin que ello afecte en modo alguno a la sesión de OpenTok en curso. Se enviará un evento a tu URL de devolución de llamada si la has facilitado al iniciar el subtitulado.

Cada sesión de OpenTok solo admite una sesión de subtitulado de audio.

Parámetros:
Nombre Tipo Descripción
sessionId El ID de la sesión de OpenTok que se va a archivar.
token Un token válido de OpenTok con el rol establecido como «Moderador».
options Objeto Un objeto de opciones opcional con las siguientes propiedades (cada una de ellas es opcional): - languageCode (Cadena) — El código BCP-47 de la lengua hablada utilizada en esta llamada. El valor por defecto es «en-US». Se admiten los siguientes códigos de idioma: «en-AU» (inglés, Australia), «en-GB» (inglés, Reino Unido), «en-us» (inglés, EE. UU.), «es-US» (español, EE. UU.), «zh-CN» (chino simplificado), «fr-FR» (francés), «fr-CA» (francés, Canadá), «de-DE» (alemán), «hi-IN» (hindi, India), «it-IT» (italiano), «ja-JP» (japonés), «ko-KR» (coreano), «pt-BR» (portugués, de Brasil), «th-TH» (tailandés). - maxDuration (Número entero) — La duración máxima de los subtítulos de audio, en segundos. El valor por defecto es 14 400 segundos (4 horas), que es la duración máxima permitida. El valor mínimo de maxDuration es 300 (300 segundos, es decir, 5 minutos). - partialCaptions (Booleano) — Indica si se debe habilitar esta opción para acelerar la generación de subtítulos a costa de un cierto grado de imprecisión. El valor predeterminado es «true». Para obtener más información sobre los subtítulos, consulta el Subtítulos de OpenTok guía de programación.
callback función La función que se debe llamar al finalizar la operación. Se pasan dos argumentos a la función: - error — Un objeto de error (si la llamada al método falla). - captionID — El identificador de los subtítulos

startCaptions(captionId, callback)

Desactiva los subtítulos en directo de una sesión de OpenTok

Parámetros:
Nombre Tipo Descripción
captionId El ID de la sesión de OpenTok que se va a archivar. Para obtener más información sobre los subtítulos, consulta el Subtítulos de OpenTok guía de programación.
callback función La función que se debe llamar al finalizar la operación. Se pasan dos argumentos a la función: - error — Un objeto de error (si la llamada al método falla). - success — Siempre es cierto

startRender(opciones, callback)

Inicia un Experience Composer para una sesión de OpenTok. La instancia de Experience Composer se representa como un objeto Render. Para obtener más información, consulta el Guía para desarrolladores de Experience Composer.

Los clientes deben estar conectados activamente a la sesión de OpenTok para que puedas iniciar correctamente la reproducción de una sesión.

Parámetros:
Nombre Tipo Descripción
options Objeto Un objeto de opciones opcional con las siguientes propiedades (cada una de ellas es opcional): - sessionId (Cadena) — El identificador de una sesión (generado con el mismo APIKEY(tal y como se indica en la URL) en la que deseas comenzar a generar el contenido: token (Cadena) — Un token válido de OpenTok con el rol de «Publisher» y (opcionalmente) los datos de conexión que se asociarán a la transmisión de salida. - url (Cadena) — Una URL de acceso público gestionada por el cliente y capaz de generar el contenido que se va a mostrar sin necesidad de intervención por parte del usuario. - properties (Objeto) — Configuración inicial de las propiedades del editor para el flujo de salida compuesto. - maxDuration (Número) — El tiempo máximo permitido para el renderizado, en segundos. Transcurrido este tiempo, el renderizado se detendrá automáticamente, si aún se está ejecutando. - resolution (Cadena) — Resolución del área de visualización de la composición.
callback función La función que se debe llamar al finalizar la operación. Se pasan dos argumentos a la función: - error — Un objeto de error (si la llamada al método falla). - render - La Render objeto. Este objeto incluye propiedades que definen la representación, incluido el identificador de la representación.

stopArchive(idArchivo, callback)

Detiene una grabación de OpenTok que se está realizando.

Los archivos dejan de grabarse automáticamente tras 120 minutos o cuando todos los clientes se han desconectado de la sesión que se está archivando.

No se puede detener un archivo que no se está grabando.

Parámetros:
Nombre Tipo Descripción
archiveId Cadena El ID del archivo del que quieres detener la grabación.
callback función La función que se debe llamar al finalizar la operación. Se pasan dos argumentos a la función: - error — Un objeto de error (si la llamada al método falla). - archive - La Archivo objeto.
Devoluciones:

El Archivo objeto correspondiente al archivo que se está DETENIENDO.

stopBroadcast(broadcastId, callback)

Detiene una retransmisión en directo.

Parámetros:
Nombre Tipo Descripción
broadcastId Cadena El identificador de la emisión.
callback función Un método de devolución de llamada que admite dos parámetros: error, que se asigna a un objeto Error en caso de error, y broadcast, que está configurado en un Emisión objeto en caso de éxito.

stopRender(renderId, callback)

Detiene un Experience Composer que se está renderizando.

Parámetros:
Nombre Tipo Descripción
renderId Cadena El identificador del render que quieres detener.
callback función La función que se debe llamar al finalizar la operación. Se pasan dos argumentos a la función: - error — Un objeto de error (si la llamada al método falla). - render - La Render objeto.
Devoluciones:

El Archivo objeto correspondiente al archivo que se está DETENIENDO.

websocketConnect(sessionId, token, websocketUri, options, callback)

Envía el audio de una sesión de la Video API de Vonage a un WebSocket. Consulta la Conector de audio guía del desarrollador.

Parámetros:
Nombre Tipo Descripción
sessionId Cadena (obligatorio) El ID de sesión de OpenTok que incluye las transmisiones de OpenTok que deseas incluir en la transmisión de WebSocket
token Cadena (obligatorio) El token de OpenTok que se utilizará para la conexión del Audio Streamer a la sesión de OpenTok. Puedes añadir datos del token para identificar que la conexión corresponde al punto final del Audio Streamer o para otros datos de identificación.
websocketUri Cadena (obligatorio) Una URI de WebSocket accesible públicamente que se utilizará como destino de la transmisión de audio (por ejemplo, «wss://service.com/ws-endpoint»).
options Objeto Un objeto de opciones opcional con las siguientes propiedades (todas ellas opcionales): - streams (Matriz) — Una matriz con los identificadores de las transmisiones de OpenTok que deseas incluir en la transmisión WebSocket. Si omites esta propiedad, se incluirán todas las transmisiones de la sesión. - headers (Objeto) — Un objeto compuesto por pares clave-valor de encabezados que se enviarán a tu servidor WebSocket con cada mensaje, con una longitud máxima de 512 bytes.
callback función La función que se debe llamar al finalizar la operación. En caso de error, un error El objeto se pasa como primer parámetro de la función. Si la operación se realiza correctamente, la función se invoca sin que se le pase ningún objeto de error (como primer parámetro) y el segundo parámetro es un objeto con las siguientes propiedades: - id -- Un identificador único que identifica la conexión WebSocket del Audio Streamer. - connectionId -- El ID de conexión de OpenTok correspondiente a la conexión WebSocket del «Audio Streamer» en la sesión de OpenTok.