Transmisión de audio y vídeo. Más...

#include "config.h" #include "connection.h"
Definiciones de tipos
typedef struct otc_stream otc_stream
Funciones
const char * otc_stream_get_id (const otc_stream *stream)
const char * otc_stream_get_name (const otc_stream *stream)
otc_bool otc_stream_has_video_track (const otc_stream *stream)
otc_bool otc_stream_has_video (const otc_stream *stream)
otc_bool otc_stream_has_audio_track (const otc_stream *stream)
otc_bool otc_stream_has_audio (const otc_stream *stream)
otc_bool otc_stream_has_captions (const otc_stream *stream)
otc_stream * otc_stream_copy (const otc_stream *stream)
otc_status otc_stream_delete (otc_stream *stream)
int otc_stream_get_video_width (const otc_stream *stream)
int otc_stream_get_video_height (const otc_stream *stream)
int64_t otc_stream_get_creation_time (const otc_stream *stream)
enum otc_stream_video_type otc_stream_get_video_type (const otc_stream *stream)
const otc_connection * otc_stream_get_connection (const otc_stream *stream)

Descripción detallada

Transmisión de audio y vídeo.

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.

Documentación sobre `typedef`

otc_stream
typedef struct otc_stream otc_stream

Definición de tipo para una estructura que representa un flujo de audio y vídeo en una sesión de OpenTok.

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

Encuestador
OTC_STREAM_VIDEO_TYPE_CAMERA Transmisión de vídeo de la cámara.
OTC_STREAM_VIDEO_TYPE_SCREEN Transmisión de vídeo de pantalla. Se utiliza para compartir la pantalla.
OTC_STREAM_VIDEO_TYPE_CUSTOM Transmisión de vídeo personalizada.

Documentación de funciones

otc_stream_copy()
otc_stream * otc_stream_copy ( const otc_stream * corriente )

Crea una copia de un flujo.

Parámetros : | | | | --- | --- | | stream | El flujo que se va a copiar. |

Devuelve : Una copia del flujo. Puede ser nulo si se produce un error.

otc_stream_delete()
otc_status otc_stream_delete ( otc_stream * corriente )

Libera los recursos asociados al flujo.

Parámetros : | | | | --- | --- | | stream | El flujo sobre el que se realiza la consulta. |

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

otc_stream_get_connection()
const otc_connection * otc_stream_get_connection ( const otc_stream * corriente )

Obtén la conexión asociada al cliente que está publicando la transmisión.

Parámetros : | | | | --- | --- | | stream | El flujo sobre el que se realiza la consulta. |

Devuelve : La conexión asociada al cliente que publica el flujo.

otc_stream_get_creation_time()
int64_t otc_stream_get_creation_time ( const otc_stream * corriente )

Obtiene la hora de creación del flujo.

Parámetros : | | | | --- | --- | | stream | El flujo sobre el que se realiza la consulta. |

Devuelve : La marca de tiempo correspondiente a la hora de creación del flujo.

otc_stream_get_id()
const char * otc_stream_get_id ( const otc_stream * corriente )

Obtiene el identificador único de este flujo.

Parámetros : | | | | --- | --- | | stream | El flujo. |

Valores devueltos : El identificador único de este flujo.

otc_stream_get_name()
const char * otc_stream_get_name ( const otc_stream * corriente )

Obtiene el nombre del flujo. El editor del flujo puede establecer este nombre para identificar el flujo.

Parámetros : | | | | --- | --- | | stream | El flujo sobre el que se realiza la consulta. |

Devuelve : El nombre del flujo.

otc_stream_get_video_height()
int otc_stream_get_video_height ( const otc_stream * corriente )

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 : | | | | --- | --- | | stream | El flujo sobre el que se realiza la consulta. |

Devuelve : La altura, en píxeles, de la resolución de destino del capturador del editor.

otc_stream_get_video_type()
enum otc_stream_video_type otc_stream_get_video_type ( const otc_stream * corriente )

Devuelve el tipo de vídeo de la transmisión.

Parámetros : | | | | --- | --- | | stream | El flujo sobre el que se realiza la consulta. |

Devuelve : El tipo de vídeo de la transmisión.

Véase también : otc_stream_video_type

otc_stream_get_video_width()
int otc_stream_get_video_width ( const otc_stream * corriente )

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 : | | | | --- | --- | | stream | El flujo sobre el que se realiza la consulta. |

Devuelve : El ancho, en píxeles, de la resolución de destino del capturador del editor.

otc_stream_has_audio()
otc_bool otc_stream_has_audio ( const otc_stream * corriente )

Comprueba si esta transmisión está emitiendo audio en este momento o no.

Parámetros : | | | | --- | --- | | stream | El flujo sobre el que se realiza la consulta. |

Retorna : Valor de retorno que indica si este flujo está emitiendo audio o no.

otc_stream_has_audio_track()
otc_bool otc_stream_has_audio_track ( const otc_stream * corriente )

Comprueba si este flujo contiene una pista de audio o no.

Parámetros : | | | | --- | --- | | stream | El flujo sobre el que se realiza la consulta. |

Valores de retorno : Valor de retorno que indica si este flujo contiene una pista de audio o no.

otc_stream_has_captions()
otc_bool otc_stream_has_captions ( const otc_stream * corriente )

Comprueba si esta transmisión está publicando subtítulos en este momento o no.

Parámetros : | | | | --- | --- | | stream | El flujo sobre el que se realiza la consulta. |

Valores devueltos : Valor devuelto que indica si este flujo está publicando subtítulos o no.

otc_stream_has_video()
otc_bool otc_stream_has_video ( const otc_stream * corriente )

Comprueba si esta transmisión está emitiendo vídeo en este momento o no.

Parámetros : | | | | --- | --- | | stream | El flujo sobre el que se realiza la consulta. |

Retornos : Valor de retorno que indica si este flujo está publicando vídeo o no.

otc_stream_has_video_track()
otc_bool otc_stream_has_video_track ( const otc_stream * corriente )

Comprueba si este flujo contiene una pista de vídeo o no.

Parámetros : | | | | --- | --- | | stream | El flujo sobre el que se realiza la consulta. |

Valores de retorno : Valor de retorno que indica si este flujo contiene una pista de vídeo o no.