Suscriptor de OpenTok. Más...
#include "audio_data.h"
#include "base.h"
#include "config.h"
#include "error.h"
#include "media_utils.h"
#include "stream.h"
#include "video_frame.h"
| Estructuras de datos | |
| struct | otc_subscriber_audio_stats |
| struct | otc_subscriber_video_stats |
| struct | otc_subscriber_media_link_stats |
| struct | otc_subscriber_rtc_stats_report_cb |
| struct | otc_subscriber_callbacks |
| Definiciones de tipos | |
| typedef struct otc_suscriptor | otc_suscriptor |
Descripción detallada
Suscriptor de OpenTok.
Este archivo incluye la definición de tipo de un suscriptor de OpenTok, junto con varias declaraciones de funciones.
Documentación sobre `typedef`
otc_suscriptor
| typedef struct otc_suscriptor otc_suscriptor |
Definición del tipo de suscriptor de OpenTok.
Un tipo que representa al consumidor de audio y vídeo de una transmisión en la sesión de OpenTok.
Documentación sobre tipos de enumeración
otc_código_de_error_de_suscriptor
Lista de códigos de error para los suscriptores de OpenTok. Esta lista recoge varios códigos de error asociados a un suscriptor.
| Encuestador | |
|---|---|
| OTC_SUBSCRIBER_INTERNAL_ERROR | Error interno al suscribirse. |
| OTC_SUBSCRIBER_SESSION_DISCONNECTED | Se está intentando suscribirse a una transmisión en una sesión de la que ya te has desconectado. |
| OTC_SUBSCRIBER_SERVER_CANNOT_FIND_STREAM | El suscriptor ha fallado porque falta el flujo. Esto puede ocurrir si el suscriptor se crea al mismo tiempo que se elimina el flujo de la sesión. |
| OTC_SUBSCRIBER_STREAM_LIMIT_EXCEEDED | El cliente ha intentado suscribirse a una transmisión en una sesión que ha superado el límite de transmisiones simultáneas. |
| OTC_SUBSCRIBER_TIMED_OUT | Se ha producido un tiempo de espera al intentar suscribirse. |
| OTC_SUBSCRIBER_WEBRTC_ERROR | Error de WebRTC del suscriptor. |
| OTC_SUBSCRIBER_PEER_CONNECTION_NOT_CONNECTED | La conexión entre pares aún no se ha creado ni se ha establecido. |
| OTC_SUBSCRIBER_DECRYPTION_INTERNAL_ERROR | Error interno al descifrar un paquete |
| OTC_SUBSCRIBER_ENCRYPTION_SECRET_MISMATCH | Discrepancia secreta al descifrar un paquete |
| OTC_SUBSCRIBER_DECRYPTION_UNSUPPORTED_CODEC | Códec multimedia no compatible para el descifrado |
Documentación de funciones
otc_subscriber_delete()
| otc_status otc_subscriber_delete | ( | otc_suscriptor * | suscriptor | ) |
Libera una instancia de suscriptor, incluidos todos los recursos de hardware y de interfaz de usuario asociados a ella. No hay llamadas de retorno en otc_subscriber_callbacks se ejecutará como consecuencia de la llamada a este método (o posteriormente).
Parámetros : | | | | --- | --- | | suscriptor | El suscriptor que se va a eliminar. |
Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
otc_subscriber_get_audio_volume()
| otc_status otc_subscriber_get_audio_volume | ( | const otc_suscriptor * | suscriptor, |
| doble * | volumen | ||
| ) |
Devuelve el volumen de audio del abonado, en un rango comprendido entre 0 y 100.
El valor por defecto es 100.
Parámetros : | | | | --- | --- | | suscriptor | La instancia del suscriptor. | | volumen | El volumen del suscriptor. |
Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
Véase también : otc_error_code
otc_subscriber_get_captions_translation_language()
| const char * otc_subscriber_get_captions_translation_language | ( | const otc_suscriptor * | suscriptor | ) |
Obtiene el idioma de traducción de los subtítulos configurado para un suscriptor determinado.
Esta es una función en fase beta privada.
Parámetros : | | | | --- | --- | | suscriptor | La instancia del suscriptor. |
Devuelve : El idioma configurado para la traducción. Puede ser nulo si no se ha establecido.
otc_subscriber_get_preferred_framerate()
| otc_status otc_subscriber_get_preferred_framerate | ( | const otc_suscriptor * | suscriptor, |
| float * | velocidad_preferida | ||
| ) |
Devuelve la frecuencia de fotogramas preferida para la transmisión del suscriptor.
Parámetros : | | | | --- | --- | | subscriber | La instancia del suscriptor. | | preferred_framerate | La frecuencia de fotogramas preferida asociada 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.
Véase también : otc_error_code
otc_subscriber_get_preferred_resolution()
| otc_status otc_subscriber_get_preferred_resolution | ( | const otc_suscriptor * | suscriptor, |
| uint32_t * | ancho_preferido, | ||
| uint32_t * | altura_preferida | ||
| ) |
Devuelve la resolución preferida para la transmisión del suscriptor.
Parámetros : | | | | --- | --- | | subscriber | La instancia del suscriptor. | | preferred_width | El ancho preferido del suscriptor. | | preferred_height | La altura preferida del suscriptor. |
Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
Véase también : otc_error_code
otc_subscriber_get_rtc_stats_report()
| otc_status otc_subscriber_get_rtc_stats_report | ( | const otc_suscriptor * | suscriptor | ) |
Obtiene el informe de estadísticas de RTC del suscriptor. Se trata de una operación asíncrona. Crea un otc_subscriber_rtc_stats_report_cb struct y pasarla a la otc_subscriber_set_rtc_stats_report_cb función antes de llamar a esta función. Cuando las estadísticas estén disponibles, la otc_subscriber_set_rtc_stats_report_cb Se invoca la función de devolución de llamada.
Véase también otc_subscriber_callbacks.on_audio_stats, otc_subscriber_callbacks.on_video_statsy otc_publisher_get_rtc_stats_report.
Parámetros : | | | | --- | --- | | suscriptor | El suscriptor. |
otc_subscriber_get_session()
| otc_session * otc_subscriber_get_session | ( | const otc_suscriptor * | suscriptor | ) |
Devuelve el otc_session asociada a esta instancia.
Parámetros : | | | | --- | --- | | suscriptor | La instancia del suscriptor. |
Devoluciones
: El otc_session asociado a esta instancia. Puede ser nulo si se produce un error.
otc_subscriber_get_stream()
| otc_stream * otc_subscriber_get_stream | ( | const otc_suscriptor * | suscriptor | ) |
Devuelve el flujo asociado al suscriptor.
Parámetros : | | | | --- | --- | | suscriptor | La instancia del suscriptor de la que se va a obtener el flujo. |
Valores devueltos : El flujo asociado al suscriptor. Puede ser nulo si se produce un error.
otc_subscriber_get_subscribe_to_audio()
| otc_bool otc_subscriber_get_subscribe_to_audio | ( | const otc_suscriptor * | suscriptor | ) |
Devuelve si el suscriptor está suscrito al audio de la transmisión o no.
Parámetros : | | | | --- | --- | | suscriptor | La instancia del suscriptor. |
Devuelve : Si el suscriptor está suscrito al audio de la transmisión o no.
otc_subscriber_get_subscribe_to_captions()
| otc_bool otc_subscriber_get_subscribe_to_captions | ( | const otc_suscriptor * | suscriptor | ) |
Devuelve si el suscriptor está suscrito a los subtítulos de la transmisión o no.
Parámetros : | | | | --- | --- | | suscriptor | La instancia del suscriptor. |
Devuelve
: Si el suscriptor está suscrito a los subtítulos de la transmisión o no. El valor por defecto es el valor de los subtítulos del editor de la transmisión. otc_publisher_get_publish_captions
otc_subscriber_get_subscribe_to_video()
| otc_bool otc_subscriber_get_subscribe_to_video | ( | const otc_suscriptor * | suscriptor | ) |
Devuelve si el suscriptor está suscrito al vídeo de la transmisión o no.
Parámetros : | | | | --- | --- | | suscriptor | La instancia del suscriptor. |
Devuelve : Si el suscriptor está suscrito al canal de vídeo o no.
otc_subscriber_get_subscriber_id()
| const char * otc_subscriber_get_subscriber_id | ( | const otc_suscriptor * | suscriptor | ) |
Obtiene un identificador único para un suscriptor determinado.
Parámetros : | | | | --- | --- | | suscriptor | La instancia del suscriptor. |
Resultados : Un identificador único del suscriptor. Puede ser nulo si se produce un error.
otc_subscriber_get_user_data()
| void * otc_subscriber_get_user_data | ( | const otc_suscriptor * | suscriptor | ) |
Obtiene los datos de usuario de un abonado determinado.
Parámetros : | | | | --- | --- | | suscriptor | La instancia del suscriptor. |
Devuelve : Un puntero a los datos de usuario en memoria.
otc_subscriber_new()
| otc_suscriptor * otc_subscriber_new | ( | const otc_stream * | corriente, |
| const struct otc_subscriber_callbacks * | funciones de devolución de llamada | ||
| ) |
Crea un nuevo suscriptor para una transmisión determinada.
Parámetros : | | | | --- | --- | | stream | El objeto Stream correspondiente al flujo al que te vas a suscribir. | | callbacks | Estructura con punteros a las funciones de las llamadas de retorno del suscriptor. |
Devuelve : La nueva instancia de Subscriber. Puede ser nula si se produce un error.
otc_subscriber_set_audio_volume()
| otc_status otc_subscriber_set_audio_volume | ( | otc_suscriptor * | suscriptor, |
| doble | volumen | ||
| ) |
Establece el volumen de audio del abonado, entre 0 y 100. Si el valor no se encuentra dentro de este intervalo, se ajustará a él.
Parámetros : | | | | --- | --- | | suscriptor | La instancia del suscriptor. | | volumen | El volumen del suscriptor. |
Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
Véase también : otc_error_code
otc_subscriber_set_captions_translation_language()
| otc_status otc_subscriber_set_captions_translation_language | ( | otc_suscriptor * | suscriptor, |
| const char * | idioma | ||
| ) |
Establece el idioma preferido para la traducción de los subtítulos de un suscriptor concreto.
Esta es una función en fase beta privada.
Parámetros : | | | | --- | --- | | suscriptor | La instancia de suscriptor que se verá afectada. | | idioma | Un código de idioma compatible o «null» para desactivar la traducción. |
Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
otc_subscriber_set_preferred_framerate()
| otc_status otc_subscriber_set_preferred_framerate | ( | otc_suscriptor * | suscriptor, |
| flotante | velocidad_preferida | ||
| ) |
Establece la frecuencia de fotogramas preferida para la transmisión del suscriptor.
El valor por defecto es 100.
Parámetros : | | | | --- | --- | | subscriber | La instancia del suscriptor que se verá afectada. | | preferred_framerate | La frecuencia de fotogramas preferida del suscriptor. |
Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
Véase también : otc_error_code
otc_subscriber_set_preferred_resolution()
| otc_status otc_subscriber_set_preferred_resolution | ( | otc_suscriptor * | suscriptor, |
| uint32_t | ancho_preferido, | ||
| uint32_t | altura_preferida | ||
| ) |
Establece la resolución preferida para la transmisión del suscriptor.
Parámetros : | | | | --- | --- | | subscriber | La instancia del suscriptor que se verá afectada. | | preferred_width | El ancho preferido del suscriptor. | | preferred_height | La altura preferida del suscriptor. |
Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
Véase también : otc_error_code
otc_subscriber_set_rtc_stats_report_cb()
| otc_status otc_subscriber_set_rtc_stats_report_cb | ( | otc_suscriptor * | suscriptor, |
| struct otc_subscriber_rtc_stats_report_cb | cb | ||
| ) |
Establece la función de devolución de llamada del informe de estadísticas del RTC para el suscriptor. Véase otc_subscriber_get_rtc_stats_report.
Parámetros : | | | | --- | --- | | subscriber | La instancia del suscriptor. | | cb | El otc_subscriber_rtc_stats_report_cb estructura que incluye la función de devolución de llamada para el informe de estadísticas del RTC. |
otc_subscriber_set_subscribe_to_audio()
| otc_status otc_subscriber_set_subscribe_to_audio | ( | otc_suscriptor * | suscriptor, |
| otc_bool | suscribirse_al_audio | ||
| ) |
Se suscribe al audio de la transmisión.
Parámetros : | | | | --- | --- | | subscriber | La instancia de suscriptor que se verá afectada. | | subscribe_to_audio | Si se desea suscribirse al audio o no. |
Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
otc_subscriber_set_subscribe_to_captions()
| otc_status otc_subscriber_set_subscribe_to_captions | ( | otc_suscriptor * | suscriptor, |
| otc_bool | suscribirse a los subtítulos | ||
| ) |
Activa los subtítulos de la retransmisión.
Parámetros : | | | | --- | --- | | subscriber | La instancia de suscriptor que se verá afectada. | | subscribe_to_captions | Si se desea suscribirse a los subtítulos o no. |
Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
otc_subscriber_set_subscribe_to_video()
| otc_status otc_subscriber_set_subscribe_to_video | ( | otc_suscriptor * | suscriptor, |
| otc_bool | suscribirse_al_vídeo | ||
| ) |
Se suscribe al canal de vídeos.
Parámetros : | | | | --- | --- | | subscriber | La instancia de suscriptor que se verá afectada. | | subscribe_to_video | Si se desea suscribirse al vídeo o no. |
Valores de retorno : Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.