subscriber.h
Este archivo incluye la definición de tipo de un suscriptor de OpenTok, junto con varias declaraciones de funciones.
Estructuras de datos: otc_subscriber_audio_stats, otc_subscriber_video_stats, otc_subscriber_media_link_stats, otc_subscriber_rtc_stats_report_cb, otc_subscriber_callbacks
Incluye: audio_data.h, base.h, config.h, error.h, media_utils.h, stream.h, video_frame.h
typedef otc_subscriber
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.
typedef struct otc_subscriber otc_subscriber;
enumeración otc_subscriber_error_code
Lista de códigos de error para los suscriptores de OpenTok. Esta lista recoge varios códigos de error asociados a un suscriptor.
| Nombre | Valor | Descripción |
|---|---|---|
OTC_SUBSCRIBER_INTERNAL_ERROR |
2000 |
Error interno al suscribirse. |
OTC_SUBSCRIBER_SESSION_DISCONNECTED |
1010 |
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 |
1604 |
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 |
1605 |
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 |
1542 |
Se ha producido un tiempo de espera al intentar suscribirse. |
OTC_SUBSCRIBER_WEBRTC_ERROR |
1600 |
Error de WebRTC del suscriptor. |
OTC_SUBSCRIBER_PEER_CONNECTION_NOT_CONNECTED |
1606 |
La conexión entre pares aún no se ha creado ni se ha establecido. |
OTC_SUBSCRIBER_CAPTIONS_CHANGE_RATE_LIMIT_ERROR |
5010 |
El servidor ha rechazado una solicitud de cambio de subtítulos del suscriptor porque se han realizado demasiadas solicitudes en un breve periodo de tiempo. Se puede volver a intentar la operación en unos segundos. |
OTC_SUBSCRIBER_DECRYPTION_INTERNAL_ERROR |
6002 |
Error interno al descifrar un paquete |
OTC_SUBSCRIBER_ENCRYPTION_SECRET_MISMATCH |
6003 |
Discrepancia secreta al descifrar un paquete |
OTC_SUBSCRIBER_DECRYPTION_UNSUPPORTED_CODEC |
6006 |
Códec multimedia no compatible para el descifrado |
OTC_SUBSCRIBER_ENCRYPTION_NOT_ENABLED |
6007 |
Se ha establecido una clave de cifrado, pero la sesión no se ha configurado con cifrado de extremo a extremo. |
Funciones
| Nombre | Descripción |
|---|---|
otc_subscriber_new(stream, callbacks) → {otc_subscriber *} |
Crea un nuevo suscriptor para una transmisión determinada. |
otc_subscriber_delete(subscriber) → {otc_status} |
Libera una instancia de suscriptor, incluidos todos los recursos de hardware y de interfaz de usuario asociados a ella. |
otc_subscriber_get_stream(subscriber) → {otc_stream *} |
Devuelve el flujo asociado al suscriptor. |
otc_subscriber_set_subscribe_to_video(subscriber, subscribe_to_video) → {otc_status} |
Se suscribe al canal de vídeos. |
otc_subscriber_set_subscribe_to_audio(subscriber, subscribe_to_audio) → {otc_status} |
Se suscribe al audio de la transmisión. |
otc_subscriber_set_subscribe_to_captions(subscriber, subscribe_to_captions) → {otc_status} |
Activa los subtítulos de la retransmisión. |
otc_subscriber_set_captions_translation_language(subscriber, language) → {otc_status} |
Establece el idioma preferido para la traducción de los subtítulos de un suscriptor concreto. |
otc_subscriber_get_captions_translation_language(subscriber) → {const char *} |
Obtiene el idioma de traducción de los subtítulos configurado para un suscriptor determinado. |
otc_subscriber_get_subscribe_to_video(subscriber) → {otc_bool} |
Devuelve si el suscriptor está suscrito al vídeo de la transmisión o no. |
otc_subscriber_get_subscribe_to_audio(subscriber) → {otc_bool} |
Devuelve si el suscriptor está suscrito al audio de la transmisión o no. |
otc_subscriber_get_subscribe_to_captions(subscriber) → {otc_bool} |
Devuelve si el suscriptor está suscrito a los subtítulos de la transmisión o no. |
otc_subscriber_get_session(subscriber) → {otc_session *} |
Devuelve el otc_session asociada a esta instancia. |
otc_subscriber_set_preferred_resolution(subscriber, preferred_width, preferred_height) → {otc_status} |
Establece la resolución preferida para la transmisión del suscriptor. |
otc_subscriber_get_preferred_resolution(subscriber, preferred_width, preferred_height) → {otc_status} |
Devuelve la resolución preferida para la transmisión del suscriptor. |
otc_subscriber_set_audio_volume(subscriber, volume) → {otc_status} |
Establece el volumen de audio del abonado, entre 0 y 100. |
otc_subscriber_get_audio_volume(subscriber, volume) → {otc_status} |
Devuelve el volumen de audio del abonado, en un rango comprendido entre 0 y 100. |
otc_subscriber_set_preferred_framerate(subscriber, preferred_framerate) → {otc_status} |
Establece la frecuencia de fotogramas preferida para la transmisión del suscriptor. |
otc_subscriber_get_preferred_framerate(subscriber, preferred_framerate) → {otc_status} |
Devuelve la frecuencia de fotogramas preferida para la transmisión del suscriptor. |
otc_subscriber_get_subscriber_id(subscriber) → {const char *} |
Obtiene un identificador único para un suscriptor determinado. |
otc_subscriber_get_user_data(subscriber) → {void *} |
Obtiene los datos de usuario de un abonado determinado. |
otc_subscriber_get_rtc_stats_report(subscriber) → {otc_status} |
Obtiene el informe de estadísticas de RTC del suscriptor. |
otc_subscriber_set_rtc_stats_report_cb(subscriber, cb) → {otc_status} |
Establece la función de devolución de llamada del informe de estadísticas de RTC para el suscriptor. |
otc_subscriber_new(stream, callbacks) → {otc_subscriber *}
Crea un nuevo suscriptor para una transmisión determinada.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
const otc_stream * | El objeto `Stream` correspondiente al flujo al que te vas a suscribir. |
callbacks |
const struct otc_subscriber_callbacks * | Estructura con punteros a las funciones de devolución de llamada del suscriptor. |
Devoluciones:
La nueva instancia de «Suscriptor». Puede ser nula si se produce un error.
otc_subscriber_delete(subscriber) → {otc_status}
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:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
otc_subscriber * | El suscriptor que se va a eliminar. |
Devoluciones:
Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
otc_subscriber_get_stream(subscriber) → {otc_stream *}
Devuelve el flujo asociado al suscriptor.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
const otc_subscriber * | La instancia de suscriptor de la que se va a obtener la transmisión. |
Devoluciones:
El flujo asociado al suscriptor. Puede ser nulo si se produce un error.
otc_subscriber_set_subscribe_to_video(subscriber, subscribe_to_video) → {otc_status}
Se suscribe al canal de vídeos.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
otc_subscriber * | La instancia de suscriptor que se verá afectada. |
subscribe_to_video |
otc_bool | Si suscribirse al canal de vídeo o no. |
Devoluciones:
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_audio(subscriber, subscribe_to_audio) → {otc_status}
Se suscribe al audio de la transmisión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
otc_subscriber * | La instancia de suscriptor que se verá afectada. |
subscribe_to_audio |
otc_bool | Si suscribirse o no al canal de audio. |
Devoluciones:
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(subscriber, subscribe_to_captions) → {otc_status}
Activa los subtítulos de la retransmisión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
otc_subscriber * | La instancia de suscriptor que se verá afectada. |
subscribe_to_captions |
otc_bool | Si se desea activar o no los subtítulos. |
Devoluciones:
Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
otc_subscriber_set_captions_translation_language(suscriptor, idioma) → {otc_status}
Establece el idioma preferido para la traducción de los subtítulos de un suscriptor concreto.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
otc_subscriber * | La instancia de suscriptor que se verá afectada. |
language |
const char * | Un código de idioma compatible o el valor «null» para desactivar la traducción. |
Devoluciones:
Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
otc_subscriber_get_captions_translation_language(subscriber) → {const char *}
Obtiene el idioma de traducción de los subtítulos configurado para un suscriptor determinado.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
const otc_subscriber * | La instancia del suscriptor. |
Devoluciones:
El idioma configurado para la traducción. Puede ser nulo si no se ha establecido.
otc_subscriber_get_subscribe_to_video(subscriber) → {otc_bool}
Devuelve si el suscriptor está suscrito al vídeo de la transmisión o no.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
const otc_subscriber * | La instancia del suscriptor. |
Devoluciones:
Si el suscriptor está suscrito al canal de vídeo o no.
otc_subscriber_get_subscribe_to_audio(subscriber) → {otc_bool}
Devuelve si el suscriptor está suscrito al audio de la transmisión o no.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
const otc_subscriber * | La instancia del suscriptor. |
Devoluciones:
Si el suscriptor está suscrito al audio de la transmisión o no.
otc_subscriber_get_subscribe_to_captions(subscriber) → {otc_bool}
Devuelve si el suscriptor está suscrito a los subtítulos de la transmisión o no.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
const otc_subscriber * | La instancia del suscriptor. |
Devoluciones:
Si el suscriptor está suscrito o no a los subtítulos de la transmisión. 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_session(subscriber) → {otc_session *}
Devuelve el otc_session asociada a esta instancia.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
const otc_subscriber * | La instancia del suscriptor. |
Devoluciones:
El otc_session asociado a esta instancia. Puede ser nulo si se produce un error.
otc_subscriber_set_preferred_resolution(subscriber, preferred_width, preferred_height) → {otc_status}
Establece la resolución preferida para la transmisión del suscriptor.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
otc_subscriber * | La instancia de suscriptor que se verá afectada. |
preferred_width |
uint32_t | El ancho que prefiere el abonado. |
preferred_height |
uint32_t | La altura que prefiere el abonado. |
Véase: : - otc_error_code
Devoluciones:
Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
otc_subscriber_get_preferred_resolution(subscriber, preferred_width, preferred_height) → {otc_status}
Devuelve la resolución preferida para la transmisión del suscriptor.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
const otc_subscriber * | La instancia del suscriptor. |
preferred_width |
uint32_t * | El ancho que prefiere el abonado. |
preferred_height |
uint32_t * | La altura que prefiere el abonado. |
Véase: : - otc_error_code
Devoluciones:
Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
otc_subscriber_set_audio_volume(subscriber, volume) → {otc_status}
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:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
otc_subscriber * | La instancia del suscriptor. |
volume |
doble | El volumen del abonado. |
Véase: : - otc_error_code
Devoluciones:
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(subscriber, volume) → {otc_status}
Devuelve el volumen de audio del abonado, en un rango comprendido entre 0 y 100.
El valor por defecto es 100.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
const otc_subscriber * | La instancia del suscriptor. |
volume |
doble * | El volumen del abonado. |
Véase: : - otc_error_code
Devoluciones:
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(subscriber, preferred_framerate) → {otc_status}
Establece la frecuencia de fotogramas preferida para la transmisión del suscriptor.
El valor por defecto es 100.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
otc_subscriber * | La instancia de suscriptor que se verá afectada. |
preferred_framerate |
flotante | La frecuencia de fotogramas preferida por el suscriptor. |
Véase: : - otc_error_code
Devoluciones:
Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
otc_subscriber_get_preferred_framerate(subscriber, preferred_framerate) → {otc_status}
Devuelve la frecuencia de fotogramas preferida para la transmisión del suscriptor.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
const otc_subscriber * | La instancia del suscriptor. |
preferred_framerate |
float * | La frecuencia de fotogramas preferida asociada al suscriptor. |
Véase: : - otc_error_code
Devoluciones:
Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
otc_subscriber_get_subscriber_id(subscriber) → {const char *}
Obtiene un identificador único para un suscriptor determinado.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
const otc_subscriber * | La instancia del suscriptor. |
Devoluciones:
Un identificador único del abonado. Puede ser nulo si se produce un error.
otc_subscriber_get_user_data(subscriber) → {void *}
Obtiene los datos de usuario de un abonado determinado.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
const otc_subscriber * | La instancia del suscriptor. |
Devoluciones:
Un puntero a los datos del usuario en memoria.
otc_subscriber_get_rtc_stats_report(subscriber) → {otc_status}
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:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
otc_subscriber * | El suscriptor. |
Devoluciones:
otc_status
otc_subscriber_set_rtc_stats_report_cb(subscriber, cb) → {otc_status}
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:
| Nombre | Tipo | Descripción |
|---|---|---|
subscriber |
otc_subscriber * | La instancia del suscriptor. |
cb |
struct otc_subscriber_rtc_stats_report_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. |
Devoluciones:
otc_status