Sesión de OpenTok. Más...

#include "capabilities.h" #include "config.h" #include "publisher.h" #include "subscriber.h" #include "stream.h"
Macros
#define LONGITUD_MÍNIMA_DEL_SECRETO_DE_CIFRADO   8
#define LONGITUD_MÁXIMA_DEL_SECRETO_DE_CIFRADO   256
Definiciones de tipos
typedef struct otc_session otc_session
typedef struct otc_session_settings otc_session_settings
Enumeraciones
enum otc_session_error_code {   OTC_SESSION_AUTHORIZATION_FAILURE , OTC_SESSION_BLOCKED_COUNTRY , OTC_SESSION_CONNECTION_DROPPED , OTC_SESSION_CONNECTION_FAILED ,   OTC_SESSION_CONNECTION_LIMIT_EXCEEDED , OTC_SESSION_CONNECTION_REFUSED , OTC_SESSION_CONNECTION_TIMED_OUT , OTC_SESSION_FORCE_UNPUBLISH_OR_INVALID_STREAM = 1535 ,   OTC_SESSION_ILLEGAL_STATE , OTC_SESSION_INTERNAL_ERROR , OTC_SESSION_INVALID_SESSION , OTC_SESSION_INVALID_SIGNAL_TYPE ,   OTC_SESSION_NOT_CONNECTED , OTC_SESSION_NO_MESSAGING_SERVER , OTC_SESSION_NULL_OR_INVALID_PARAMETER , OTC_SESSION_PUBLISHER_NOT_FOUND ,   OTC_SESSION_SIGNAL_DATA_TOO_LONG , OTC_SESSION_SIGNAL_TYPE_TOO_LONG , OTC_SESSION_UNABLE_TO_SEND_SIGNAL , OTC_SESSION_STATE_FAILED = 1020 ,   OTC_SESSION_SUBSCRIBER_NOT_FOUND , OTC_SESSION_UNEXPECTED_GET_SESSION_INFO_REPONSE , OTC_SESSION_ENCRYPTION_SECRET_MISSING , OTC_SESSION_INVALID_ENCRYPTION_SECRET }
Funciones
otc_session * otc_session_new (const char *apikey, const char *session_id, const struct otc_session_callbacks *funciones de devolución de llamada)
otc_session_settings * otc_session_settings_new (nulo)
otc_status otc_session_settings_set_connection_events_suppressed (otc_session_settings *configuración, otc_bool suprimir)
otc_status otc_session_settings_set_custom_ice_config (otc_session_settings *configuración, const struct otc_custom_ice_config *custom_ice_config)
otc_status otc_session_settings_set_proxy_url (otc_session_settings *configuración, const char *proxy_url)
otc_status otc_session_settings_set_ip_whitelist (otc_session_settings *configuración, otc_bool (lista blanca de IP)
otc_status otc_session_settings_set_single_peer_connection (otc_session_settings *configuración, otc_bool activar)
Activa o desactiva la conexión de par único (SPC) para una sesión. Más...
otc_status otc_session_settings_set_session_migration (otc_session_settings *configuración, otc_bool activar)
Activa o desactiva la migración de sesión para una sesión. Más...
otc_status otc_session_settings_delete (otc_session_settings *configuración)
otc_session * otc_session_new_with_settings (const char *apikey, const char *session_id, const struct otc_session_callbacks *funciones de devolución de llamada, otc_session_settings *configuración)
otc_status otc_session_delete (otc_session *sesión)
otc_status otc_session_connect (otc_session *session, const char *token)
otc_status otc_session_disconnect (otc_session *sesión)
otc_status otc_session_publish (otc_session *sesión, otc_publisher *editor)
otc_status otc_session_unpublish (otc_session *sesión, otc_publisher *editor)
otc_status otc_session_subscribe (otc_session *sesión, otc_suscriptor *suscriptor)
otc_status otc_session_unsubscribe (otc_session *sesión, otc_suscriptor *suscriptor)
otc_status otc_session_send_signal (otc_session *session, const char *type, const char *signal)
otc_status otc_session_force_mute_all (otc_session *session, const char **excluded_streams_ids, const int excluded_streams_len)
otc_status otc_session_disable_force_mute (otc_session *sesión)
otc_status otc_session_force_mute_stream (const otc_session *session, const char *stream_id_to_mute)
otc_status otc_session_force_disconnect (const otc_session *sesión, const otc_connection *conexión)
otc_status otc_session_send_signal_to_connection (otc_session *session, const char *type, const char *signal, const otc_connection *conexión)
otc_status otc_session_send_signal_with_options (otc_session *session, const char *type, const char *signal, struct otc_signal_options signal_options)
otc_status otc_session_send_signal_to_connection_with_options (otc_session *session, const char *type, const char *signal, const otc_connection *conexión, estructura otc_signal_options signal_options)
otc_status otc_session_report_issue (struct otc_session *session, const char *descripción_del_problema, char **id_del_problema)
char * otc_session_get_id (const otc_session *sesión)
otc_connection * otc_session_get_connection (const otc_session *sesión)
struct otc_session_capabilities otc_session_get_capabilities (const otc_session *sesión)
void * otc_session_get_user_data (const otc_session *sesión)
otc_status otc_session_set_encryption_secret (otc_session *session, const char *secret)
Establece la clave de cifrado de extremo a extremo que utilizarán todos los emisores y suscriptores de la sesión. Más...

Descripción detallada

Sesión de OpenTok.

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.

Documentación sobre `typedef`

otc_session
typedef struct otc_session otc_session

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

otc_session_settings

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

Documentación sobre tipos de 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.

Encuestador
OTC_SESSION_AUTHORIZATION_FAILURE Se ha introducido una clave o un token de API no válido.
OTC_SESSION_BLOCKED_COUNTRY 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 Se ha interrumpido la conexión con el servidor de mensajería de OpenTok.
OTC_SESSION_CONNECTION_FAILED No se ha podido conectar a la sesión.
OTC_SESSION_CONNECTION_LIMIT_EXCEEDED El cliente ha intentado conectarse a una sesión que ha superado el límite de conexiones simultáneas.
OTC_SESSION_CONNECTION_REFUSED 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 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 Flujo no válido.
OTC_SESSION_ILLEGAL_STATE 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 Error en el envío de subprocesos, falta de memoria, error de análisis, etc.
OTC_SESSION_INVALID_SESSION Se ha introducido un ID de sesión no válido.
OTC_SESSION_INVALID_SIGNAL_TYPE Has intentado enviar una señal con un tipo no válido.
OTC_SESSION_NOT_CONNECTED La sesión no está conectada, y la acción solicitada requiere una conexión de sesión activa.
OTC_SESSION_NO_MESSAGING_SERVER No hay ningún servidor de mensajería disponible para esta sesión.
OTC_SESSION_NULL_OR_INVALID_PARAMETER Un parámetro pasado es nulo o no válido.
OTC_SESSION_PUBLISHER_NOT_FOUND 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 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 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 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 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 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 Respuesta inesperada.
OTC_SESSION_ENCRYPTION_SECRET_MISSING Se ha intentado unirse a una sesión cifrada de extremo a extremo sin un secreto de cifrado.
OTC_SESSION_INVALID_ENCRYPTION_SECRET Se ha intentado unirse a una sesión cifrada de extremo a extremo sin un secreto de cifrado.

Documentación de funciones

otc_session_connect()
otc_status otc_session_connect ( otc_session * sesión,
const char * ficha
)

Conecta al cliente a una sesión de OpenTok.

Parámetros : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok a la que hay que conectarse. | | token | El token del cliente para conectarse a la sesión. Véase Visión general de la creación de tokens. |

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

otc_session_delete()
otc_status otc_session_delete ( otc_session * sesión )

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 : | | | | --- | --- | | sesión | La otc_session por ejemplo. |

otc_session_disable_force_mute()
otc_status otc_session_disable_force_mute ( otc_session * sesión )

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 : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok. |

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

otc_session_disconnect()
otc_status otc_session_disconnect ( otc_session * sesión )

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 : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok de la que hay que desconectarse. |

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

otc_session_force_disconnect()
otc_status otc_session_force_disconnect ( const otc_session * sesión,
const otc_connection * conexión
)

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 : | | | | --- | --- | | sesión | La sesión otc_session a la que pertenece la conexión | | conexión | La conexión que se va a desconectar |

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

otc_session_force_mute_all()
otc_status otc_session_force_mute_all ( otc_session * sesión,
const char ** excluded_streams_ids,
const int longitud_de_los_flujos_excluidos
)

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 : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok. | | excluded_streams_ids | Un puntero a una matriz de cadenas de identificadores de flujos para los flujos que se van a silenciar. Establece este valor en nullptr para silenciar todos los flujos de la sesión (incluidos los publicados por el cliente local). | | excluded_streams_len | La longitud de la matriz de flujos excluidos. |

Valores de retorno : 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()
otc_status otc_session_force_mute_stream ( const otc_session * sesión,
const char * stream_id_to_mute
)

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 : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok. | | stream_id_to_mute | La cadena de caracteres que identifica la transmisión que se va a silenciar. |

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

otc_session_get_capabilities()
struct otc_session_capabilities otc_session_get_capabilities ( const otc_session * sesión )

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 : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok. |

Devoluciones : El otc_session_capabilities instancia.

otc_session_get_connection()
otc_connection * otc_session_get_connection ( const otc_session * sesión )

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

Parámetros : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok. |

Devoluciones : El otc_connection instancia.

otc_session_get_id()
char * otc_session_get_id ( const otc_session * sesión )

Obtiene el identificador único de esta sesión.

otc_session_get_user_data()
void * otc_session_get_user_data ( const otc_session * sesión )

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

Parámetros : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok. |

Devuelve : Un puntero a los datos del usuario.

otc_session_new()
otc_session * otc_session_new ( const char * apikey,
const char * session_id,
const struct otc_session_callbacks * funciones de devolución de llamada
)

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 una estructura `otc_session` con opciones avanzadas.

Parámetros : | | | | --- | --- | | apikey | La clave de API del proyecto OpenTok. Véase Accede a la página de tu Account de la Video API de Vonage. |

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 : | | | | --- | --- | | session_id | El ID de sesión. | | callbacks | El otc_session_callbacks estructura que contiene funciones de devolución de llamada para eventos relacionados con la sesión. |

Valores devueltos : La estructura `otc_session`, que representa la sesión de OpenTok.

otc_session_new_with_settings()
otc_session * otc_session_new_with_settings ( const char * apikey,
const char * session_id,
const struct otc_session_callbacks * funciones de devolución de llamada,
otc_session_settings * ajustes
)

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 : | | | | --- | --- | | apikey | La clave de API del proyecto OpenTok. Véase Accede a la página de tu Account de la Video API de Vonage. | | session_id | El ID de sesión. | | callbacks | El otc_session_callbacks estructura que contiene funciones de devolución de llamada para eventos relacionados con la sesión. | | configuración | La otc_session_settings struct Con ajustes avanzados para la sesión. |

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

Véase también : otc_session_new.

otc_session_publish()
otc_status otc_session_publish ( otc_session * sesión,
otc_publisher * editor
)

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

Parámetros : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok en la que se va a publicar. | | publisher | El otc_publisher estructura que representa al editor. |

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

otc_session_report_issue()
otc_status otc_session_report_issue ( struct otc_session * sesión,
const char * descripción_del_problema,
char ** id_del_asunto
)

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 : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok. | | issue_description | Una cadena de descripción. | | issue_id | Un puntero a una cadena que se establecerá como identificador único del problema notificado. |

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

otc_session_send_signal()
otc_status otc_session_send_signal ( otc_session * sesión,
const char * tipo,
const char * señal
)

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 : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok. | | tipo | El valor de cadena opcional que indica el tipo de la señal. | | señal | El valor de cadena opcional que indica los datos de la señal. |

Valores de retorno : 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()
otc_status otc_session_send_signal_to_connection ( otc_session * sesión,
const char * tipo,
const char * señal,
const otc_connection * conexión
)

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 : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok. | | type | El valor opcional de tipo (cadena de caracteres) de la señal. | | signal | El valor opcional de datos (cadena de caracteres) de la señal. | | connection | El otc_connection estructura correspondiente al cliente que va a recibir la señal. |

Valores de retorno : 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()
otc_status otc_session_send_signal_to_connection_with_options ( otc_session * sesión,
const char * tipo,
const char * señal,
const otc_connection * conexión,
struct otc_signal_options opciones_de_señal
)

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 : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok. | | type | El valor opcional de tipo (cadena de caracteres) de la señal. | | signal | El valor opcional de datos (cadena de caracteres) de la señal. | | connection | El otc_connection estructura correspondiente al cliente que va a recibir la señal. | | signal_options | La otc_signal_options estructura con opciones para la señal. |

Valores de retorno : 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()
otc_status otc_session_send_signal_with_options ( otc_session * sesión,
const char * tipo,
const char * señal,
struct otc_signal_options opciones_de_señal
)

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 : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok. | | type | El valor opcional de tipo (cadena de caracteres) de la señal. | | signal | El valor opcional de datos (cadena de caracteres) de la señal. | | signal_options | El otc_signal_options estructura con opciones para la señal. |

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

otc_session_set_encryption_secret()
otc_status otc_session_set_encryption_secret ( otc_session * sesión,
const char * secreto
)

Establece la clave de cifrado de extremo a extremo que utilizarán todos los emisores y suscriptores en la sesión.

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

Parámetros : | | | | | --- | --- | --- | | | sesión | El otc_session Estructura que representa la sesión de OpenTok. | | [in] | secret | Valor del secreto de cifrado. |

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

otc_session_settings_delete()
otc_status otc_session_settings_delete ( otc_session_settings * ajustes )

Elimina un otc_session_settings instancia.

otc_session_settings_new()
otc_session_settings * otc_session_settings_new ( nulo )

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.

otc_session_settings_set_connection_events_suppressed()
otc_status otc_session_settings_set_connection_events_suppressed ( otc_session_settings * ajustes,
otc_bool suprimir
)

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.

otc_session_settings_set_custom_ice_config()
otc_status otc_session_settings_set_custom_ice_config ( otc_session_settings * ajustes,
const struct otc_custom_ice_config * custom_ice_config
)

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

otc_session_settings_set_ip_whitelist()
otc_status otc_session_settings_set_ip_whitelist ( otc_session_settings * ajustes,
otc_bool lista_blanca_de_IP
)

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.

otc_session_settings_set_proxy_url()
otc_status otc_session_settings_set_proxy_url ( otc_session_settings * ajustes,
const char * proxy_url
)

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

otc_session_settings_set_session_migration()
otc_status otc_session_settings_set_session_migration ( otc_session_settings * ajustes,
otc_bool activar
)

Activa o desactiva la migración de sesión para una sesión.

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 : | | | | --- | --- | | settings | Puntero al objeto de configuración de la sesión. | | enable | Indicador booleano para habilitar (OTC_TRUE) o deshabilitar (OTC_FALSE) la migración de sesiones. |

Valores devueltos : otc_status Devuelve el estado de la operación.

otc_session_settings_set_single_peer_connection()
otc_status otc_session_settings_set_single_peer_connection ( otc_session_settings * ajustes,
otc_bool activar
)

Activa o desactiva la conexión de par único (SPC) para una sesión.

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 : | | | | --- | --- | | settings | Puntero al objeto de configuración de la sesión. | | enable | Indicador booleano para habilitar (OTC_TRUE) o deshabilitar (OTC_FALSE) el SPC. |

Valores devueltos : otc_status Devuelve el estado de la operación.

otc_session_subscribe()
otc_status otc_session_subscribe ( otc_session * sesión,
otc_suscriptor * suscriptor
)

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 : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok que contiene la transmisión del suscriptor. | | suscriptor | El otc_subscriber estructura que representa al suscriptor. |

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

otc_session_unpublish()
otc_status otc_session_unpublish ( otc_session * sesión,
otc_publisher * editor
)

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

Parámetros : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok de la que se va a retirar la publicación. | | publisher | El otc_publisher estructura que representa al editor. |

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

otc_session_unsubscribe()
otc_status otc_session_unsubscribe ( otc_session * sesión,
otc_suscriptor * suscriptor
)

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

Parámetros : | | | | --- | --- | | sesión | La otc_session Estructura que representa la sesión de OpenTok que contiene la transmisión del suscriptor. | | suscriptor | El otc_subscriber estructura que representa al suscriptor. |

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