session.h

Este archivo incluye la definición de tipo de una sesión de OpenTok, junto con varias declaraciones de funciones útiles a la hora de trabajar con una sesión.

Estructuras de datos: otc_session_capabilities, otc_custom_ice_config, otc_signal_options, otc_session_callbacks

Incluye: capabilities.h, config.h, publisher.h, subscriber.h, stream.h

#define LONGITUD_MÍNIMA_DEL_SECRETO_DE_CIFRADO

#define ENCRYPTION_SECRET_MINIMUM_LENGTH 8

#define ENCRYPTION_SECRET_MAXIMUM_LENGTH

#define ENCRYPTION_SECRET_MAXIMUM_LENGTH 256

typedef otc_session

Definición del tipo de sesión de OpenTok.

typedef struct otc_session otc_session;

typedef otc_session_settings

Definición del tipo de configuración de sesión de OpenTok.

typedef struct otc_session_settings otc_session_settings;

enumeración otc_session_error_code

Lista de códigos de error para las sesiones de OpenTok.

Esta enumeración recoge varios códigos de error relacionados con una sesión.

Nombre Valor Descripción
OTC_SESSION_AUTHORIZATION_FAILURE 1004 Se ha introducido una clave o un token de API no válido.
OTC_SESSION_BLOCKED_COUNTRY 1026 No se ha podido conectar a la sesión. Incumplimiento de las condiciones del servicio: cumplimiento de la normativa de exportación.
OTC_SESSION_CONNECTION_DROPPED 1022 Se ha interrumpido la conexión con el servidor de mensajería de OpenTok.
OTC_SESSION_CONNECTION_FAILED 1006 No se ha podido conectar a la sesión.
OTC_SESSION_CONNECTION_LIMIT_EXCEEDED 1027 El cliente ha intentado conectarse a una sesión que ha superado el límite de conexiones simultáneas.
OTC_SESSION_CONNECTION_REFUSED 1023 No se ha podido abrir una conexión con el servidor de mensajería. Comprueba que se pueda acceder a los puertos de salida 443 y 8080.
OTC_SESSION_CONNECTION_TIMED_OUT 1021 Se ha agotado el tiempo de espera de la conexión al intentar conectarse a la sesión
OTC_SESSION_FORCE_UNPUBLISH_OR_INVALID_STREAM 1535 Flujo no válido.
OTC_SESSION_ILLEGAL_STATE 1015 Se ha invocado un método en un momento no válido o inadecuado para esta sesión. Por ejemplo, si se intenta conectar una sesión que ya está conectada, se producirá este error.
OTC_SESSION_INTERNAL_ERROR 2000 Error en el envío de subprocesos, falta de memoria, error de análisis, etc.
OTC_SESSION_INVALID_SESSION 1005 Se ha introducido un ID de sesión no válido.
OTC_SESSION_INVALID_SIGNAL_TYPE 1461 Has intentado enviar una señal con un tipo no válido.
OTC_SESSION_NOT_CONNECTED 1010 La sesión no está conectada, y la acción solicitada requiere una conexión de sesión activa.
OTC_SESSION_NO_MESSAGING_SERVER 1503 No hay ningún servidor de mensajería disponible para esta sesión.
OTC_SESSION_NULL_OR_INVALID_PARAMETER 1011 Un parámetro pasado es nulo o no válido.
OTC_SESSION_PUBLISHER_NOT_FOUND 1113 El editor es desconocido para esta sesión. Esto suele deberse a que se ha intentado eliminar la publicación de un editor que no está asociado a la sesión.
OTC_SESSION_SIGNAL_DATA_TOO_LONG 1413 Has intentado enviar una señal con una cadena de datos cuya longitud supera la longitud máxima (8 KB).
OTC_SESSION_SIGNAL_TYPE_TOO_LONG 1414 Has intentado enviar una señal con una cadena de tipo cuya longitud supera la longitud máxima permitida.
OTC_SESSION_UNABLE_TO_SEND_SIGNAL 1550 No se ha podido enviar la señal correctamente, quizá debido a la falta de permisos (por ejemplo, un token exclusivo para editores).
OTC_SESSION_STATE_FAILED 1020 Se ha agotado el tiempo de espera de la conexión al intentar obtener el estado de la sesión.
OTC_SESSION_SUBSCRIBER_NOT_FOUND 1112 El suscriptor es desconocido para esta sesión. Esto suele deberse a que se ha intentado dar de baja a un suscriptor que no está asociado a la sesión.
OTC_SESSION_UNEXPECTED_GET_SESSION_INFO_REPONSE 2001 Respuesta inesperada.
OTC_SESSION_ENCRYPTION_SECRET_MISSING 6000 Se ha intentado unirse a una sesión cifrada de extremo a extremo sin un secreto de cifrado.
OTC_SESSION_INVALID_ENCRYPTION_SECRET 6004 La clave de cifrado facilitada a otc_session_set_encryption_secret no es válido.
OTC_SESSION_ENCRYPTION_NOT_ENABLED 6007 Se ha establecido una clave de cifrado (véase otc_session_set_encryption_secret), pero la sesión no estaba configurada con cifrado de extremo a extremo.

Funciones

Nombre Descripción
otc_session_new(apikey, session_id, callbacks) → {otc_session *} Crea un nuevo otc_session instancia de estructura.
otc_session_settings_new() → {otc_session_settings *} Crea un nuevo otc_session_settings por ejemplo, se utiliza para configurar los ajustes avanzados de la sesión.
otc_session_settings_set_connection_events_suppressed(settings, suppress) → {otc_status} Evitar los eventos de conexión para permitir sesiones de vídeo interactivas de gran envergadura.
otc_session_settings_set_custom_ice_config(settings, custom_ice_config) → {otc_status} Permite configurar el servidor ICE de forma personalizada.
otc_session_settings_set_proxy_url(settings, proxy_url) → {otc_status} Establece la URL del proxy IP.
otc_session_settings_set_ip_whitelist(settings, ip_whitelist) → {otc_status} Pasa el parámetro OTC_TRUE para que el cliente utilice la lista blanca de direcciones IP.
otc_session_settings_set_single_peer_connection(settings, enable) → {otc_status} La conexión de par único (SPC) es una función que encapsula todas las conexiones de los abonados en una única conexión de par.
otc_session_settings_set_session_migration(settings, enable) → {otc_status} Activa la función de migración de sesiones, lo que permite que el cliente permanezca conectado durante la rotación de servidores.
otc_session_settings_delete(settings) → {otc_status} Elimina un otc_session_settings instancia.
otc_session_new_with_settings(apikey, session_id, callbacks, settings) → {otc_session *} Crea una nueva sesión de OpenTok con ajustes avanzados.
otc_session_delete(session) → {otc_status} Libera los recursos asociados a la sesión.
otc_session_connect(session, token) → {otc_status} Conecta al cliente a una sesión de OpenTok.
otc_session_disconnect(session) → {otc_status} Desconecta al cliente de esta sesión.
otc_session_publish(session, publisher) → {otc_status} Inicia la transmisión de un editor a la sesión.
otc_session_unpublish(session, publisher) → {otc_status} Elimina un emisor de una sesión (lo que provoca que su flujo se detenga).
otc_session_subscribe(session, subscriber) → {otc_status} Inicia la suscripción a (la recepción de) la transmisión de audio y vídeo de un suscriptor en esta sesión.
otc_session_unsubscribe(session, subscriber) → {otc_status} Deja de suscribirse a (de recibir la transmisión de) un suscriptor específico en la sesión.
otc_session_send_signal(session, type, signal) → {otc_status} Envía una señal a todos los clientes conectados a la sesión.
otc_session_force_mute_all(session, excluded_streams_ids, excluded_streams_len) → {otc_status} Obliga a todos los emisores de la sesión (excepto a aquellos que emiten transmisiones excluidas) a silenciar el audio.
otc_session_disable_force_mute(session) → {otc_status} Desactiva el estado de silencio activo de la sesión.
otc_session_force_mute_stream(session, stream_id_to_mute) → {otc_status} Obliga al emisor de una transmisión determinada a silenciar su audio.
otc_session_force_disconnect(session, connection) → {otc_status} Obliga a un cliente a desconectarse de la sesión.
otc_session_send_signal_to_connection(session, type, signal, connection) → {otc_status} Envía una señal a un cliente concreto conectado a la sesión.
otc_session_send_signal_with_options(session, type, signal, signal_options) → {otc_status} Envía una señal a todos los clientes conectados a la sesión, con las opciones especificadas.
otc_session_send_signal_to_connection_with_options(session, type, signal, connection, signal_options) → {otc_status} Envía una señal a un cliente concreto, con las opciones especificadas.
otc_session_report_issue(session, issue_description, issue_id) → {otc_status} Informa de que tu aplicación ha tenido un problema.
otc_session_get_id(session) → {char *} Obtiene el identificador único de esta sesión.
otc_session_get_connection(session) → {otc_connection *} Obtiene el objeto de conexión asociado a esta sesión.
otc_session_get_capabilities(session) → {struct otc_session_capabilities} Obtiene las capacidades del cliente conectado a la sesión.
otc_session_get_user_data(session) → {void *} Obtiene los datos de usuario asociados a la sesión.
otc_session_set_encryption_secret(session, secret) → {otc_status} Véase el Guía para desarrolladores sobre el cifrado de extremo a extremo.

otc_session_new(apikey, session_id, callbacks) → {otc_session *}

Crea un nuevo otc_session instancia de la estructura. Pásala a la otc_session_connect función para conectarse a la sesión de OpenTok.

Ver también otc_session_new_with_settings para inicializar un otc_session estructura con opciones avanzadas.

Importante: Si estás utilizando la Video API con una aplicación de Vonage (en lugar de un proyecto de OpenTok), introduce el ID de la aplicación (no una clave de API de OpenTok) en este parámetro.

Parámetros:
Nombre Tipo Descripción
apikey const char * La clave API del proyecto OpenTok. Véase Accede a la página de tu Account de la Video API de Vonage.
session_id const char * El identificador de sesión.
callbacks const struct otc_session_callbacks * El otc_session_callbacks estructura que contiene funciones de devolución de llamada para eventos relacionados con la sesión.
Devoluciones:

El otc_session estructura que representa la sesión de OpenTok.

otc_session_settings_new() → {otc_session_settings *}

Crea un nuevo otc_session_settings instancia, que se utiliza para configurar los parámetros avanzados de la sesión. Llama a las siguientes funciones para configurar estos parámetros antes de llamar a la otc_session_new_with_settings función para crear una sesión con esta configuración:

  • otc_session_settings_set_connection_events_suppressed — Ocultar los eventos de conexión.
  • otc_session_settings_set_custom_ice_config &mdash Utilizar servidores TURN personalizados.
  • otc_session_settings_set_proxy_url — Configura la función de proxy IP.
  • otc_session_settings_set_ip_whitelist — Activa la función de lista blanca de direcciones IP.
  • otc_session_settings_set_single_peer_connection — Activa la función «Conexión con un único par».
  • otc_session_settings_set_session_migration — Activa la función de migración de sesiones.
Devoluciones:

otc_session_settings *

otc_session_settings_set_connection_events_suppressed(settings, suppress) → {otc_status}

Evita los eventos de conexión para permitir sesiones de vídeo interactivas de gran envergadura. Esto evita que otc_session_callbacks.on_connection_created y otc_session_callbacks.on_connection_dropped que no se activen las funciones de devolución de llamada cuando otros clientes se conecten a la sesión o se desconecten de ella. (Además, el servidor de OpenTok no envía estos eventos al cliente.) Para obtener más información, consulta Supresión de eventos de conexión en las guías para desarrolladores de OpenTok.

Parámetros:
Nombre Tipo Descripción
settings otc_session_settings *
suppress otc_bool
Devoluciones:

otc_status

otc_session_settings_set_custom_ice_config(settings, custom_ice_config) → {otc_status}

Permite configurar el servidor ICE de forma personalizada. Esto forma parte del función TURN configurable.

Parámetros:
Nombre Tipo Descripción
settings otc_session_settings *
custom_ice_config const struct otc_custom_ice_config *
Devoluciones:

otc_status

otc_session_settings_set_proxy_url(settings, proxy_url) → {otc_status}

Establece la URL del proxy IP. Consulta el Guía del desarrollador del proxy IP.

Parámetros:
Nombre Tipo Descripción
settings otc_session_settings *
proxy_url const char *
Devoluciones:

otc_status

otc_session_settings_set_ip_whitelist(settings, ip_whitelist) → {otc_status}

Pasa el parámetro OTC_TRUE para que el cliente utilice la lista blanca de direcciones IP. Esta función está disponible como función adicional.

Parámetros:
Nombre Tipo Descripción
settings otc_session_settings *
ip_whitelist otc_bool
Devoluciones:

otc_status

otc_session_settings_set_single_peer_connection(configuración, habilitar) → {otc_status}

La conexión de par único (SPC) es una función que encapsula todas las conexiones de los abonados en una única conexión de par. Entre las ventajas de habilitar la SPC se incluyen un menor consumo de recursos del sistema operativo, un mejor control de la velocidad y, en el caso de los dispositivos móviles nativos, la compatibilidad con sesiones de mayor tamaño.

SPC está desactivado por defecto. Cuando está desactivado, la sesión utilizará la conexión de pares múltiples (MPC), en la que se establece una conexión de par independiente entre cada punto final.

Parámetros:
Nombre Tipo Descripción
settings otc_session_settings * Puntero al objeto de configuración de la sesión.
enable otc_bool Indicador booleano para activar (OTC_TRUE) o desactivar (OTC_FALSE) el SPC.
Devoluciones:

otc_status Devuelve el estado de la operación.

otc_session_settings_set_session_migration(settings, enable) → {otc_status}

Activa la función de migración de sesiones, lo que permite que el cliente permanezca conectado durante la rotación de servidores. El valor por defecto es false (la migración de sesiones no está habilitada). Para obtener más información, consulta Rotación de servidores y migración de sesiones.

Parámetros:
Nombre Tipo Descripción
settings otc_session_settings * Puntero al objeto de configuración de la sesión.
enable otc_bool Variable booleana para activar (OTC_TRUE) o desactivar (OTC_FALSE) la migración de sesiones.
Devoluciones:

otc_status Devuelve el estado de la operación.

otc_session_settings_delete(settings) → {otc_status}

Elimina un otc_session_settings instancia.

Parámetros:
Nombre Tipo Descripción
settings otc_session_settings *
Devoluciones:

otc_status

otc_session_new_with_settings(apikey, session_id, callbacks, settings) → {otc_session *}

Crea una nueva sesión de OpenTok con ajustes avanzados. Entre ellos se incluyen ajustes para suprimir eventos de conexión, servidores TURN personalizados, la función de proxy IP y la función de lista blanca de direcciones IP.

Parámetros:
Nombre Tipo Descripción
apikey const char * La clave API del proyecto OpenTok. Véase Accede a la página de tu Account de la Video API de Vonage.
session_id const char * El identificador de sesión.
callbacks const struct otc_session_callbacks * El otc_session_callbacks estructura que contiene funciones de devolución de llamada para eventos relacionados con la sesión.
settings otc_session_settings * El otc_session_settings Estructura con ajustes avanzados para la sesión.

Véase: : - otc_session_new.

Devoluciones:

El struct, que representa la sesión de OpenTok.

otc_session_delete(session) → {otc_status}

Libera los recursos asociados a la sesión. No hay funciones de devolución de llamada en otc_session_callbacks se ejecutará como consecuencia de la llamada a este método (o posteriormente).

Parámetros:
Nombre Tipo Descripción
session otc_session * El otc_session instancia.
Devoluciones:

otc_status

otc_session_connect(session, token) → {otc_status}

Conecta al cliente a una sesión de OpenTok.

Parámetros:
Nombre Tipo Descripción
session otc_session * El otc_session estructura que representa la sesión de OpenTok a la que hay que conectarse.
token const char * El token de cliente para conectarse a la sesión. Véase Visión general de la creación de tokens.
Devoluciones:

Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_session_disconnect(session) → {otc_status}

Desconecta al cliente de esta sesión. Todos los suscriptores y editores del cliente también quedarán desconectados de la sesión. Como práctica recomendada, antes de llamar a esta función, llama a la otc_session_unpublish función para todos los editores y esperar a que el otc_publisher_callbacks#on_stream_destroyed función de devolución de llamada. Esto garantiza la eliminación completa de los editores, sobre todo si los problemas de conectividad de red impiden dicha eliminación debido a la función de reconexión, que puede mantener activos los flujos de los editores a la espera de una posible reconexión.

Parámetros:
Nombre Tipo Descripción
session otc_session * El otc_session estructura que representa la sesión de OpenTok de la que hay que desconectarse.
Devoluciones:

Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_session_publish(session, publisher) → {otc_status}

Inicia la transmisión de un editor a la sesión.

Parámetros:
Nombre Tipo Descripción
session otc_session * El otc_session estructura que representa la sesión de OpenTok en la que se va a publicar.
publisher otc_publisher * El otc_publisher estructura que representa al editor.
Devoluciones:

Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_session_unpublish(session, publisher) → {otc_status}

Elimina un emisor de una sesión (lo que provoca que su flujo se detenga).

Parámetros:
Nombre Tipo Descripción
session otc_session * El otc_session Estructura que representa la sesión de OpenTok que se va a desactivar.
publisher otc_publisher * El otc_publisher estructura que representa al editor.
Devoluciones:

Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_session_subscribe(session, subscriber) → {otc_status}

Inicia la suscripción a (la recepción de) la transmisión de audio y vídeo de un suscriptor en esta sesión.

Parámetros:
Nombre Tipo Descripción
session otc_session * El otc_session Estructura que representa la sesión de OpenTok y que contiene la transmisión del suscriptor.
subscriber otc_subscriber * El otc_subscriber estructura que representa al suscriptor.
Devoluciones:

Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_session_unsubscribe(session, subscriber) → {otc_status}

Deja de suscribirse a (de recibir la transmisión de) un suscriptor específico en la sesión.

Parámetros:
Nombre Tipo Descripción
session otc_session * El otc_session Estructura que representa la sesión de OpenTok y que contiene la transmisión del suscriptor.
subscriber otc_subscriber * El otc_subscriber estructura que representa al suscriptor.
Devoluciones:

Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_session_send_signal(session, type, signal) → {otc_status}

Envía una señal a todos los clientes conectados a la sesión. Véase otc_session_send_signal_with_options, otc_session_send_signal_to_connectiony otc_session_send_signal_to_connection_with_options. Véase también el Resumen sobre la señalización.

Parámetros:
Nombre Tipo Descripción
session otc_session * El otc_session estructura que representa la sesión de OpenTok.
type const char * El valor de cadena de tipo opcional para la señal.
signal const char * El valor opcional de la cadena de datos de la señal.
Devoluciones:

Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_session_force_mute_all(session, excluded_streams_ids, excluded_streams_len) → {otc_status}

Obliga a todos los emisores de la sesión (excepto a aquellos que emiten transmisiones excluidas) a silenciar el audio.

Además, cualquier flujo que se publique después de la llamada a la función otc_session_force_mute_all se publican con el audio silenciado. Puede eliminar el estado de silencio de una sesión llamando a la función otc_session_disable_force_mute función. Una vez que hayas llamado a la otc_session_disable_force_mute A partir de ahora, las nuevas retransmisiones publicadas en la sesión ya no tendrán el audio silenciado.

Al llamar a esta función, se produce el otc_session_callback.on_mute_forced() función de devolución de llamada que se ejecutará en cada cliente conectado a la sesión, con el active propiedad del otc_on_mute_forced_info estructura pasada a la función establecida en OTC_TRUE. Además, el otc_publisher_callbacks.on_publisher_mute_forced() La función de devolución de llamada se ejecuta en cada cliente que publica un flujo silenciado.

Llame al otc_session_get_capabilities función para comprobar si el cliente puede llamar a esta función correctamente. Está reservada para los clientes que se hayan conectado con un token al que se le haya asignado el rol de moderador (véase el (véase el Descripción general de la creación de tokens.

Parámetros:
Nombre Tipo Descripción
session otc_session * El otc_session estructura que representa la sesión de OpenTok.
excluded_streams_ids const char * * Un puntero a una matriz de cadenas que contienen los identificadores de las transmisiones que se van a silenciar. Establece este valor en `nullptr` para silenciar todas las transmisiones de la sesión (incluidas las publicadas por el cliente local).
excluded_streams_len const int La longitud de la matriz de secuencias excluidas.
Devoluciones:

Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_session_disable_force_mute(session) → {otc_status}

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 otc_session_force_mute_all() función (o cuando un moderador de otro cliente realiza una llamada para silenciar todas las transmisiones), cualquier transmisión publicada tras la llamada de moderación se publica con el audio silenciado. Llama a la otc_session_disable_force_mute Función para desactivar el estado de silencio de una sesión (de modo que las nuevas transmisiones publicadas no se silencien automáticamente).

Al llamar a esta función, se produce el otc_session_callback.on_mute_forced() función de devolución de llamada que se ejecutará en cada cliente conectado a la sesión, con el active propiedad del otc_on_mute_forced_info estructura pasada a la función establecida en OTC_FALSE.

Llame al otc_session_get_capabilities función para comprobar si el cliente puede llamar a esta función correctamente. Está reservada para los clientes que se hayan conectado con un token al que se le haya asignado el rol de moderador (véase el Descripción general de la creación de tokens.

Parámetros:
Nombre Tipo Descripción
session otc_session * El otc_session estructura que representa la sesión de OpenTok.
Devoluciones:

Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_session_force_mute_stream(session, stream_id_to_mute) → {otc_status}

Obliga al emisor de una transmisión determinada a silenciar su audio.

Al llamar a esta función, se produce el otc_publisher_callbacks.on_publisher_mute_forced() función de devolución de llamada que se ejecutará en el cliente que publica el flujo silenciado.

Llame al otc_session_get_capabilities función para comprobar si el cliente puede llamar a esta función correctamente. Está reservada para los clientes que se hayan conectado con un token al que se le haya asignado el rol de moderador (véase el (véase el Descripción general de la creación de tokens.

Parámetros:
Nombre Tipo Descripción
session const otc_session * El otc_session estructura que representa la sesión de OpenTok.
stream_id_to_mute const char * La cadena de identificación de la transmisión que se va a silenciar.
Devoluciones:

Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_session_force_disconnect(session, connection) → {otc_status}

Obliga a un cliente a desconectarse de la sesión.

Aunque puedes utilizar esta función para cerrar tu propia conexión, al llamar a otc_session_disconnect es más sencillo. Se devuelve un error si el rol del cliente no incluye los permisos necesarios para forzar la desconexión de otros usuarios. El rol del cliente se define al crear el token de usuario. Cuando se interrumpe una conexión mediante esta función, otc_session_callbacks#on_connection_dropped y otc_publisher_callbacks#on_stream_destroyed Las funciones de devolución de llamada se ejecutan del mismo modo que si la conexión se hubiera cerrado por sí misma mediante otc_session_disconnect.

Parámetros:
Nombre Tipo Descripción
session const otc_session * El otc_session que la conexión forma parte de
connection const otc_connection * La conexión para desconectar
Devoluciones:

Un error en caso de que se produzca un error; en caso contrario, OTC_SUCCESS

otc_session_send_signal_to_connection(session, type, signal, connection) → {otc_status}

Envía una señal a un cliente concreto conectado a la sesión. Véase otc_session_send_signal_to_connection_with_options, otc_session_send_signaly otc_session_send_signal_with_options. Véase también el Resumen sobre la señalización.

Parámetros:
Nombre Tipo Descripción
session otc_session * El otc_session estructura que representa la sesión de OpenTok.
type const char * El valor de cadena de tipo opcional para la señal.
signal const char * El valor opcional de la cadena de datos de la señal.
connection const otc_connection * El otc_connection estructura correspondiente al cliente que va a recibir la señal.
Devoluciones:

Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_session_send_signal_with_options(session, type, signal, signal_options) → {otc_status}

Envía una señal a todos los clientes conectados a la sesión, con las opciones especificadas. Véase otc_session_send_signal, otc_session_send_signal_to_connectiony otc_session_send_signal_to_connection_with_options. Véase también el Resumen sobre la señalización.

Parámetros:
Nombre Tipo Descripción
session otc_session * El otc_session estructura que representa la sesión de OpenTok.
type const char * El valor de cadena de tipo opcional para la señal.
signal const char * El valor opcional de la cadena de datos de la señal.
signal_options struct otc_signal_options El otc_signal_options estructura con opciones para la señal.
Devoluciones:

Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_session_send_signal_to_connection_with_options(session, type, signal, connection, signal_options) → {otc_status}

Envía una señal a un cliente concreto, con las opciones especificadas. Véase otc_session_send_signal, otc_session_send_signal_to_connectiony otc_session_send_signal_with_options. Véase también el Resumen sobre la señalización.

Parámetros:
Nombre Tipo Descripción
session otc_session * El otc_session estructura que representa la sesión de OpenTok.
type const char * El valor de cadena de tipo opcional para la señal.
signal const char * El valor opcional de la cadena de datos de la señal.
connection const otc_connection * El otc_connection estructura correspondiente al cliente que va a recibir la señal.
signal_options struct otc_signal_options El otc_signal_options estructura con opciones para la señal.
Devoluciones:

Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_session_report_issue(session, issue_description, issue_id) → {otc_status}

Informa de que tu aplicación ha tenido un problema. Puedes utilizar el ID del problema con el Inspector herramienta o al tratar un problema con el equipo de asistencia de la Video API de Vonage.

Parámetros:
Nombre Tipo Descripción
session struct otc_session * El otc_session estructura que representa la sesión de OpenTok.
issue_description const char * Una cadena de descripción.
issue_id char * * Un puntero a una cadena que se establecerá como identificador único del problema notificado.
Devoluciones:

Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.

otc_session_get_id(session) → {char *}

Obtiene el identificador único de esta sesión.

Parámetros:
Nombre Tipo Descripción
session const otc_session *
Devoluciones:

char *

otc_session_get_connection(session) → {otc_connection *}

Obtiene el objeto de conexión asociado a esta sesión.

Parámetros:
Nombre Tipo Descripción
session const otc_session * El otc_session estructura que representa la sesión de OpenTok.
Devoluciones:

El otc_connection instancia.

otc_session_get_capabilities(session) → {struct otc_session_capabilities}

Obtiene las capacidades del cliente conectado a la sesión. Todas otc_session_capabilities los miembros no están definidos hasta que otc_session_callbacks.on_connected se ha llamado.

Parámetros:
Nombre Tipo Descripción
session const otc_session * El otc_session estructura que representa la sesión de OpenTok.
Devoluciones:

El otc_session_capabilities instancia.

otc_session_get_user_data(session) → {void *}

Obtiene los datos de usuario asociados a la sesión. Véase otc_session_callbacks.user_data.

Parámetros:
Nombre Tipo Descripción
session const otc_session * El otc_session estructura que representa la sesión de OpenTok.
Devoluciones:

Un puntero a los datos del usuario.

otc_session_set_encryption_secret(session, secret) → {otc_status}

Véase el Guía para desarrolladores sobre el cifrado de extremo a extremo.

La sesión debe haberse configurado con cifrado de extremo a extremo mediante el SDK del servidor. Solo se sabe si el cifrado de extremo a extremo está activado una vez que se ha recibido la configuración de la sesión desde el servidor.

Si, en el momento de llamar a esta función, ya se sabe que la sesión no está cifrada de extremo a extremo, devuelve OTC_SESSION_ENCRYPTION_NOT_ENABLED de forma sincrónica. En ese caso, los editores y suscriptores existentes también reciben el error correspondiente a través de sus funciones de devolución de llamada de error y se eliminan.

Si aún no se sabe si el cifrado de extremo a extremo está activado (por ejemplo, cuando el secreto se establece antes de que se conecte la sesión), esta función se ejecuta con éxito. Si posteriormente resulta que la sesión no está cifrada de extremo a extremo, la OTC_SESSION_ENCRYPTION_NOT_ENABLED El error se devuelve de forma sincrónica desde el siguiente otc_session_publish o otc_session_subscribe llamada (registrada como OTC_PUBLISHER_ENCRYPTION_NOT_ENABLED / OTC_SUBSCRIBER_ENCRYPTION_NOT_ENABLED respectivamente).

Pase NULL o una cadena vacía, ya que el secreto restablece (borra) el secreto de cifrado establecido anteriormente. Siempre está permitido restablecer el secreto, incluso en una sesión de la que se sabe que no está cifrada de extremo a extremo.

Cualquier otro secreto debe quedar entre ENCRYPTION_SECRET_MINIMUM_LENGTH y ENCRYPTION_SECRET_MAXIMUM_LENGTH bytes de longitud cuando está codificado en UTF-8; en caso contrario OTC_SESSION_INVALID_ENCRYPTION_SECRET se devuelve.

Se aplica un nuevo secreto a los editores y suscriptores que ya están en funcionamiento, así como a los que se creen a partir de ese momento. Sin embargo, el restablecimiento del secreto solo surte efecto para los editores y suscriptores creados a partir de ese momento: los que ya están en funcionamiento siguen cifrando y descifrando con el secreto anterior hasta que se vuelvan a crear.

Parámetros:
Nombre Tipo Descripción
session otc_session * El otc_session estructura que representa la sesión de OpenTok.
secret const char * Valor del secreto de cifrado, o NULL o una cadena vacía para restablecer el secreto de cifrado establecido anteriormente.
Devoluciones:

Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente. Devuelve OTC_SESSION_INVALID_ENCRYPTION_SECRET si la contraseña no es un restablecimiento (NULL ni está vacío) ni tiene una longitud válida, y OTC_SESSION_ENCRYPTION_NOT_ENABLED si se establece un secreto no vacío en una sesión de la que ya se sabe que no está cifrada de extremo a extremo.