stream.h
Este archivo incluye la definición del tipo de un flujo de audio y vídeo, junto con varias declaraciones de funciones útiles para su manejo.
Incluye: config.h, connection.h
typedef otc_stream
Definición de tipo para una estructura que representa un flujo de audio y vídeo en una sesión de OpenTok.
typedef struct otc_stream otc_stream;
enumeración otc_stream_video_type
Enumeración de tipos de vídeo en streaming.
Esta lista recoge los distintos tipos de vídeo en streaming compatibles.
| Nombre | Valor | Descripción |
|---|---|---|
OTC_STREAM_VIDEO_TYPE_CAMERA |
1 |
Transmisión de vídeo de la cámara. |
OTC_STREAM_VIDEO_TYPE_SCREEN |
2 |
Transmisión de vídeo de pantalla. Se utiliza para compartir la pantalla. |
OTC_STREAM_VIDEO_TYPE_CUSTOM |
3 |
Transmisión de vídeo personalizada. |
Funciones
| Nombre | Descripción |
|---|---|
otc_stream_get_id(stream) → {const char *} |
Obtiene el identificador único de este flujo. |
otc_stream_get_name(stream) → {const char *} |
Obtiene el nombre del flujo. |
otc_stream_has_video_track(stream) → {otc_bool} |
Comprueba si este flujo contiene una pista de vídeo o no. |
otc_stream_has_video(stream) → {otc_bool} |
Comprueba si esta transmisión está emitiendo vídeo en este momento o no. |
otc_stream_has_audio_track(stream) → {otc_bool} |
Comprueba si este flujo contiene una pista de audio o no. |
otc_stream_has_audio(stream) → {otc_bool} |
Comprueba si esta transmisión está emitiendo audio en este momento o no. |
otc_stream_has_captions(stream) → {otc_bool} |
Comprueba si esta transmisión está publicando subtítulos en este momento o no. |
otc_stream_copy(stream) → {otc_stream *} |
Crea una copia de un flujo. |
otc_stream_delete(stream) → {otc_status} |
Libera los recursos asociados al flujo. |
otc_stream_get_video_width(stream) → {int} |
Devuelve el ancho de la resolución de destino del capturador del editor, en píxeles, tal y como se ha indicado por última vez a la sesión. |
otc_stream_get_video_height(stream) → {int} |
Devuelve la altura de la resolución de destino del capturador del editor, en píxeles, tal y como se ha comunicado por última vez a la sesión. |
otc_stream_get_creation_time(stream) → {int64_t} |
Obtiene la hora de creación del flujo. |
otc_stream_get_video_type(stream) → {enum otc_stream_video_type} |
Devuelve el tipo de vídeo de la transmisión. |
otc_stream_get_connection(stream) → {const otc_connection *} |
Obtén la conexión asociada al cliente que está publicando la transmisión. |
otc_stream_get_id(stream) → {const char *}
Obtiene el identificador único de este flujo.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
const otc_stream * | El arroyo. |
Devoluciones:
El identificador único de este flujo.
otc_stream_get_name(stream) → {const char *}
Obtiene el nombre del flujo. El editor del flujo puede establecer este nombre para identificar el flujo.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
const otc_stream * | El flujo objeto de la consulta. |
Devoluciones:
El nombre del flujo.
otc_stream_has_video_track(stream) → {otc_bool}
Comprueba si este flujo contiene una pista de vídeo o no.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
const otc_stream * | El flujo objeto de la consulta. |
Devoluciones:
Valor de retorno que indica si este flujo contiene una pista de vídeo o no.
otc_stream_has_video(stream) → {otc_bool}
Comprueba si esta transmisión está emitiendo vídeo en este momento o no.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
const otc_stream * | El flujo objeto de la consulta. |
Devoluciones:
Valor de retorno que indica si este flujo está publicando vídeo o no.
otc_stream_has_audio_track(stream) → {otc_bool}
Comprueba si este flujo contiene una pista de audio o no.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
const otc_stream * | El flujo objeto de la consulta. |
Devoluciones:
Valor de retorno que indica si este flujo contiene una pista de audio o no.
otc_stream_has_audio(stream) → {otc_bool}
Comprueba si esta transmisión está emitiendo audio en este momento o no.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
const otc_stream * | El flujo objeto de la consulta. |
Devoluciones:
Valor de retorno que indica si este flujo está emitiendo audio o no.
otc_stream_has_captions(stream) → {otc_bool}
Comprueba si esta transmisión está publicando subtítulos en este momento o no.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
const otc_stream * | El flujo objeto de la consulta. |
Devoluciones:
Valor de retorno que indica si este flujo está publicando subtítulos o no.
otc_stream_copy(stream) → {otc_stream *}
Crea una copia de un flujo.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
const otc_stream * | El flujo que se va a copiar. |
Devoluciones:
Una copia del flujo. Puede ser nulo si se produce un error.
otc_stream_delete(stream) → {otc_status}
Libera los recursos asociados al flujo.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
otc_stream * | El flujo objeto de la consulta. |
Devoluciones:
Valor de retorno que indica si se ha producido un error o si la operación se ha realizado correctamente.
otc_stream_get_video_width(stream) → {int}
Devuelve la anchura de la resolución de destino del capturador del editor, en píxeles, tal y como se ha comunicado por última vez a la sesión. Este valor se transmite a todos los participantes de la sesión y puede consultarse tanto en los clientes editores como en los suscriptores.
Nota: Este valor corresponde a la resolución de destino de la captura del editor, no a la resolución realmente codificada o recibida por un suscriptor. El editor puede codificar a una resolución inferior debido a limitaciones de ancho de banda o de CPU. En el caso de las transmisiones publicadas mediante la función de vídeo escalable, este valor se establece en la anchura de la resolución máxima disponible para la transmisión. Para obtener más información sobre el vídeo escalable, consulta la documentación de la OpenTok Media Router.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
const otc_stream * | El flujo objeto de la consulta. |
Devoluciones:
El ancho, en píxeles, de la resolución de destino del capturador del editor.
otc_stream_get_video_height(stream) → {int}
Devuelve la altura de la resolución de destino del capturador del editor, en píxeles, tal y como se ha comunicado por última vez a la sesión. Este valor se transmite a todos los participantes de la sesión y puede consultarse tanto en los clientes editores como en los suscriptores.
Nota: Este valor corresponde a la resolución de captura prevista por el editor, no a la resolución realmente codificada o recibida por un suscriptor. El editor puede codificar a una resolución inferior debido a limitaciones de ancho de banda o de CPU.
En el caso de las transmisiones publicadas mediante la función de vídeo escalable, este valor se establece en la altura de la resolución máxima disponible para la transmisión. Para obtener más información sobre el vídeo escalable, consulta la documentación de la OpenTok Media Router.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
const otc_stream * | El flujo objeto de la consulta. |
Devoluciones:
La altura, en píxeles, de la resolución de destino del capturador del editor.
otc_stream_get_creation_time(stream) → {int64_t}
Obtiene la hora de creación del flujo.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
const otc_stream * | El flujo objeto de la consulta. |
Devoluciones:
La marca de tiempo correspondiente a la fecha de creación de la secuencia.
otc_stream_get_video_type(stream) → {enum otc_stream_video_type}
Devuelve el tipo de vídeo de la transmisión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
const otc_stream * | El flujo objeto de la consulta. |
Véase: : - otc_stream_video_type
Devoluciones:
El tipo de vídeo de la transmisión.
otc_stream_get_connection(stream) → {const otc_connection *}
Obtén la conexión asociada al cliente que está publicando la transmisión.
Parámetros:
| Nombre | Tipo | Descripción |
|---|---|---|
stream |
const otc_stream * | El flujo objeto de la consulta. |
Devoluciones:
La conexión asociada al cliente que publica la transmisión.