subscriber.h

Ce fichier contient la définition de type d'un abonné OpenTok ainsi que plusieurs déclarations de fonctions.

Structures de données : statistiques_audio_abonnés_otc, otc_subscriber_video_stats, statistiques-sur-les-liens-multimédia-des-abonnés-otc, otc_subscriber_rtc_stats_report_cb, otc_subscriber_callbacks

Comprend : audio_data.h, base.h, config.h, error.h, media_utils.h, stream.h, video_frame.h

typedef otc_subscriber

Définition des types d'abonnés OpenTok.

Type représentant le destinataire du flux audio et vidéo d'une session OpenTok.

typedef struct otc_subscriber otc_subscriber;

énumération otc_subscriber_error_code

Liste des codes d'erreur pour les abonnés OpenTok. Cette liste répertorie plusieurs codes d'erreur associés à un abonné.

Nom Valeur Description
OTC_SUBSCRIBER_INTERNAL_ERROR 2000 Erreur interne lors de l'abonnement.
OTC_SUBSCRIBER_SESSION_DISCONNECTED 1010 Vous essayez de vous abonner à un flux dans une session dont vous vous êtes déconnecté.
OTC_SUBSCRIBER_SERVER_CANNOT_FIND_STREAM 1604 L'abonnement a échoué car le flux est manquant. Cela peut se produire si l'abonnement est créé au moment même où le flux est supprimé de la session.
OTC_SUBSCRIBER_STREAM_LIMIT_EXCEEDED 1605 Le client a tenté de s'abonner à un flux alors que la session avait déjà dépassé la limite du nombre de flux simultanés.
OTC_SUBSCRIBER_TIMED_OUT 1542 Dépassement du délai d'attente lors de la tentative d'abonnement.
OTC_SUBSCRIBER_WEBRTC_ERROR 1600 Échec de la connexion WebRTC de l'abonné.
OTC_SUBSCRIBER_PEER_CONNECTION_NOT_CONNECTED 1606 La connexion entre pairs n'est pas encore établie.
OTC_SUBSCRIBER_CAPTIONS_CHANGE_RATE_LIMIT_ERROR 5010 Le serveur a rejeté une demande de modification des sous-titres pour l'abonné, car trop de demandes ont été effectuées en peu de temps. Vous pouvez réessayer dans quelques secondes.
OTC_SUBSCRIBER_DECRYPTION_INTERNAL_ERROR 6002 Erreur interne lors du déchiffrement d'un paquet
OTC_SUBSCRIBER_ENCRYPTION_SECRET_MISMATCH 6003 Incohérence secrète lors du déchiffrement d'un paquet
OTC_SUBSCRIBER_DECRYPTION_UNSUPPORTED_CODEC 6006 Codec multimédia non pris en charge pour le décryptage
OTC_SUBSCRIBER_ENCRYPTION_NOT_ENABLED 6007 Un secret de chiffrement a été défini, mais la session n'a pas été configurée pour un chiffrement de bout en bout.

Fonctions

Nom Description
otc_subscriber_new(stream, callbacks) → {otc_subscriber *} Crée un nouvel abonné pour un flux donné.
otc_subscriber_delete(subscriber) → {otc_status} Libère une instance d'abonné, y compris toutes les ressources matérielles et d'interface utilisateur qui y sont associées.
otc_subscriber_get_stream(subscriber) → {otc_stream *} Renvoie le flux associé à l'abonné.
otc_subscriber_set_subscribe_to_video(subscriber, subscribe_to_video) → {otc_status} S'abonne à la chaîne vidéo.
otc_subscriber_set_subscribe_to_audio(subscriber, subscribe_to_audio) → {otc_status} S'abonne au flux audio.
otc_subscriber_set_subscribe_to_captions(subscriber, subscribe_to_captions) → {otc_status} S'abonne aux sous-titres de la diffusion.
otc_subscriber_set_captions_translation_language(subscriber, language) → {otc_status} Définit la langue de traduction des sous-titres par défaut pour un abonné donné.
otc_subscriber_get_captions_translation_language(subscriber) → {const char *} Récupère la langue de traduction des sous-titres configurée pour un abonné donné.
otc_subscriber_get_subscribe_to_video(subscriber) → {otc_bool} Indique si l'abonné est abonné à la vidéo du flux ou non.
otc_subscriber_get_subscribe_to_audio(subscriber) → {otc_bool} Indique si l'abonné est abonné ou non au flux audio.
otc_subscriber_get_subscribe_to_captions(subscriber) → {otc_bool} Indique si l'abonné est abonné ou non aux sous-titres du flux.
otc_subscriber_get_session(subscriber) → {otc_session *} Renvoie le otc_session associée à cette instance.
otc_subscriber_set_preferred_resolution(subscriber, preferred_width, preferred_height) → {otc_status} Définit la résolution préférée pour le flux de l'abonné.
otc_subscriber_get_preferred_resolution(subscriber, preferred_width, preferred_height) → {otc_status} Renvoie la résolution préférée pour le flux de l'abonné.
otc_subscriber_set_audio_volume(subscriber, volume) → {otc_status} Permet de régler le volume audio de l'abonné, entre 0 et 100.
otc_subscriber_get_audio_volume(subscriber, volume) → {otc_status} Renvoie le volume audio de l'abonné, compris entre 0 et 100.
otc_subscriber_set_preferred_framerate(subscriber, preferred_framerate) → {otc_status} Définit la fréquence d'images souhaitée pour le flux de l'abonné.
otc_subscriber_get_preferred_framerate(subscriber, preferred_framerate) → {otc_status} Renvoie la fréquence d'images souhaitée pour le flux de l'abonné.
otc_subscriber_get_subscriber_id(subscriber) → {const char *} Récupère l'identifiant unique d'un abonné donné.
otc_subscriber_get_user_data(subscriber) → {void *} Récupère les données utilisateur d'un abonné donné.
otc_subscriber_get_rtc_stats_report(subscriber) → {otc_status} Récupère le rapport statistique RTC de l'abonné.
otc_subscriber_set_rtc_stats_report_cb(subscriber, cb) → {otc_status} Définit la fonction de rappel pour le rapport statistique RTC de l'abonné.

otc_subscriber_new(stream, callbacks) → {otc_subscriber *}

Crée un nouvel abonné pour un flux donné.

Paramètres :
Nom Type Description
stream const otc_stream * L'objet `Stream` correspondant au flux auquel vous allez vous abonner.
callbacks const struct otc_subscriber_callbacks * Structure contenant les pointeurs vers les fonctions de rappel de l'abonné.
Retours :

La nouvelle instance « Subscriber ». Cette valeur peut être nulle en cas d'erreur.

otc_subscriber_delete(subscriber) → {otc_status}

Libère une instance d'abonné, y compris toutes les ressources matérielles et d'interface utilisateur qui lui sont associées. Aucun rappel dans otc_subscriber_callbacks sera appelée à la suite de l'appel de cette méthode (ou par la suite).

Paramètres :
Nom Type Description
subscriber otc_subscriber * L'abonné à supprimer.
Retours :

Valeur de retour indiquant soit une erreur, soit une réussite.

otc_subscriber_get_stream(subscriber) → {otc_stream *}

Renvoie le flux associé à l'abonné.

Paramètres :
Nom Type Description
subscriber const otc_subscriber * L'instance d'abonné à partir de laquelle récupérer le flux.
Retours :

Le flux associé à l'abonné. Cette valeur peut être nulle en cas d'erreur.

otc_subscriber_set_subscribe_to_video(subscriber, subscribe_to_video) → {otc_status}

S'abonne à la chaîne vidéo.

Paramètres :
Nom Type Description
subscriber otc_subscriber * L'instance d'abonné qui sera concernée.
subscribe_to_video otc_bool Faut-il s'abonner à la chaîne vidéo ou non ?
Retours :

Valeur de retour indiquant soit une erreur, soit une réussite.

otc_subscriber_set_subscribe_to_audio(subscriber, subscribe_to_audio) → {otc_status}

S'abonne au flux audio.

Paramètres :
Nom Type Description
subscriber otc_subscriber * L'instance d'abonné qui sera concernée.
subscribe_to_audio otc_bool Faut-il s'abonner au flux audio ou non ?
Retours :

Valeur de retour indiquant soit une erreur, soit une réussite.

otc_subscriber_set_subscribe_to_captions(subscriber, subscribe_to_captions) → {otc_status}

S'abonne aux sous-titres de la diffusion.

Paramètres :
Nom Type Description
subscriber otc_subscriber * L'instance d'abonné qui sera concernée.
subscribe_to_captions otc_bool S'abonner ou non aux sous-titres.
Retours :

Valeur de retour indiquant soit une erreur, soit une réussite.

otc_subscriber_set_captions_translation_language(subscriber, language) → {otc_status}

Définit la langue de traduction des sous-titres par défaut pour un abonné donné.

Paramètres :
Nom Type Description
subscriber otc_subscriber * L'instance d'abonné qui sera concernée.
language const char * Un code de langue pris en charge ou la valeur « null » pour désactiver la traduction.
Retours :

Valeur de retour indiquant soit une erreur, soit une réussite.

otc_subscriber_get_captions_translation_language(subscriber) → {const char *}

Récupère la langue de traduction des sous-titres configurée pour un abonné donné.

Paramètres :
Nom Type Description
subscriber const otc_subscriber * L'instance de l'abonné.
Retours :

Langue configurée pour la traduction. Elle peut être nulle si elle n'est pas définie.

otc_subscriber_get_subscribe_to_video(subscriber) → {otc_bool}

Indique si l'abonné est abonné à la vidéo du flux ou non.

Paramètres :
Nom Type Description
subscriber const otc_subscriber * L'instance de l'abonné.
Retours :

Que l'abonné soit abonné ou non à la chaîne vidéo.

otc_subscriber_get_subscribe_to_audio(subscriber) → {otc_bool}

Indique si l'abonné est abonné ou non au flux audio.

Paramètres :
Nom Type Description
subscriber const otc_subscriber * L'instance de l'abonné.
Retours :

Que l'abonné soit abonné ou non au flux audio.

otc_subscriber_get_subscribe_to_captions(subscriber) → {otc_bool}

Indique si l'abonné est abonné ou non aux sous-titres du flux.

Paramètres :
Nom Type Description
subscriber const otc_subscriber * L'instance de l'abonné.
Retours :

Si l'abonné est abonné ou non aux sous-titres du flux. La valeur par défaut correspond à la valeur des sous-titres définie par l'éditeur du flux. otc_publisher_get_publish_captions

otc_subscriber_get_session(subscriber) → {otc_session *}

Renvoie le otc_session associée à cette instance.

Paramètres :
Nom Type Description
subscriber const otc_subscriber * L'instance de l'abonné.
Retours :

Les otc_session associée à cette instance. Cette valeur peut être nulle en cas d'erreur.

otc_subscriber_set_preferred_resolution(subscriber, preferred_width, preferred_height) → {otc_status}

Définit la résolution préférée pour le flux de l'abonné.

Paramètres :
Nom Type Description
subscriber otc_subscriber * L'instance d'abonné qui sera concernée.
preferred_width uint32_t La largeur souhaitée par l'abonné.
preferred_height uint32_t La taille souhaitée par l'abonné.

Voir : : - otc_code_erreur

Retours :

Valeur de retour indiquant soit une erreur, soit une réussite.

otc_subscriber_get_preferred_resolution(subscriber, preferred_width, preferred_height) → {otc_status}

Renvoie la résolution préférée pour le flux de l'abonné.

Paramètres :
Nom Type Description
subscriber const otc_subscriber * L'instance de l'abonné.
preferred_width uint32_t * La largeur souhaitée par l'abonné.
preferred_height uint32_t * La taille souhaitée par l'abonné.

Voir : : - otc_code_erreur

Retours :

Valeur de retour indiquant soit une erreur, soit une réussite.

otc_subscriber_set_audio_volume(subscriber, volume) → {otc_status}

Permet de régler le volume audio de l'abonné, entre 0 et 100. Si la valeur ne se situe pas dans cette plage, elle sera limitée à celle-ci.

Paramètres :
Nom Type Description
subscriber otc_subscriber * L'instance de l'abonné.
volume double Le volume de l'abonné.

Voir : : - otc_code_erreur

Retours :

Valeur de retour indiquant soit une erreur, soit une réussite.

otc_subscriber_get_audio_volume(subscriber, volume) → {otc_status}

Renvoie le volume audio de l'abonné, compris entre 0 et 100.

La valeur par défaut est 100.

Paramètres :
Nom Type Description
subscriber const otc_subscriber * L'instance de l'abonné.
volume double * Le volume de l'abonné.

Voir : : - otc_code_erreur

Retours :

Valeur de retour indiquant soit une erreur, soit une réussite.

otc_subscriber_set_preferred_framerate(subscriber, preferred_framerate) → {otc_status}

Définit la fréquence d'images souhaitée pour le flux de l'abonné.

La valeur par défaut est 100.

Paramètres :
Nom Type Description
subscriber otc_subscriber * L'instance d'abonné qui sera concernée.
preferred_framerate flotter La fréquence d'images préférée de l'abonné.

Voir : : - otc_code_erreur

Retours :

Valeur de retour indiquant soit une erreur, soit une réussite.

otc_subscriber_get_preferred_framerate(subscriber, preferred_framerate) → {otc_status}

Renvoie la fréquence d'images souhaitée pour le flux de l'abonné.

Paramètres :
Nom Type Description
subscriber const otc_subscriber * L'instance de l'abonné.
preferred_framerate float * La fréquence d'images préférée associée à l'abonné.

Voir : : - otc_code_erreur

Retours :

Valeur de retour indiquant soit une erreur, soit une réussite.

otc_subscriber_get_subscriber_id(subscriber) → {const char *}

Récupère l'identifiant unique d'un abonné donné.

Paramètres :
Nom Type Description
subscriber const otc_subscriber * L'instance de l'abonné.
Retours :

Identifiant unique de l'abonné. Cette valeur peut être nulle en cas d'erreur.

otc_subscriber_get_user_data(subscriber) → {void *}

Récupère les données utilisateur d'un abonné donné.

Paramètres :
Nom Type Description
subscriber const otc_subscriber * L'instance de l'abonné.
Retours :

Un pointeur vers les données utilisateur en mémoire.

otc_subscriber_get_rtc_stats_report(subscriber) → {otc_status}

Récupère le rapport statistique RTC de l'abonné. Il s'agit d'une opération asynchrone. Créez un otc_subscriber_rtc_stats_report_cb et la passer dans la structure otc_subscriber_set_rtc_stats_report_cb fonction avant d'appeler cette fonction. Lorsque les statistiques sont disponibles, la otc_subscriber_set_rtc_stats_report_cb est appelée.

Voir aussi otc_subscriber_callbacks.on_audio_stats, otc_subscriber_callbacks.on_video_statset otc_publisher_get_rtc_stats_report.

Paramètres :
Nom Type Description
subscriber otc_subscriber * L'abonné.
Retours :

otc_status

otc_subscriber_set_rtc_stats_report_cb(subscriber, cb) → {otc_status}

Définit la fonction de rappel du rapport statistique RTC pour l'abonné. Voir otc_subscriber_get_rtc_stats_report.

Paramètres :
Nom Type Description
subscriber otc_subscriber * L'instance de l'abonné.
cb struct otc_subscriber_rtc_stats_report_cb Les otc_subscriber_rtc_stats_report_cb structure contenant la fonction de rappel pour le rapport sur les statistiques de l'horloge en temps réel (RTC).
Retours :

otc_status