java.lang.Object

com.opentok.OpenTok

clase pública OpenTok extende Objeto

Contiene métodos para crear sesiones de OpenTok, generar tokens y trabajar con archivos.

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 del servidor OpenTok en tu servidor web.

Resumen de clases anidadas

Clases anidadas

Modificador y tipo

Clase

Descripción

static class

OpenTok.Builder

Se utiliza para crear un objeto OpenTok con ajustes avanzados.

Resumen del constructor

Constructores

Constructor

Descripción

OpenTok(int apiKey, String apiSecret)

Crea un objeto OpenTok.

OpenTok(String applicationId, Path privateKeyPath)

Crea un objeto OpenTok para utilizarlo con el API de Video de Vonage.

Resumen del método

Todos los métodosMétodos de instanciaMétodos concretos

Modificador y tipo

Método

Descripción

void

addArchiveStream(String archiveId, String streamId, boolean hasAudio, boolean hasVideo)

Añade una transmisión a un archivo de OpenTok.

void

addBroadcastStream(String broadcastId, String streamId, boolean hasAudio, boolean hasVideo)

Añade una transmisión a una emisión de Opentok.

void

close()

Llama a este método cuando hayas terminado de utilizar el objeto OpenTok, para evitar fugas de descriptores de archivos.

AudioConnector

connectAudioStream(String sessionId, String token, AudioConnectorProperties properties)

Enviar el audio de una sesión de la Video API de Vonage a un WebSocket.

Session

createSession()

Crea una sesión de OpenTok con la configuración predeterminada:

Session

createSession(SessionProperties properties)

Crea una nueva sesión de OpenTok.

void

deleteArchive(String archiveId)

Elimina un archivo de OpenTok.

Sip

dial(String sessionId, String token, SipProperties properties)

Se conecta a una pasarela SIP para establecer una sesión de OpenTok.

void

disableForceMute(String sessionId)

Desactiva el estado de silencio activo de la sesión.

void

forceDisconnect(String sessionId, String connectionId)

Desconectar a un cliente de una sesión de OpenTok

void

forceMuteAll(String sessionId, MuteAllProperties properties)

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

void

forceMuteStream(String sessionId, String streamId)

Forzar al emisor de una retransmisión concreta a silenciar su audio.

String

generateToken(String sessionId)

Crea un token para conectarse a una sesión de OpenTok, utilizando la configuración predeterminada.

String

generateToken(String sessionId, TokenOptions tokenOptions)

Crea un token para conectarse a una sesión de OpenTok.

Archive

getArchive(String archiveId)

Obtiene un Archive objeto correspondiente al ID de archivo indicado.

Broadcast

getBroadcast(String broadcastId)

Obtiene un Broadcast objeto correspondiente al ID de emisión indicado.

Render

getRender(String renderId)

Obtiene un objeto «Render», con información sobre un «Experience Composer».

Stream

getStream(String sessionId, String streamId)

Obtiene un Stream objeto correspondiente al ID de sesión y al ID de flujo indicados.

ArchiveList

listArchives()

Devuelve una lista de Archive objetos, que representan archivos que están tanto finalizados como en curso, para tu clave API.

ArchiveList

listArchives(int offset, int count)

Devuelve una lista de Archive objetos, que representan archivos que están tanto finalizados como en curso, para tu clave API.

ArchiveList

listArchives(String sessionId)

Devuelve una lista de Archive objetos, que representan archivos que están tanto finalizados como en curso, para tu clave API.

ArchiveList

listArchives(String sessionId, int offset, int count)

Devuelve una lista de Archive objetos, que representan archivos que están tanto finalizados como en curso, para tu clave API.

List<Render>

listRenders()

Obtiene una lista de objetos «Render», que representan los «Experience Composers» asociados al proyecto OpenTok.

List<Render>

listRenders(Integer offset, Integer count)

Obtiene una lista de objetos «Render», que representan una lista de «Experience Composers» asociados al proyecto de OpenTok.

StreamList

listStreams(String sessionId)

Obtiene una lista de Stream objetos correspondientes al ID de sesión indicado.

void

playDTMF(String sessionId, String dtmfDigits)

Enviar dígitos DTMF a todos los clientes de una sesión.

void

playDTMF(String sessionId, String connectionId, String dtmfDigits)

Enviar dígitos DTMF a un cliente concreto durante una sesión.

void

removeArchiveStream(String archiveId, String streamId)

Elimina una transmisión de un archivo de Opentok.

void

removeBroadcastStream(String broadcastId, String streamId)

Elimina una transmisión de una emisión de Opentok.

void

setArchiveLayout(String archiveId, ArchiveProperties properties)

Establece el tipo de diseño de un archivo compuesto.

void

setBroadcastLayout(String broadcastId, BroadcastProperties properties)

Establece el tipo de diseño de la emisión.

void

setStreamLayouts(String sessionId, StreamListProperties properties)

Establece la lista de clases de diseño para los flujos de una sesión.

void

signal(String sessionId, SignalProperties props)

Envía una señal a todos los clientes conectados a una sesión.

void

signal(String sessionId, String connectionId, SignalProperties props)

Envía una señal a un cliente concreto conectado a una sesión.

Archive

startArchive(String sessionId)

Archive

startArchive(String sessionId, ArchiveProperties properties)

Inicia el archivado de una sesión de OpenTok.

Archive

startArchive(String sessionId, String name)

Broadcast

startBroadcast(String sessionId, BroadcastProperties properties)

Inicia una retransmisión en directo de una sesión de OpenTok.

Caption

startCaptions(String sessionId, String token, CaptionProperties properties)

Utiliza la API de subtítulos en directo para transcribir flujos de audio y generar subtítulos en tiempo real para tu aplicación.

Render

startRender(String sessionId, String token, RenderProperties properties)

Inicia un renderizado de Experience Composer para una sesión de OpenTok.

Archive

stopArchive(String archiveId)

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

Broadcast

stopBroadcast(String broadcastId)

Detiene una retransmisión en directo de una sesión de OpenTok.

void

stopCaptions(String captionsId)

Utiliza este método para desactivar los subtítulos en directo de una sesión.

void

stopRender(String renderId)

Detiene un Experience Composer de una sesión de OpenTok.

Métodos heredados de la clase java.lang.Objeto

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Datos del constructor

OpenTok

public OpenTok(int apiKey, Cadena apiSecret)

Crea un objeto OpenTok.

Parámetros: : apiKey - Tu clave de API de OpenTok. (Consulta tu Página de cuenta de Video API de Vonage.) : apiSecret - Tu clave secreta de la API de OpenTok. (Consulta tu Página de cuenta de Video API de Vonage.)

OpenTok

public OpenTok(Cadena applicationId, Ruta privateKeyPath)

Crea un objeto OpenTok para utilizarlo con el API de Video de Vonage. Se trata de una medida a corto plazo con vistas a la migración completa a Vonage. Consulte el Guía de transición al SDK de Java Para más información.

Parámetros: : applicationId - El UUID de tu aplicación de Vonage con las funciones de vídeo activadas. privateKeyPath - Ruta absoluta a la clave privada de tu aplicación.

Desde: : 4.15.0

Detalles del método

generateToken

público  Cadena generateToken(Cadena sessionId, Opciones de tokens tokenOptions) lanza una excepción Excepción de OpenTok

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.

El siguiente ejemplo muestra cómo obtener un token con el rol de «suscriptor» y que contenga una cadena de metadatos de conexión:

 import com.opentok.Role;
 import com.opentok.TokenOptions;

 class Test {
     public static void main(String args[]) throws OpenTokException {
         int API_KEY = 0; // Replace with your OpenTok API key (see https://tokbox.com/account).
         String API_SECRET = ""; // Replace with your OpenTok API secret.
         OpenTok sdk = new OpenTok(API_KEY, API_SECRET);

         //Generate a basic session. Or you could use an existing session ID.
         String sessionId = System.out.println(sdk.createSession());

         // Replace with meaningful metadata for the connection.
         String connectionMetadata = "username=Bob,userLevel=4";

         // Use the Role value appropriate for the user.
         String role = Role.SUBSCRIBER;

         // Generate a token:
         TokenOptions options = new TokenOptions.Buider().role(role).data(connectionMetadata).build();
         String token = sdk.generateToken(sessionId, options);
         System.out.println(token);
     }
 }

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

Parámetros: : sessionId - El ID de sesión correspondiente a la sesión a la que se conectará el usuario. : tokenOptions - Este objeto TokenOptions define las opciones del token. Entre ellas se incluyen las siguientes:

- The role of the token (subscriber, publisher, or moderator)
- The expiration time of the token
- Connection data describing the end-user

Devuelve: : La cadena del token.

Lanzamientos: : OpenTokException

generateToken

público  Cadena generateToken(Cadena sessionId) lanza una excepción Excepción de OpenTok

Crea un token para conectarse a una sesión de OpenTok utilizando la configuración predeterminada. La configuración predeterminada es la siguiente:

• Al token se le asigna el rol de editor.
• El token caduca 24 horas después de su creación.
• El token no incluye datos de conexión.

El siguiente ejemplo muestra cómo generar un token con la configuración predeterminada:

 import com.opentok.OpenTok;

 class Test {
     public static void main(String argv[]) throws OpenTokException {
         int API_KEY = 0; // Replace with your OpenTok API key (see https://tokbox.com/account).
         String API_SECRET = ""; // Replace with your OpenTok API secret.
         OpenTok sdk = new OpenTok(API_KEY, API_SECRET);

         //Generate a basic session. Or you could use an existing session ID.
         String sessionId = System.out.println(sdk.createSession().getSessionId());

         String token = sdk.generateToken(sessionId);
         System.out.println(token);
     }
 }

Parámetros: : sessionId - El identificador de sesión correspondiente a la sesión a la que se conectará el usuario.

Devuelve: : La cadena del token.

Lanzamientos: : OpenTokException

Véase también: : - generateToken(String, TokenOptions)

createSession

público  Sesión createSession(Propiedades de la sesión propiedades) lanza Excepción de OpenTok

Crea una nueva sesión de OpenTok.

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 (consulta la generateToken(String, TokenOptions) (método). 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.

Al llamar a este método se obtiene un OpenTokException en caso de que se produzca un error. Consulta el mensaje de error para obtener más detalles.

El siguiente código crea una sesión que intenta enviar flujos directamente entre clientes (recurriendo al servidor TURN de OpenTok para retransmitir los flujos si los clientes no pueden conectarse):

 import com.opentok.MediaMode;
 import com.opentok.OpenTok;
 import com.opentok.Session;
 import com.opentok.SessionProperties;

 class Test {
     public static void main(String argv[]) throws OpenTokException {
         int API_KEY = 0; // Replace with your OpenTok API key.
         String API_SECRET = ""; // Replace with your OpenTok API secret.
         OpenTok sdk = new OpenTok(API_KEY, API_SECRET);

         SessionProperties sp = new SessionProperties().Builder()
           .mediaMode(MediaMode.RELAYED).build();

         Session session = sdk.createSession(sp);
         System.out.println(session.getSessionId());
     }
 }

También puedes crear una sesión utilizando el OpenTok API REST o bien iniciando sesión en tu Cuenta API de Video de Vonage.

Parámetros: : properties - Este objeto `SessionProperties` define las opciones de la sesión. Entre ellas se incluyen las siguientes:

- Whether the session's streams will be transmitted directly between peers or
  using the OpenTok Media Router.
- A location hint for the location of the OpenTok server to use for the session.

Devuelve: : Un objeto `Session` que representa la nueva sesión. Llama a la función getSessionId() método del objeto Session para obtener el ID de sesión, que identifica de forma única la sesión. Utilizarás este ID de sesión en los SDK de cliente para identificar la sesión.

Lanzamientos: : OpenTokException

createSession

público  Sesión createSession() lanza una excepción Excepción de OpenTok

Crea una sesión de OpenTok con la configuración predeterminada:

• El modo multimedia es «por retransmisión». La sesión intentará transmitir los flujos directamente entre los clientes. Si dos clientes no pueden enviar ni recibir los flujos del otro debido a los cortafuegos de sus respectivas redes, sus flujos se retransmitirán a través del servidor TURN de OpenTok.
• La sesión utiliza el primer cliente que se conecta para determinar la ubicación del servidor de OpenTok que se va a utilizar.

En el siguiente ejemplo se crea una sesión que utiliza la configuración predeterminada:

 import com.opentok.OpenTok;
 import com.opentok.SessionProperties;

 class Test {
     public static void main(String argv[]) throws OpenTokException {
         int API_KEY = 0; // Replace with your OpenTok API key.
         String API_SECRET = ""; // Replace with your OpenTok API secret.
         OpenTok sdk = new OpenTok(API_KEY, API_SECRET);

         String sessionId = sdk.createSession();
         System.out.println(sessionId);
     }
 }

Devuelve: : Un objeto `Session` que representa la nueva sesión. Llama a la función getSessionId() método del objeto Session para obtener el ID de sesión, que identifica de forma única la sesión. Utilizarás este ID de sesión en los SDK de cliente para identificar la sesión.

Lanzamientos: : OpenTokException

Véase también: : - createSession(SessionProperties)

señal

public void señal(Cadena sessionId, Propiedades de la señal accesorios) lanza Excepción de OpenTok

Envía una señal a todos los clientes conectados a una sesión.

Para más información, consulte el Guía para desarrolladores de señalización.

Parámetros: : sessionId - El identificador de sesión. : props - El objeto `SignalProperties` que define los datos y el tipo de la señal.

Lanzamientos: : OpenTokException

señal

public void señal(Cadena sessionId, Cadena connectionId, Propiedades de la señal accesorios) lanza Excepción de OpenTok

Envía una señal a un cliente concreto conectado a una sesión.

Para más información, consulte el Guía para desarrolladores de señalización.

Parámetros: : sessionId - El identificador de sesión. : connectionId - El ID de conexión del cliente que va a recibir la señal. : props - El objeto `SignalProperties` que define los datos y el tipo de la señal.

Lanzamientos: : OpenTokException

getArchive

público  Archivo getArchive(Cadena archiveId) lanza una excepción Excepción de OpenTok

Obtiene un Archive objeto correspondiente al ID de archivo indicado.

Parámetros: : archiveId - El identificador del archivo.

Devoluciones: : El Archive objeto.

Lanzamientos: : OpenTokException

lista de archivos

público  Lista de archivos listArchives() lanza una excepción Excepción de OpenTok

Devuelve una lista de Archive objetos, que representan archivos tanto finalizados como en curso, para tu clave API. Esta lista está limitada a 1000 archivos, empezando por el primer archivo registrado. Para obtener un intervalo específico de archivos, llama a listArchives(int offset, int count).

Resultados: : Una lista de Archive objetos.

Lanzamientos: : OpenTokException

lista de archivos

público  Lista de archivos listArchives(Cadena sessionId) lanza una excepción Excepción de OpenTok

Devuelve una lista de Archive objetos, que representan archivos que están tanto finalizados como en curso, para tu clave API.

Parámetros: : sessionId - El identificador de sesión (sessionid) de la sesión que inició o activó automáticamente el archivado. Si la sesión es nula o está vacía, se omitirá.

Resultados: : Una lista de Archive objetos.

Lanzamientos: : OpenTokException

lista de archivos

público  Lista de archivos listArchives(int offset, int count) throws Excepción de OpenTok

Devuelve una lista de Archive objetos, que representan archivos que están tanto finalizados como en curso, para tu clave API.

Parámetros: : offset - El desplazamiento del índice del primer archivo. 0 es el desplazamiento del archivo iniciado más recientemente . 1 es el desplazamiento del archivo que se inició antes que el más reciente. : count - El número de archivos que se van a devolver. El número máximo de archivos que se devuelven es de 1000.

Resultados: : Una lista de Archive objetos.

Lanzamientos: : OpenTokException

lista de archivos

público  Lista de archivos listArchives(Cadena sessionId, int offset, int count) throws Excepción de OpenTok

Devuelve una lista de Archive objetos, que representan archivos que están tanto finalizados como en curso, para tu clave API.

Parámetros: : offset - El desplazamiento del índice del primer archivo. 0 es el desplazamiento del archivo iniciado más recientemente . 1 es el desplazamiento del archivo que se inició antes que el más reciente. : count - El número de archivos que se van a devolver. El número máximo de archivos que se devuelven es de 1000. : sessionId - El identificador de sesión (sessionid) de la sesión que inició o activó automáticamente el archivado.

Resultados: : Una lista de Archive objetos.

Lanzamientos: : OpenTokException

startArchive

público  Archivo startArchive(Cadena sessionId, Propiedades del archivo propiedades) lanza Excepción de OpenTok

Inicia el archivado de una sesión de OpenTok. Esta versión del startArchive() método que te permite desactivar la grabación de audio o vídeo.

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 con el modo multimedia (configurado en «routed»); no se pueden archivar sesiones cuyo modo de transmisión esté configurado en «relayed».

Para obtener más información sobre el archivado, consulta el Archivado de OpenTok guía del desarrollador.

Parámetros: : sessionId - El ID de la sesión de OpenTok que se va a archivar. : properties - Este objeto ArchiveProperties define las opciones del archivo.

Devuelve: : El objeto «Archive». Este objeto incluye propiedades que definen el archivo, entre ellas el identificador del archivo.

Lanzamientos: : OpenTokException

startArchive

público  Archivo startArchive(Cadena sessionId) lanza una excepción Excepción de OpenTok

Lanzamientos: : OpenTokException

startArchive

público  Archivo startArchive(Cadena sessionId, Cadena nombre) lanza Excepción de OpenTok

Lanzamientos: : OpenTokException

stopArchive

público  Archivo stopArchive(Cadena archiveId) lanza una excepción Excepción de OpenTok

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.

Parámetros: : archiveId - El ID del archivo cuya grabación deseas detener.

Devuelve: : El objeto «Archive» correspondiente al archivo que se está deteniendo.

Lanzamientos: : OpenTokException

eliminarArchivo

public void eliminarArchivo(Cadena archiveId) lanza una excepción Excepción de OpenTok

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: : archiveId - El ID del archivo que deseas eliminar.

Lanzamientos: : OpenTokException

addArchiveStream

public void añadirArchivoStream(Cadena archiveId, Cadena streamId, boolean hasAudio, boolean hasVideo) throws Excepción de OpenTok

Añade una transmisión a un archivo de OpenTok.

Este método solo funciona con un archivo que tenga un Archive.StreamMode establecer en StreamMode.MANUAL.

Puedes llamar a este método varias veces con el mismo ID de flujo para activar y desactivar el audio o el vídeo, en función de la hasAudio y hasVideo valores de los parámetros.

Parámetros: : archiveId - El identificador del archivo. : streamId - El identificador de la transmisión. : hasAudio - Si se debe activar el audio de la retransmisión en el archivo. : hasVideo - Si se debe habilitar el vídeo en el archivo de la retransmisión.

Lanzamientos: : OpenTokException

eliminarArchivoStream

public void eliminarArchivoStream(Cadena archiveId, Cadena streamId) lanza una excepción Excepción de OpenTok

Elimina una transmisión de un archivo de Opentok.

Este método solo funciona con un archivo que tenga un Archive.StreamMode establecer en StreamMode.MANUAL.

Parámetros: : archiveId - El identificador del archivo. : streamId - El identificador de la transmisión.

Lanzamientos: : OpenTokException

setArchiveLayout

public void setArchiveLayout(Cadena archiveId, Propiedades del archivo propiedades) lanza Excepción de OpenTok

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: : archiveId - {String} El identificador del archivo. : properties - El objeto ArchiveProperties que define la estructura del archivo.

Lanzamientos: : OpenTokException

startBroadcast

público  Emisión startBroadcast(Cadena sessionId, BroadcastProperties propiedades) lanza Excepción de OpenTok

Inicia una retransmisión en directo de una sesión de OpenTok. Esto retransmite la sesión a flujos HLS (HTTP Live Streaming) o RTMP.

Para poder iniciar correctamente la retransmisión de una sesión, debe haber al menos un cliente conectado a ella.

Solo se puede tener una retransmisión en directo activa a la vez por sesión (aunque tener más de una no sería útil). La retransmisión en directo puede dirigirse a un punto final HLS y a un máximo de cinco servidores RTMP simultáneamente por sesión. Solo se puede iniciar la retransmisión en directo en sesiones que utilicen el OpenTok Media Router (con el modo multimedia configurado en «routed»); no se puede utilizar la retransmisión en directo en sesiones cuyo modo multimedia esté configurado en «relayed OpenTok Media Router». Véase El OpenTok Media Router y los modos multimedia.

Para obtener más información sobre la radiodifusión, consulta el Guía para desarrolladores de retransmisiones.

Parámetros: : sessionId - El ID de la sesión de OpenTok que se va a retransmitir. : properties - El objeto BroadcastProperties define las opciones de la emisión.

Devuelve: : El objeto Broadcast. Este objeto incluye propiedades que definen la emisión, incluido el ID de la emisión.

Lanzamientos: : OpenTokException

stopBroadcast

público  Emisión stopBroadcast(Cadena broadcastId) lanza una excepción Excepción de OpenTok

Detiene una retransmisión en directo de una sesión de OpenTok. Ten en cuenta que las retransmisiones se detienen automáticamente 120 minutos después de su inicio.

Para obtener más información sobre la radiodifusión, consulta el Guía para desarrolladores de retransmisiones.

Parámetros: : broadcastId - El identificador de la sesión de retransmisión

Devuelve: : El objeto Broadcast. Este objeto incluye propiedades que definen el archivo, incluido el ID del archivo.

Lanzamientos: : OpenTokException

getBroadcast

público  Emisión getBroadcast(Cadena broadcastId) lanza una excepción Excepción de OpenTok

Obtiene un Broadcast objeto correspondiente al ID de emisión indicado.

Parámetros: : broadcastId - El identificador de la emisión.

Devoluciones: : El Broadcast objeto.

Lanzamientos: : OpenTokException

setBroadcastLayout

public void setBroadcastLayout(Cadena broadcastId, BroadcastProperties propiedades) lanza Excepción de OpenTok

Establece el tipo de diseño de la emisión. Para obtener una descripción de los tipos de diseño, consulta Configuración del diseño de vídeo para las retransmisiones en directo de OpenTok.

Parámetros: : broadcastId - {String} El identificador de la emisión. : properties - Este objeto `BroadcastProperties` define las opciones de diseño de la emisión.

Lanzamientos: : OpenTokException

addBroadcastStream

public void añadirTransmisiónDeDifusión(Cadena broadcastId, Cadena streamId, boolean hasAudio, boolean hasVideo) throws Excepción de OpenTok

Añade una transmisión a una emisión de Opentok.

Este método solo funciona con un archivo que tenga un Archive.StreamMode establecer en StreamMode.MANUAL.

Puedes llamar a este método varias veces con el mismo ID de flujo para activar y desactivar el audio o el vídeo, en función de la hasAudio y hasVideo valores de los parámetros.

Parámetros: : broadcastId - El identificador de la emisión. : streamId - El identificador de la transmisión. : hasAudio - Si se debe activar el audio en la retransmisión. : hasVideo - Si se debe habilitar el vídeo en la retransmisión.

Lanzamientos: : OpenTokException

eliminarTransmisiónEnDirecto

public void eliminarTransmisiónEnDirecta(Cadena broadcastId, Cadena streamId) lanza una excepción Excepción de OpenTok

Elimina una transmisión de una emisión de Opentok.

Este método solo funciona con un archivo que tenga un Archive.StreamMode establecer en StreamMode.MANUAL.

Parámetros: : broadcastId - El identificador de la emisión. : streamId - El identificador de la transmisión.

Lanzamientos: : OpenTokException

setStreamLayouts

public void setStreamLayouts(Cadena sessionId, StreamListProperties propiedades) lanza Excepción de OpenTok

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 generateToken(String, TokenOptions) método.

Parámetros: : sessionId - {String} El identificador de la sesión a la que pertenecen las transmisiones. : properties - Este objeto `StreamListProperties` define listas de clases para uno o varios flujos de la sesión.

Lanzamientos: : OpenTokException

forceDisconnect

public void forzarDesconexión(Cadena sessionId, Cadena connectionId) lanza un error Excepción de OpenTok

Desconectar a un cliente de una sesión de OpenTok

Utiliza esta API para interrumpir de forma forzada la conexión de una sesión.

Parámetros: : sessionId - El identificador de sesión de la conexión : connectionId - El ID de la conexión que se va a desconectar

Lanzamientos: : OpenTokException

forceMuteStream

public void forzarSilencioEnLaTransmisión(Cadena sessionId, Cadena streamId) lanza una excepción Excepción de OpenTok

Forzar al emisor de una retransmisión concreta a silenciar su audio.

Para obtener más información, consulta Silenciar el audio de los flujos de una sesión.

Parámetros: : sessionId - El identificador de sesión. : streamId - El identificador de la transmisión.

Lanzamientos: : OpenTokException

Véase también: : - forceMuteAll(String, MuteAllProperties)

forceMuteAll

public void forzarSilencioGeneral(Cadena sessionId, Silenciar todas las propiedades propiedades) lanza Excepción de OpenTok

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.

Para obtener más información, consulta Silenciar el audio de los flujos de una sesión.

Parámetros: : sessionId - El identificador de sesión. : properties - Define una lista de identificadores de transmisiones que deben excluirse de la acción de silenciar.

Lanzamientos: : OpenTokException

Véase también: : - forceMuteStream(String, String) - disableForceMute(String)

desactivar el silenciamiento forzado

public void desactivarSilenciamientoForzado(Cadena sessionId) lanza una excepción Excepción de OpenTok

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: : sessionId - El identificador de sesión.

Lanzamientos: : OpenTokException

Véase también: : - forceMuteAll(String, MuteAllProperties)

getStream

público  Transmisión getStream(Cadena sessionId, Cadena streamId) lanza una excepción Excepción de OpenTok

Obtiene un Stream objeto correspondiente al ID de sesión y al ID de flujo indicados.

Parámetros: : sessionId - El identificador de sesión. : streamId - El identificador de la transmisión.

Devoluciones: : El Stream objeto.

Lanzamientos: : OpenTokException

listStreams

público  Lista de reproducción listStreams(Cadena sessionId) lanza una excepción Excepción de OpenTok

Obtiene una lista de Stream objetos correspondientes al ID de sesión indicado.

Parámetros: : sessionId - El identificador de sesión.

Devuelve: : La lista de Stream objetos.

Lanzamientos: : OpenTokException

marcador

público  Un sorbo marcar(Cadena sessionId, Cadena token, SipProperties propiedades) lanza Excepción de OpenTok

Se conecta a una pasarela SIP para establecer una sesión de OpenTok.

Parámetros: : sessionId - El identificador de sesión. : token - Token de OpenTok que se utilizará para el participante al que se llama. Puedes añadir datos al token para identificar si el participante se encuentra en un terminal SIP o para otros datos de identificación, como números de teléfono. (Las bibliotecas de cliente de OpenTok incluyen propiedades para examinar los datos de conexión de un cliente conectado a una sesión.) Consulta el Guía para desarrolladores sobre la creación de tokens. : properties - El SipProperties objeto que define las opciones de la llamada SIP.

Devoluciones: : El Sip objeto.

Lanzamientos: : OpenTokException

reproducir DTMF

public void reproducirDTMF(Cadena sessionId, Cadena (dtmfDigits) lanza una excepción Excepción de OpenTok

Enviar dígitos DTMF a todos los clientes de una sesión.

Parámetros: : sessionId - El identificador de sesión. : dtmfDigits - La secuencia de dígitos DTMF que se va a 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).

Lanzamientos: : OpenTokException

reproducir DTMF

public void reproducirDTMF(Cadena sessionId, Cadena connectionId, Cadena (dtmfDigits) lanza una excepción Excepción de OpenTok

Enviar dígitos DTMF a un cliente concreto durante una sesión.

Parámetros: : sessionId - El identificador de sesión. : connectionId - El identificador de sesión del cliente que va a recibir los dígitos DTMF. : dtmfDigits - La secuencia de dígitos DTMF que se va a 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).

Lanzamientos: : OpenTokException

connectAudioStream

público  AudioConnector connectAudioStream(Cadena sessionId, Cadena token, Propiedades del conector de audio propiedades) lanza Excepción de OpenTok

Envía el audio de una sesión de la Video API de Vonage a un WebSocket. Para obtener más información, consulta la Guía del desarrollador del Conector de audio.

Parámetros: : sessionId - El identificador de sesión. : token - El token de OpenTok que se utilizará para la conexión de Audio Connector a la sesión de OpenTok. Puedes añadir datos al token para identificar que la conexión corresponde al punto final de Audio Connector o para incluir otros datos de identificación. : properties - El objeto ConnectProperties define las opciones que se utilizan en la solicitud dirigida al punto final de la API de Audio Connector.

Devuelve: : El objeto de respuesta de Audio Connect procedente del servidor.

Lanzamientos: : OpenTokException

startRender

público  Render startRender(Cadena sessionId, Cadena token, Propiedades de renderizado propiedades) lanza Excepción de OpenTok

Inicia un renderizado de Experience Composer para una sesión de OpenTok. Para obtener más información, consulta el Guía para desarrolladores de Experience Composer.

Parámetros: : sessionId - El identificador de sesión. : properties - El RenderProperties objeto que define las propiedades de la llamada a Render.

Devoluciones: : El Render objeto de respuesta.

Lanzamientos: : OpenTokException

getRender

público  Render getRender(Cadena renderId) lanza una excepción Excepción de OpenTok

Obtiene un objeto «Render», con información sobre un «Experience Composer».

Parámetros: : renderId - El ID del Experience Composer que se desea recuperar.

Devoluciones: : El Render objeto de respuesta asociado al ID facilitado.

Lanzamientos: : OpenTokException

stopRender

public void stopRender(Cadena renderId) lanza una excepción Excepción de OpenTok

Detiene un Experience Composer de una sesión de OpenTok. Ten en cuenta que, por defecto, los Experience Composers se detienen automáticamente dos horas después de su inicio. También puede establecer un valor diferente para «maxDuration» al crear el Experience Composer. Cuando el Experience Composer finaliza, se envía un evento a la URL de devolución de llamada, si ha configurado una para el proyecto.

Parámetros: : renderId - El ID del Experience Composer que se desea detener.

Lanzamientos: : OpenTokException

listRenders

público  Lista<Render> listRenders() lanza una excepción Excepción de OpenTok

Obtiene una lista de objetos «Render», que representan los «Experience Composers» asociados al proyecto OpenTok.

Devuelve: : La lista de Render objetos.

Lanzamientos: : OpenTokException

listRenders

público  Lista<Render> listRenders(Entero desplazamiento, Entero (recuento) lanza Excepción de OpenTok

Obtiene una lista de objetos «Render», que representan una lista de «Experience Composers» asociados al proyecto de OpenTok.

Parámetros: : offset - (opcional) Desplazamiento inicial en la lista de representaciones existentes. : count - (opcional) Número de representaciones que se van a recuperar a partir del desplazamiento. Máximo: 1000.

Devuelve: : La lista de Render objetos.

Lanzamientos: : OpenTokException

iniciar subtítulos

público  Leyenda startCaptions(Cadena sessionId, Cadena token, Propiedades de los subtítulos propiedades) lanza Excepción de OpenTok

Utiliza la API de Live Captions para transcribir flujos de audio y generar subtítulos en tiempo real para tu aplicación. Live Captions está habilitado de forma predeterminada para todos los proyectos y es un producto de pago por uso. La función Live Captions solo es compatible con sesiones enrutadas (sesiones que utilizan el OpenTok Media Router). Puedes enviar hasta 50 flujos de audio de una misma sesión de Vonage a la vez al servicio de transcripción para la generación de subtítulos.

Parámetros: : sessionId - El identificador de la sesión de OpenTok. El audio de los emisores que transmiten a esta sesión se utilizará para generar los subtítulos. : token - Un token válido de OpenTok con el rol establecido como «Moderador». : properties - El CaptionProperties objeto que define las propiedades opcionales de los subtítulos en directo.

Devoluciones: : A Caption respuesta que contiene el ID de los subtítulos de esta llamada.

Lanzamientos: : OpenTokException

stopCaptions

public void detenerSubtítulos(Cadena captionsId) lanza Excepción de OpenTok

Utiliza este método para desactivar los subtítulos en directo de una sesión.

Parámetros: : captionsId - El identificador único de la sesión de subtitulado de audio, tal y como se obtiene de Caption.getCaptionsId().

Lanzamientos: : OpenTokException

cerrar

public void close()

Llama a este método cuando hayas terminado de utilizar el objeto OpenTok, para evitar fugas de descriptores de archivos.