Flux audio/vidéo. En savoir plus...
#include "config.h"
#include "connection.h"
| Définitions de types | |
| typedef struct otc_stream | otc_stream |
| Énumérations | |
| énumération | otc_stream_video_type { OTC_STREAM_VIDEO_TYPE_CAMERA = 1, OTC_STREAM_VIDEO_TYPE_SCREEN , OTC_STREAM_VIDEO_TYPE_CUSTOM = 3 } |
| Fonctions | |
| 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) |
| énumération otc_stream_video_type | otc_stream_get_video_type (const otc_stream *stream) |
| const otc_connection * | otc_stream_get_connection (const otc_stream *stream) |
Description détaillée
Flux audio/vidéo.
Ce fichier contient la définition de type d'un flux audio-vidéo ainsi que plusieurs déclarations de fonctions utiles pour le manipuler.
Documentation sur `typedef`
otc_stream
| typedef struct otc_stream otc_stream |
Définition de type pour une structure représentant un flux audio-vidéo dans une session OpenTok.
Documentation sur les types d'énumération
otc_stream_video_type
| énumération otc_stream_video_type |
Énumération des types de flux vidéo.
Cette liste répertorie les différents types de flux vidéo pris en charge.
| Recenseur | |
|---|---|
| OTC_STREAM_VIDEO_TYPE_CAMERA | Flux vidéo de la caméra. |
| OTC_STREAM_VIDEO_TYPE_SCREEN | Flux vidéo de l'écran. Cette fonction sert au partage d'écran. |
| OTC_STREAM_VIDEO_TYPE_CUSTOM | Flux vidéo personnalisé. |
Documentation des fonctions
otc_stream_copy()
| otc_stream * otc_stream_copy | ( | const otc_stream * | flux | ) |
Crée une copie d'un flux.
Paramètres : | | | | --- | --- | | stream | Le flux à copier. |
Retourne : Une copie du flux. Cette valeur peut être nulle en cas d'erreur.
otc_stream_delete()
| otc_status otc_stream_delete | ( | otc_stream * | flux | ) |
Libère les ressources associées au flux.
Paramètres : | | | | --- | --- | | flux | Le flux sur lequel porte la requête. |
Valeurs de retour : Valeur de retour indiquant soit une erreur, soit une réussite.
otc_stream_get_connection()
| const otc_connection * otc_stream_get_connection | ( | const otc_stream * | flux | ) |
Récupérer la connexion associée au client qui diffuse le flux.
Paramètres : | | | | --- | --- | | flux | Le flux sur lequel porte la requête. |
Retourne : La connexion associée au client qui diffuse le flux.
otc_stream_get_creation_time()
| int64_t otc_stream_get_creation_time | ( | const otc_stream * | flux | ) |
Récupère l'heure de création du flux.
Paramètres : | | | | --- | --- | | flux | Le flux sur lequel porte la requête. |
Valeurs renvoyées : L'horodatage correspondant à l'heure de création du flux.
otc_stream_get_id()
| const char * otc_stream_get_id | ( | const otc_stream * | flux | ) |
Récupère l'identifiant unique de ce flux.
Paramètres : | | | | --- | --- | | stream | Le flux. |
Valeurs de retour : L'identifiant unique de ce flux.
otc_stream_get_name()
| const char * otc_stream_get_name | ( | const otc_stream * | flux | ) |
Récupère le nom du flux. L'éditeur du flux peut définir ce nom afin d'identifier le flux.
Paramètres : | | | | --- | --- | | flux | Le flux sur lequel porte la requête. |
Valeurs de retour : Le nom du flux.
otc_stream_get_video_height()
| int otc_stream_get_video_height | ( | const otc_stream * | flux | ) |
Renvoie la hauteur, en pixels, du flux vidéo.
Paramètres : | | | | --- | --- | | flux | Le flux sur lequel porte la requête. |
Renvoie : La hauteur, en pixels, du flux vidéo.
otc_stream_get_video_type()
| énumération otc_stream_video_type otc_stream_get_video_type | ( | const otc_stream * | flux | ) |
Renvoie le type de vidéo du flux.
Paramètres : | | | | --- | --- | | flux | Le flux sur lequel porte la requête. |
Valeurs de retour : Le type vidéo du flux.
Voir aussi : otc_stream_video_type
otc_stream_get_video_width()
| int otc_stream_get_video_width | ( | const otc_stream * | flux | ) |
Renvoie la largeur, en pixels, du flux vidéo.
Paramètres : | | | | --- | --- | | flux | Le flux sur lequel porte la requête. |
Renvoie : La largeur, en pixels, du flux vidéo.
otc_stream_has_audio()
| otc_bool otc_stream_has_audio | ( | const otc_stream * | flux | ) |
Vérifie si ce flux diffuse actuellement du son ou non.
Paramètres : | | | | --- | --- | | flux | Le flux sur lequel porte la requête. |
Retour : Valeur de retour indiquant si ce flux diffuse du son ou non.
otc_stream_has_audio_track()
| otc_bool otc_stream_has_audio_track | ( | const otc_stream * | flux | ) |
Vérifie si ce flux contient une piste audio ou non.
Paramètres : | | | | --- | --- | | flux | Le flux sur lequel porte la requête. |
Retour : Valeur de retour indiquant si ce flux contient ou non une piste audio.
otc_stream_has_captions()
| otc_bool otc_stream_has_captions | ( | const otc_stream * | flux | ) |
Vérifie si ce flux diffuse actuellement des sous-titres ou non.
Paramètres : | | | | --- | --- | | flux | Le flux sur lequel porte la requête. |
Valeurs de retour : Valeur de retour indiquant si ce flux publie ou non des sous-titres.
otc_stream_has_video()
| otc_bool otc_stream_has_video | ( | const otc_stream * | flux | ) |
Vérifie si ce flux diffuse actuellement une vidéo ou non.
Paramètres : | | | | --- | --- | | flux | Le flux sur lequel porte la requête. |
Retour : Valeur de retour indiquant si ce flux diffuse de la vidéo ou non.
otc_stream_has_video_track()
| otc_bool otc_stream_has_video_track | ( | const otc_stream * | flux | ) |
Vérifie si ce flux contient une piste vidéo ou non.
Paramètres : | | | | --- | --- | | flux | Le flux sur lequel porte la requête. |
Valeurs de retour : Valeur de retour indiquant si ce flux contient ou non une piste vidéo.