Contiene métodos para crear sesiones de la Video API de Vonage, generar tokens y trabajar con archivos. Más...

Descripción detallada

Contiene métodos para crear sesiones de la Video API de Vonage, generar tokens y trabajar con archivos.

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

Documentación sobre constructores y destructores

OpenTok() [1/2]

Crea un OpenTok objeto.

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

OpenTok() [2/2]

Para uso interno de TokBox.

Parámetros : | | | | --- | --- | | apiKey | | | apiSecret | | | apiUrl | |

Documentación sobre funciones de miembro

AddStreamToArchive()

Añade un flujo a un archivo compuesto que se está ejecutando actualmente y que se inició con el comando streamMode ajustado a StreamMode.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 : | | | | --- | --- | | archiveId | El ID del archivo. | | streamId | El ID de la transmisión. | | hasAudio | Indica si el archivo resultante debe incluir el audio de la transmisión (true, valor por defecto) o no (false). | | hasVideo | Indica si el archivo compuesto debe incluir el vídeo de la transmisión (verdadero, valor por defecto) o no (falso). |

AddStreamToArchiveAsync()

Añade un flujo a un archivo compuesto que se está ejecutando actualmente y que se inició con el comando streamMode ajustado a StreamMode.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 : | | | | --- | --- | | archiveId | El ID del archivo. | | streamId | El ID de la transmisión. | | hasAudio | Indica si el archivo resultante debe incluir el audio de la transmisión (true, valor por defecto) o no (false). | | hasVideo | Indica si el archivo compuesto debe incluir el vídeo de la transmisión (verdadero, valor por defecto) o no (falso). |

AddStreamToBroadcast()

Añade una transmisión a una emisión que se está realizando actualmente y que se inició con el comando streamMode ajustado a StreamMode.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.

Parámetros : | | | | --- | --- | | broadcastId | El identificador de la emisión. | | streamId | El identificador de la transmisión. | | hasAudio | Indica si la emisión debe incluir el audio de la transmisión (true, valor predeterminado) o no (false). | | hasVideo | Indica si la emisión debe incluir el vídeo de la transmisión (verdadero, valor predeterminado) o no (falso). |

Excepciones : | | | | --- | --- | | OpenTokArgumentException | |

AddStreamToBroadcastAsync()

Añade una transmisión a una emisión que se está realizando actualmente y que se inició con el comando streamMode ajustado a StreamMode.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.

Parámetros : | | | | --- | --- | | broadcastId | El identificador de la emisión. | | streamId | El identificador de la transmisión. | | hasAudio | Indica si la emisión debe incluir el audio de la transmisión (true, valor predeterminado) o no (false). | | hasVideo | Indica si la emisión debe incluir el vídeo de la transmisión (verdadero, valor predeterminado) o no (falso). |

Excepciones : | | | | --- | --- | | OpenTokArgumentException | |

CreateSession()

Crea una nueva sesión de la Video API de Vonage.

Las sesiones de la Video API de Vonage no caducan. Sin embargo, los tokens de autenticación sí caducan (véase el método generateToken()). Ten en cuenta también que las sesiones no se pueden cerrar de forma explícita.

Una cadena de identificación de sesión puede tener una longitud máxima de 255 caracteres.

Si se produce un error al llamar a este método, se generará una excepción OpenTokException. Consulta el mensaje de error para obtener más detalles.

También puedes crear una sesión utilizando el API REST de OpenTok o iniciando sesión en tu Account de TokBox.

Parámetros : | | | | --- | --- | | location | Una dirección IP que los servidores de la Video API de Vonage utilizarán para ubicar la sesión en su red global. Si no se especifica una indicación de ubicación, los servidores de la Video API de Vonage se basarán en el primer cliente que se conecte a la sesión. | | mediaMode | Indica si la sesión transmitirá flujos utilizando el enrutador multimedia de la Video API de Vonage (MediaMode.ROUTED) o no (MediaMode.RELAYED). Por defecto, la configuración es MediaMode.RELAYED. Con el parámetro establecido en MediaMode.RELAYED, la sesión intentará transmitir flujos directamente entre los clientes. Si los clientes no pueden conectarse debido a restricciones del cortafuegos, la sesión utiliza el OpenTok Configurar el servidor TURN para retransmitir flujos. El OpenTok Media Router ofrece las siguientes ventajas: - El enrutador multimedia de la Video API de Vonage puede reducir el consumo de ancho de banda en sesiones con varios participantes. (Cuando el mediaMode se establece en MediaMode.ROUTED, cada cliente debe enviar un flujo de audio y vídeo independiente a cada cliente suscrito al mismo.) - El enrutador multimedia de la Video API de Vonage puede mejorar la calidad de la experiencia del usuario a través de recuperación de audio y vídeo Con estas características, si la conexión de un cliente se deteriora hasta tal punto que no permite la reproducción de 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 se restablece. - El enrutador multimedia de la Video API de Vonage es compatible con el archivo Función que te permite grabar, guardar y recuperar sesiones de la Video API de Vonage. | | archiveMode | Indica si la sesión se archiva automáticamente (ArchiveMode.SIEMPRE) o no (ArchiveMode.MANUAL). Por defecto, la configuración es ArchiveMode.MANUAL y tienes que llamar al InicioArchivo método del OpenTok objeto para iniciar el archivado. Para archivar la sesión (ya sea de forma automática o no), debes establecer el parámetro «mediaMode» en MediaMode.ROUTED | | cifrado | Habilita cifrado de extremo a extremo de los datos multimedia en sesiones enrutadas. | | archiveName | Nombre de los archivos en sesiones archivadas automáticamente. Una sesión que comience con el modo de archivo «always» utilizará este nombre de archivo para todos los archivos de dicha sesión. Si se pasa «archiveName» con el modo de archivo «manual», se producirá una respuesta de error. | | archiveResolution | Resolución de los archivos en sesiones archivadas automáticamente. Una sesión que comience con el modo de archivo «always» utilizará esta resolución para todos los archivos de dicha sesión. Si se pasa «archiveResolution» con el modo de archivo «manual», se producirá una respuesta de error. |

Devoluciones : A Sesión objeto que representa la nueva sesión. El Session.Id propiedad del Sesión es 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. Por ejemplo, al utilizar la biblioteca OpenTok.js, utiliza el ID de sesión al llamar a la función OT.initSession() método (para inicializar una sesión de la Video API de Vonage).

CreateSessionAsync()

Crea una nueva sesión de la Video API de Vonage.

Las sesiones de la Video API de Vonage no caducan. Sin embargo, los tokens de autenticación sí caducan (véase el método generateToken()). Ten en cuenta también que las sesiones no se pueden cerrar de forma explícita.

Una cadena de identificación de sesión puede tener una longitud máxima de 255 caracteres.

Si se produce un error al llamar a este método, se generará una excepción OpenTokException. Consulta el mensaje de error para obtener más detalles.

También puedes crear una sesión utilizando el API REST de OpenTok o iniciando sesión en tu Account de TokBox.

Parámetros : | | | | --- | --- | | location | Una dirección IP que los servidores de la Video API de Vonage utilizarán para ubicar la sesión en su red global. Si no se especifica una indicación de ubicación, los servidores de la Video API de Vonage se basarán en el primer cliente que se conecte a la sesión. | | mediaMode | Indica si la sesión transmitirá flujos utilizando el enrutador multimedia de la Video API de Vonage (MediaMode.ROUTED) o no (MediaMode.RELAYED). Por defecto, la configuración es MediaMode.RELAYED. Con el parámetro establecido en MediaMode.RELAYED, la sesión intentará transmitir flujos directamente entre los clientes. Si los clientes no pueden conectarse debido a restricciones del cortafuegos, la sesión utiliza el OpenTok Configurar el servidor TURN para retransmitir flujos. El OpenTok Media Router ofrece las siguientes ventajas: - El enrutador multimedia de la Video API de Vonage puede reducir el consumo de ancho de banda en sesiones con varios participantes. (Cuando el mediaMode se establece en MediaMode.ROUTED, cada cliente debe enviar un flujo de audio y vídeo independiente a cada cliente suscrito al mismo.) - El enrutador multimedia de la Video API de Vonage puede mejorar la calidad de la experiencia del usuario a través de recuperación de audio y vídeo Con estas características, si la conexión de un cliente se deteriora hasta tal punto que no permite la reproducción de 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 se restablece. - El enrutador multimedia de la Video API de Vonage es compatible con el archivo Función que te permite grabar, guardar y recuperar sesiones de la Video API de Vonage. | | archiveMode | Indica si la sesión se archiva automáticamente (ArchiveMode.SIEMPRE) o no (ArchiveMode.MANUAL). Por defecto, la configuración es ArchiveMode.MANUAL y tienes que llamar al InicioArchivo método del OpenTok objeto para iniciar el archivado. Para archivar la sesión (ya sea de forma automática o no), debes establecer el parámetro «mediaMode» en MediaMode.ROUTED | | cifrado | Habilita cifrado de extremo a extremo de los datos multimedia en sesiones enrutadas. | | archiveName | Nombre de los archivos en sesiones archivadas automáticamente. Una sesión que comience con el modo de archivo «always» utilizará este nombre de archivo para todos los archivos de dicha sesión. Si se pasa «archiveName» con el modo de archivo «manual», se producirá una respuesta de error. | | archiveResolution | Resolución de los archivos en sesiones archivadas automáticamente. Una sesión que comience con el modo de archivo «always» utilizará esta resolución para todos los archivos de dicha sesión. Si se pasa «archiveResolution» con el modo de archivo «manual», se producirá una respuesta de error. |

Devoluciones : A Sesión objeto que representa la nueva sesión. El Session.Id propiedad del Sesión es 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. Por ejemplo, al utilizar la biblioteca OpenTok.js, utiliza el ID de sesión al llamar a la función OT.initSession() método (para inicializar una sesión de la Video API de Vonage).

DeleteArchive()

Elimina un OpenTok archivo.

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

Parámetros : | | | | --- | --- | | archiveId | El ID del archivo que deseas eliminar. |

DeleteArchiveAsync()

Elimina un OpenTok archivo.

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

Parámetros : | | | | --- | --- | | archiveId | El ID del archivo que deseas eliminar. |

Dial()

Conecta una plataforma SIP a una sesión de la Video API de Vonage.

Para obtener más información, incluidos detalles técnicos y consideraciones de seguridad, consulta el Guía para desarrolladores de interconexión SIP de OpenTok.

Parámetros : | | | | --- | --- | | sessionId | El ID de sesión correspondiente a la sesión a la que se conectará el usuario. | | token | El token del ID de sesión que utilizará el usuario SIP para conectarse. | | sipUri | El URI SIP que se utilizará como destino de la llamada SIP iniciada desde OpenTok a tu plataforma SIP. Si el URI SIP contiene un encabezado ​transport=tls​, la negociación entre OpenTok y la conexión con el punto final SIP se realizará de forma segura. Ten en cuenta que esto solo se aplicará a la propia negociación, y no a la transmisión de audio. Si también deseas que la transmisión de audio esté cifrada, configura el Secure propiedad de la de la Opciones de marcación objeto pasado al parámetro «options» de ​true​. Este es un ejemplo de configuración sipUri para una negociación de llamada segura: "sip:user@sip.partner.com;transport=tls". Este es un ejemplo de negociación de llamada no segura: "sip:user@sip.partner.com". | | opciones | Parámetros opcionales para la marcación SIP. |

DialAsync()

Conecta una plataforma SIP a una sesión de la Video API de Vonage.

Para obtener más información, incluidos detalles técnicos y consideraciones de seguridad, consulta el Guía para desarrolladores de interconexión SIP de OpenTok.

Véase también OpenTok.Dial.

Parámetros : | | | | --- | --- | | sessionId | El ID de sesión correspondiente a la sesión a la que se conectará el usuario. | | token | El token del ID de sesión que utilizará el usuario SIP para conectarse. | | sipUri | El URI SIP que se utilizará como destino de la llamada SIP iniciada desde OpenTok a tu plataforma SIP. Si el URI SIP contiene un encabezado ​transport=tls​, la negociación entre OpenTok y la conexión con el punto final SIP se realizará de forma segura. Ten en cuenta que esto solo se aplicará a la propia negociación, y no a la transmisión de audio. Si también deseas que la transmisión de audio esté cifrada, configura el Secure propiedad de la de la Opciones de marcación objeto pasado al parámetro «options» de ​true​. Este es un ejemplo de configuración sipUri para una negociación de llamada segura: "sip:user@sip.partner.com;transport=tls". Este es un ejemplo de negociación de llamada no segura: "sip:user@sip.partner.com". | | opciones | Parámetros opcionales para la marcación SIP. |

DisableForceMute()

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 Silenciar todo método, cualquier transmisión publicada tras la llamada se publicará con el audio silenciado. Llama al DisableForceMute() Método para desactivar el estado de silencio de una sesión, de modo que las nuevas transmisiones publicadas no se silencien automáticamente.

Consulta también el Desactivar el silenciamiento forzado asíncrono método.

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

Excepciones : | | | | --- | --- | | OpenTokArgumentException | Se lanza cuando el ID de sesión no es válido. | | OpenTokWebException | Se lanza cuando se ha producido un error HTTP. |

DisableForceMuteAsync()

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 ForceMuteAllAsync método, cualquier transmisión publicada tras la llamada se publicará con el audio silenciado. Llama al DisableForceMuteAsync() Método para desactivar el estado de silencio de una sesión, de modo que las nuevas transmisiones publicadas no se silencien automáticamente.

Consulta también el Desactivar el silenciamiento forzado método.

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

Excepciones : | | | | --- | --- | | OpenTokArgumentException | Se lanza cuando el ID de sesión no es válido. | | OpenTokWebException | Se lanza cuando se ha producido un error HTTP. |

ForceDisconnect()

Forzar a un cliente concreto a desconectarse de una sesión de la Video API de Vonage.

Parámetros : | | | | --- | --- | | sessionId | El ID de sesión correspondiente a la sesión. | | connectionId | El ID de conexión de la conexión dentro de una sesión. |

ForceDisconnectAsync()

Forzar a un cliente concreto a desconectarse de una sesión de la Video API de Vonage.

Parámetros : | | | | --- | --- | | sessionId | El ID de sesión correspondiente a la sesión. | | connectionId | El ID de conexión de la conexión dentro de una sesión. |

ForceMuteAll()

Obliga a todas las transmisiones (excepto a una lista 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 Desactivar el silenciamiento forzado método.

Consulta también el ForceMuteAllAsync y ForceMuteStream métodos.

Parámetros : | | | | --- | --- | | sessionId | El ID de la sesión. | | excludedStreamIds | Los ID de las transmisiones que no se silenciarán. |

Excepciones : | | | | --- | --- | | OpenTokArgumentException | Se lanza cuando el ID de sesión no es válido. | | OpenTokWebException | Se lanza cuando se ha producido un error HTTP. |

ForceMuteAllAsync()

Obliga a todas las transmisiones (excepto a una lista 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 Desactivar el silenciamiento forzado asíncrono método.

Consulta también el Silenciar todo y ForceMuteStreamAsync métodos.

Parámetros : | | | | --- | --- | | sessionId | El ID de la sesión. | | excludedStreamIds | Los ID de las transmisiones que no se silenciarán. |

Excepciones : | | | | --- | --- | | OpenTokArgumentException | Se lanza cuando el ID de sesión no es válido. | | OpenTokWebException | Se lanza cuando se ha producido un error HTTP. |

ForceMuteStream()

Obligar al emisor de una retransmisión concreta a silenciar el audio que está emitiendo.

Consulta también el Silenciar todo y ForceMuteStreamAsync métodos.

Parámetros : | | | | --- | --- | | sessionId | El ID de la sesión que incluye la transmisión. | | streamId | El ID de la transmisión. |

Excepciones : | | | | --- | --- | | OpenTokArgumentException | Se lanza cuando el ID de sesión o de flujo no es válido. | | OpenTokWebException | Se lanza cuando se ha producido un error HTTP. |

ForceMuteStreamAsync()

Obligar al emisor de una retransmisión concreta a silenciar el audio que está emitiendo.

Consulta también el Silenciar todo y ForceMuteStream métodos.

Parámetros : | | | | --- | --- | | sessionId | El ID de la sesión que incluye la transmisión. | | streamId | El ID de la transmisión. |

Excepciones : | | | | --- | --- | | OpenTokArgumentException | Se lanza cuando el ID de sesión o de flujo no es válido. | | OpenTokWebException | Se lanza cuando se ha producido un error HTTP. |

GenerateToken()

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

Para realizar pruebas, también puedes generar tokens de prueba iniciando sesión en tu Account de TokBox.

Parámetros : | | | | --- | --- | | sessionId | El ID de sesión correspondiente a la sesión a la que se conectará el usuario. | | role | El rol del token. Los valores válidos se definen en la enumeración «Role»: - Rol.SUBSCRIBER (Un suscriptor solo puede suscribirse a transmisiones) - Rol.PUBLISHER (Un editor puede publicar flujos, suscribirse a flujos y enviar señales. (Este es el valor predeterminado si no se especifica ningún rol.)) - Función: MODERADOR (Además de los privilegios concedidos a un editor, un moderador puede realizar funciones de moderación, como obligar a los clientes a desconectarse, detener la publicación de transmisiones o silenciar el audio en las transmisiones publicadas. Consulta la Guía para desarrolladores sobre moderación. | | expireTime | El tiempo de caducidad del token, en segundos desde la época UNIX. Introduce 0 para utilizar el tiempo de caducidad predeterminado de 24 horas tras la hora de creación del token. El tiempo máximo de caducidad es de 30 días tras la hora de creación. | | data | Una cadena que contiene metadatos de conexión que describen al usuario final. Por ejemplo, puede 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 | Una lista de valores de cadena que contiene la disposición inicial del flujo. |

Devuelve

GetArchive()

Obtiene un Archivo objeto correspondiente al ID de archivo indicado.

Parámetros : | | | | --- | --- | | archiveId | El ID del archivo. |

Devoluciones : El Archivo objeto.

GetArchiveAsync()

Obtiene un Archivo objeto correspondiente al ID de archivo indicado.

Parámetros : | | | | --- | --- | | archiveId | El ID del archivo. |

Devoluciones : El Archivo objeto.

GetBroadcast()

Utiliza este método para obtener un objeto de retransmisión en directo de una sesión de la Video API de Vonage.

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 |

Devoluciones : El Emisión objeto. Este objeto incluye propiedades que definen la emisión, incluido el identificador de la emisión.

GetBroadcastAsync()

Utiliza este método para obtener un objeto de retransmisión en directo de una sesión de la Video API de Vonage.

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 |

Devoluciones : El Emisión objeto. Este objeto incluye propiedades que definen la emisión, incluido el identificador de la emisión.

GetRenderAsync()

Recupera un renderizador de Experience Composer.

Parámetros : | | | | --- | --- | | renderId | El identificador de la representación. |

GetStream()

Obtiene un Transmisión objeto correspondiente al ID de flujo indicado.

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

Devoluciones : El Transmisión objeto.

GetStreamAsync()

Obtiene un Transmisión objeto correspondiente al ID de flujo indicado.

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

Devoluciones : El Transmisión objeto.

ListArchives()

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

Parámetros : | | | | --- | --- | | offset | El desplazamiento en el í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 1000. | | sessionId | El ID de sesión. |

Devoluciones : Una lista de Archivo objetos.

ListArchivesAsync()

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

Parámetros : | | | | --- | --- | | offset | El desplazamiento en el í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 1000. | | sessionId | El ID de sesión. |

Devoluciones : Una lista de Archivo objetos.

ListRendersAsync()

Recupera todos los renderizadores de Experience Composer que coincidan con la solicitud proporcionada.

Parámetros : | | | | --- | --- | | solicitud | La solicitud que contiene las opciones de filtrado. |

Devuelve : La lista de representaciones.

ListStreams()

Devuelve una lista de Transmisión objetos, que representan transmisiones en curso, para el ID de sesión.

Parámetros : | | | | --- | --- | | sessionId | El ID de sesión correspondiente a la sesión. |

Devoluciones : Una lista de Transmisión objetos.

Excepciones : | | | | --- | --- | | OpenTokArgumentException | |

ListStreamsAsync()

Devuelve una lista de Transmisión objetos, que representan transmisiones en curso, para el ID de sesión.

Parámetros : | | | | --- | --- | | sessionId | El ID de sesión correspondiente a la sesión. |

Devoluciones : Una lista de Transmisión objetos.

Excepciones : | | | | --- | --- | | OpenTokArgumentException | |

ReproducirDTMF()

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

Parámetros : | | | | --- | --- | | sessionId | El ID de sesión correspondiente a la sesión que recibirá la cadena 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 | Es la cadena de dígitos DTMF que se va a enviar. Puede incluir los dígitos del 0 al 9, «*», «#» y «p». La «p» indica una pausa de 500 ms (si necesitas añadir un retraso en el envío de los dígitos). |

ReproducirDTMFAsync()

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

Parámetros : | | | | --- | --- | | sessionId | El ID de sesión correspondiente a la sesión que recibirá la cadena 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 | Es la cadena de dígitos DTMF que se va a enviar. Puede incluir los dígitos del 0 al 9, «*», «#» y «p». La «p» indica una pausa de 500 ms (si necesitas añadir un retraso en el envío de los dígitos). |

RemoveStreamFromArchive()

Elimina un flujo de un archivo compuesto que se inició con el comando streamMode ajustado a StreamMode.Manual.

Parámetros : | | | | --- | --- | | archiveId | El ID del archivo. | | streamId | El ID de la secuencia. |

RemoveStreamFromArchiveAsync()

Elimina un flujo de un archivo compuesto que se inició con el comando streamMode ajustado a StreamMode.Manual.

Parámetros : | | | | --- | --- | | archiveId | El ID del archivo. | | streamId | El ID de la secuencia. |

RemoveStreamFromBroadcast()

Elimina una transmisión de una emisión que se inició con el streamMode ajustado a StreamMode.Manual.

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

Excepciones : | | | | --- | --- | | OpenTokArgumentException | |

RemoveStreamFromBroadcastAsync()

Elimina una transmisión de una emisión que se inició con el streamMode ajustado a StreamMode.Manual.

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

Excepciones : | | | | --- | --- | | OpenTokArgumentException | |

SetArchiveLayout()

Te permite modificar dinámicamente la estructura de un archivo compuesto mientras se está grabando. Véase Personalización del diseño de vídeo para los archivos compuestos Para obtener más información sobre cómo personalizar un diseño.

Parámetros : | | | | --- | --- | | archiveId | | | layout | |

Devuelve

SetArchiveLayoutAsync()

Te permite modificar dinámicamente la estructura de un archivo compuesto mientras se está grabando. Véase Personalización del diseño de vídeo para los archivos compuestos Para obtener más información sobre cómo personalizar un diseño.

Parámetros : | | | | --- | --- | | archiveId | | | layout | |

Devuelve

SetBroadcastLayout()

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 | El identificador de la sesión de retransmisión. | | layout | El BroadcastLayout que define las opciones de maquetación de la emisión. |

SetBroadcastLayoutAsync()

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 | El identificador de la sesión de retransmisión. | | layout | El BroadcastLayout que define las opciones de maquetación de la emisión. |

SetCustomUserAgent()

Establece un valor personalizado para el agente de usuario. HttpClient añadirá este valor, si existe, al valor inicial del agente de usuario.

Parámetros : | | | | --- | --- | | valor | El valor personalizado del agente de usuario. |

SetDefaultRequestTimeout()

Establece el tiempo de espera predeterminado de la solicitud (en milisegundos) para todas las solicitudes WebRequest enviadas por el SDK.

Parámetros : | | | | --- | --- | | tiempo de espera | |

SetStreamClassLists()

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 los archivos compuestos y las 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 dicho cliente. Consulta la GenerarToken método.

Parámetros : | | | | --- | --- | | sessionId | El sessionId | | streams | Una lista de StreamsProperties que define las listas de clases para una o más secuencias de la sesión. |

SetStreamClassListsAsync()

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 los archivos compuestos y las 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 dicho cliente. Consulta la GenerarToken método.

Parámetros : | | | | --- | --- | | sessionId | El sessionId | | streams | Una lista de StreamsProperties que define las listas de clases para una o más secuencias de la sesión. |

Signal()

Envía una señal a los clientes (o a un cliente concreto) conectados a una sesión de la Video API de Vonage.

Parámetros : | | | | --- | --- | | sessionId | El «sessionId» de la Video API de Vonage al que se enviará la señal. | | signalProperties | Este «signalProperties» define la carga útil de la señal. | | connectionId | Un parámetro opcional que se utiliza para enviar la señal a una conexión específica dentro de una sesión. |

SignalAsync()

Envía una señal a los clientes (o a un cliente concreto) conectados a una sesión de la Video API de Vonage.

Parámetros : | | | | --- | --- | | sessionId | El «sessionId» de la Video API de Vonage al que se enviará la señal. | | signalProperties | Este «signalProperties» define la carga útil de la señal. | | connectionId | Un parámetro opcional que se utiliza para enviar la señal a una conexión específica dentro de una sesión. |

StartArchive()

Inicia el archivado de una sesión de la Video API de Vonage.

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

Solo se puede grabar un archivo a la vez para una sesión determinada. Solo se pueden grabar archivos de sesiones que utilicen el enrutador de medios de la Video API de Vonage (sesiones con el modo multimedia configurado en «enrutado»); no se pueden archivar sesiones con el modo multimedia configurado en «retransmitido».

Ten en cuenta que puedes hacer que la sesión se archive automáticamente configurando el parámetro «archiveMode» del CreateSession método para ArchiveMode.SIEMPRE.

Parámetros : | | | | --- | --- | | sessionId | El ID de la sesión de la Video API de Vonage que se va a archivar. | | name | El nombre del archivo. Puede utilizar este nombre para identificar el archivo. Es una propiedad de la Archivo objeto, y es una propiedad de los eventos relacionados con el archivo en el OpenTok bibliotecas de cliente. | | hasVideo | Indica si el archivo grabará vídeo (true) o no (false). El valor por defecto es true (se graba vídeo). Si se configuran ambos hasAudio y hasVideo a «false», la llamada a la InicioArchivo El método da lugar a un error. | | hasAudio | Indica si el archivo grabará audio (true) o no (false). El valor por defecto es true (se graba audio). Si se establecen ambos hasAudio y hasVideo a «false», la llamada a la InicioArchivo El método da lugar a un error. | | outputMode | Indica si todas las secuencias del archivo se graban en un único archivo (OutputMode.COMPOSED, el valor por defecto) o a archivos concretos (OutputMode.INDIVIDUAL). | | resolución | La resolución del archivo. El valor por defecto para OutputMode.COMPOSED es «640x480». No se puede especificar la resolución para OutputMode.INDIVIDUAL. | | diseño | El diseño que deseas utilizar para tu archivo. Si el tipo está establecido en LayoutType.custom Debes proporcionar a Vonage una cadena de código de la hoja de estilo que indique cómo debe organizarse tu archivo. | | streamMode | Indica si las transmisiones incluidas en el archivo se seleccionan automáticamente (StreamMode.Auto, que es el valor predeterminado) o manualmente (StreamMode.Manual). Con StreamMode.Manual, deberás especificar las secuencias que se incluirán en el archivo utilizando el OpenTok.AddStreamToArchive y OpenTok.RemoveStreamFromArchive métodos (o el OpenTok.AddStreamToArchiveAsync y OpenTok.RemoveStreamFromArchiveAsync métodos). | | multiArchiveTag | Configúralo para permitir la grabación simultánea de varios archivos de la misma sesión. Asigna una cadena única a cada archivo simultáneo de una sesión en curso. También debe configurar esta opción cuando inicie manualmente un archivo en una sesión que se archiva automáticamente. Si no especifica un multiArchiveTag único, solo podrá grabar un archivo a la vez para una sesión determinada. Véase Archivos simultáneos. |

Devoluciones : El Archivo objeto. Este objeto incluye propiedades que definen el archivo, entre ellas el identificador del archivo.

StartArchiveAsync()

Inicia el archivado de una sesión de la Video API de Vonage.

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

Solo se puede grabar un archivo a la vez para una sesión determinada. Solo se pueden grabar archivos de sesiones que utilicen el enrutador de medios de la Video API de Vonage (sesiones con el modo multimedia configurado en «enrutado»); no se pueden archivar sesiones con el modo multimedia configurado en «retransmitido».

Ten en cuenta que puedes hacer que la sesión se archive automáticamente configurando el parámetro «archiveMode» del CreateSession método para ArchiveMode.SIEMPRE.

Parámetros : | | | | --- | --- | | sessionId | El ID de la sesión de la Video API de Vonage que se va a archivar. | | name | El nombre del archivo. Puede utilizar este nombre para identificar el archivo. Es una propiedad de la Archivo objeto, y es una propiedad de los eventos relacionados con el archivo en el OpenTok bibliotecas de cliente. | | hasVideo | Indica si el archivo grabará vídeo (true) o no (false). El valor por defecto es true (se graba vídeo). Si se configuran ambos hasAudio y hasVideo a «false», la llamada a la InicioArchivo El método da lugar a un error. | | hasAudio | Indica si el archivo grabará audio (true) o no (false). El valor por defecto es true (se graba audio). Si se establecen ambos hasAudio y hasVideo a «false», la llamada a la InicioArchivo El método da lugar a un error. | | outputMode | Indica si todas las secuencias del archivo se graban en un único archivo (OutputMode.COMPOSED, el valor por defecto) o a archivos concretos (OutputMode.INDIVIDUAL). | | resolución | La resolución del archivo. El valor por defecto para OutputMode.COMPOSED es «640x480». No se puede especificar la resolución para OutputMode.INDIVIDUAL. | | diseño | El diseño que deseas utilizar para tu archivo. Si el tipo está establecido en LayoutType.custom Debes proporcionar a Vonage una cadena de código de la hoja de estilo que indique cómo debe organizarse tu archivo. | | streamMode | Indica si las transmisiones incluidas en el archivo se seleccionan automáticamente (StreamMode.Auto, que es el valor predeterminado) o manualmente (StreamMode.Manual). Con StreamMode.Manual, deberás especificar las secuencias que se incluirán en el archivo utilizando el OpenTok.AddStreamToArchive y OpenTok.RemoveStreamFromArchive métodos (o el OpenTok.AddStreamToArchiveAsync y OpenTok.RemoveStreamFromArchiveAsync métodos). | | multiArchiveTag | Configúralo para permitir la grabación simultánea de varios archivos de la misma sesión. Asigna una cadena única a cada archivo simultáneo de una sesión en curso. También debe configurar esta opción cuando inicie manualmente un archivo en una sesión que se archiva automáticamente. Si no especifica un multiArchiveTag único, solo podrá grabar un archivo a la vez para una sesión determinada. Véase Archivos simultáneos. |

Devoluciones : El Archivo objeto. Este objeto incluye propiedades que definen el archivo, entre ellas el identificador del archivo.

StartAudioConnectorAsync()

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

Parámetros : | | | | --- | --- | | solicitud | La solicitud para iniciar el conector de audio. |

Resultados : El objeto de respuesta del servidor.

StartBroadcast()

Utiliza este método para iniciar una retransmisión en directo de una sesión de la Video API de Vonage. De este modo, la sesión se retransmite 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 para sesiones que utilicen el enrutador multimedia de la Video API de Vonage (con el modo multimedia configurado en «enrutado»); no se puede utilizar la retransmisión en directo con sesiones cuyo modo multimedia esté configurado en «retransmitido» por el enrutador multimedia de la Video API de Vonage. 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 sesión correspondiente a la sesión. | | hls | Si se debe incluir una emisión HLS. | | rtmpList | Una lista de RTMP objetos, que definen las transmisiones RTMP que se van a emitir (hasta cinco). | | resolución | La resolución del vídeo que se va a emitir. Las resoluciones válidas son «640x480», «1280x720», «1920x1080», «480x640», «720x1280» y «1080x1920». | | maxDuration | 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 2 horas (7 200 segundos). | | layout | Especifica esto BroadcastLayout objeto para asignar el tipo de disposición inicial de la emisión. | | streamMode | Indica si las transmisiones incluidas en la emisión se seleccionan automáticamente (StreamMode.Auto, que es el valor predeterminado) o manualmente (StreamMode.Manual). Con StreamMode.Manual, deberás especificar las transmisiones que se incluirán en la emisión utilizando el OpenTok.AddStreamToBroadcast y OpenTok.RemoveStreamFromBroadcast métodos (o el OpenTok.AddStreamToBroadcastAsync y OpenTok.RemoveStreamFromBroadcastAsync métodos). | | dvr | Indica si se debe habilitar la funcionalidad de DVR —rebobinar, pausar y reanudar— en los reproductores que la admiten (true), o no (false, valor por defecto). Si se habilita el DVR, la URL de HLS incluirá una cadena de consulta «?DVR» añadida al final. Véase Funcionalidad de grabación digital (DVR) | | lowLatency | Indica si se debe activar el 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. Véase Emisiones HLS de baja latencia | | multiBroadcastTag | Configura este parámetro 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. Consulta Emisiones simultáneas. | | hasAudio | Indica si la retransmisión tiene audio (el valor por defecto es «true»). | | hasVideo | Indica si la retransmisión tiene vídeo (el valor por defecto es «true»). |

Devoluciones : El Emisión objeto. Este objeto incluye propiedades que definen el archivo, entre ellas el identificador del archivo.

StartBroadcastAsync()

Utiliza este método para iniciar una retransmisión en directo de una sesión de la Video API de Vonage. De este modo, la sesión se retransmite 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 para sesiones que utilicen el enrutador multimedia de la Video API de Vonage (con el modo multimedia configurado en «enrutado»); no se puede utilizar la retransmisión en directo con sesiones cuyo modo multimedia esté configurado en «retransmitido» por el enrutador multimedia de la Video API de Vonage. 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 sesión correspondiente a la sesión. | | hls | Si se debe incluir una emisión HLS. | | rtmpList | Una lista de RTMP objetos, que definen las transmisiones RTMP que se van a emitir (hasta cinco). | | resolución | La resolución del vídeo que se va a emitir. Las resoluciones válidas son «640x480», «1280x720», «1920x1080», «480x640», «720x1280» y «1080x1920». | | maxDuration | 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 2 horas (7 200 segundos). | | layout | Especifica esto BroadcastLayout objeto para asignar el tipo de disposición inicial de la emisión. | | streamMode | Indica si las transmisiones incluidas en la emisión se seleccionan automáticamente (StreamMode.Auto, que es el valor predeterminado) o manualmente (StreamMode.Manual). Con StreamMode.Manual, deberás especificar las transmisiones que se incluirán en la emisión utilizando el OpenTok.AddStreamToBroadcast y OpenTok.RemoveStreamFromBroadcast métodos (o el OpenTok.AddStreamToBroadcastAsync y OpenTok.RemoveStreamFromBroadcastAsync métodos). | | dvr | Indica si se debe habilitar la funcionalidad de DVR —rebobinar, pausar y reanudar— en los reproductores que la admiten (true), o no (false, valor por defecto). Si se habilita el DVR, la URL de HLS incluirá una cadena de consulta «?DVR» añadida al final. Véase Funcionalidad de grabación digital (DVR) | | lowLatency | Indica si se debe activar el 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. Véase Emisiones HLS de baja latencia | | multiBroadcastTag | Configura este parámetro 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. Consulta Emisiones simultáneas. | | hasAudio | Indica si la retransmisión tiene audio (el valor por defecto es «true»). | | hasVideo | Indica si la retransmisión tiene vídeo (el valor por defecto es «true»). |

Devoluciones : El Emisión objeto. Este objeto incluye propiedades que definen el archivo, entre ellas el identificador del archivo.

StartRenderAsync()

Inicia un nuevo renderizador de Experience Composer para una sesión de la Video API de Vonage.

Para obtener más información, consulta el . Guía para desarrolladores de Experience Composer.

Parámetros : | | | | --- | --- | | solicitud | La solicitud de representación. |

Devuelve : La representación generada.

StopArchive()

Detiene un OpenTok archivo que se está grabando.

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 del que quieres detener la grabación. |

Devoluciones : El Archivo objeto correspondiente al archivo que se está deteniendo.

StopArchiveAsync()

Detiene un OpenTok archivo que se está grabando.

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 del que quieres detener la grabación. |

Devoluciones : El Archivo objeto correspondiente al archivo que se está deteniendo.

StopAudioConnectorAsync()

Detiene el envío de audio en una sesión de la Video API de Vonage.

Parámetros : | | | | --- | --- | | connectionId | El OpenTok ID de conexión para la conexión WebSocket de Audio Connector en la sesión de la Video API de Vonage. Véase [AudioConnector.ConnectionId]. |

StopBroadcast()

Utiliza este método para detener una retransmisión en directo de una sesión de la Video API de Vonage. 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 |

Devoluciones : El Emisión objeto. Este objeto incluye propiedades que definen la emisión, incluido el identificador de la emisión.

StopBroadcastAsync()

Utiliza este método para detener una retransmisión en directo de una sesión de la Video API de Vonage. 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 |

Devoluciones : El Emisión objeto. Este objeto incluye propiedades que definen la emisión, incluido el identificador de la emisión.

StopRenderAsync()

Detiene un renderizador de Experience Composer.

Parámetros : | | | | --- | --- | | renderId | El identificador de la representación. |

Documentación inmobiliaria

ApiKey

La clave de la Video API de Vonage pasada a la OpenTok() constructor.

ApiSecret

La clave secreta de la Video API de Vonage pasada a la OpenTok() constructor.

Cliente

Para uso interno

Depurar

Permite escribir los detalles de las solicitudes y respuestas en la consola. No lo utilices en un entorno de producción.