Audio/Video stream. More...
#include "config.h"
#include "connection.h"
Typedefs | |
typedef struct otc_stream | otc_stream |
Enumerations | |
enum | otc_stream_video_type { OTC_STREAM_VIDEO_TYPE_CAMERA = 1, OTC_STREAM_VIDEO_TYPE_SCREEN, OTC_STREAM_VIDEO_TYPE_CUSTOM = 3 } |
Functions | |
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) |
Audio/Video stream.
This file includes the type definition for an audio-video stream along with several function declarations useful when handling it.
typedef struct otc_stream otc_stream |
Type definition for a struct representing an audio-video stream in an OpenTok session.
otc_stream* otc_stream_copy | ( | const otc_stream * | stream | ) |
Makes a copy of a stream.
stream | The stream to be copied. |
otc_status otc_stream_delete | ( | otc_stream * | stream | ) |
Releases resources associated with the stream.
stream | The stream being queried. |
const otc_connection* otc_stream_get_connection | ( | const otc_stream * | stream | ) |
Get the connection associated with the client publishing the stream.
stream | The stream being queried. |
int64_t otc_stream_get_creation_time | ( | const otc_stream * | stream | ) |
Gets the creation time of the stream.
stream | The stream being queried. |
const char* otc_stream_get_id | ( | const otc_stream * | stream | ) |
Gets the unique identifier for this stream.
stream | The stream. |
const char* otc_stream_get_name | ( | const otc_stream * | stream | ) |
Gets the name of the stream. The publisher of the stream can set this name to identify the stream.
stream | The stream being queried. |
int otc_stream_get_video_height | ( | const otc_stream * | stream | ) |
Returns the height, in pixels, of the video stream.
stream | The stream being queried. |
enum otc_stream_video_type otc_stream_get_video_type | ( | const otc_stream * | stream | ) |
Returns the video type of the stream.
stream | The stream being queried. |
int otc_stream_get_video_width | ( | const otc_stream * | stream | ) |
Returns the width, in pixels, of the video stream.
stream | The stream being queried. |
otc_bool otc_stream_has_audio | ( | const otc_stream * | stream | ) |
Checks whether this stream is currently publishing audio or not.
stream | The stream being queried. |
otc_bool otc_stream_has_audio_track | ( | const otc_stream * | stream | ) |
Checks whether this stream contains an audio track or not.
stream | The stream being queried. |
otc_bool otc_stream_has_captions | ( | const otc_stream * | stream | ) |
Checks whether this stream is currently publishing captions or not.
stream | The stream being queried. |
otc_bool otc_stream_has_video | ( | const otc_stream * | stream | ) |
Checks whether this stream is currently publishing video or not.
stream | The stream being queried. |
otc_bool otc_stream_has_video_track | ( | const otc_stream * | stream | ) |
Checks whether this stream contains a video track or not.
stream | The stream being queried. |