Abonné à OpenTok. En savoir plus...

#include "config.h" #include "stream.h" #include "error.h" #include "video_frame.h" #include "audio_data.h"
Définitions de types
typedef struct abonné_otc abonné_otc
Fonctions
abonné_otc * otc_nouvel_abonné (const otc_stream *flux, struct const otc_subscriber_callbacks *rappels)
otc_status otc_suppression_abonné (abonné_otc *abonné)
otc_stream * otc_subscriber_get_stream (const abonné_otc *abonné)
otc_status otc_subscriber_set_subscribe_to_video (abonné_otc *abonné, otc_bool (subscribe_to_video)
otc_status otc_subscriber_set_subscribe_to_audio (abonné_otc *abonné, otc_bool subscribe_to_audio)
otc_status otc_subscriber_set_subscribe_to_captions (abonné_otc *abonné, otc_bool (subscribe_to_captions)
otc_bool otc_subscriber_get_subscribe_to_video (const abonné_otc *abonné)
otc_bool otc_subscriber_get_subscribe_to_audio (const abonné_otc *abonné)
otc_bool otc_subscriber_get_subscribe_to_captions (const abonné_otc *abonné)
otc_session * otc_subscriber_get_session (const abonné_otc *abonné)
otc_status otc_subscriber_set_preferred_resolution (abonné_otc *abonné, uint32_t largeur_préférée, uint32_t hauteur_préférée)
otc_status otc_subscriber_get_preferred_resolution (const abonné_otc *abonné, uint32_t *largeur_préférée, uint32_t *hauteur_préférée)
otc_status otc_subscriber_set_audio_volume (abonné_otc *abonnés, double volume)
otc_status otc_subscriber_get_audio_volume (const abonné_otc *abonné, double *volume)
otc_status otc_subscriber_set_preferred_framerate (abonné_otc *abonné, float fréquence_d'images_préférée)
otc_status otc_subscriber_get_preferred_framerate (const abonné_otc *abonné, float *fréquence_d'images_préférée)
const char * otc_subscriber_get_subscriber_id (const abonné_otc *abonné)
void * otc_subscriber_get_user_data (const abonné_otc *abonné)
otc_status otc_subscriber_get_rtc_stats_report (const abonné_otc *abonné)
otc_status otc_subscriber_set_rtc_stats_report_cb (abonné_otc *abonné, struct otc_subscriber_rtc_stats_report_cb cb)

Description détaillée

Abonné à OpenTok.

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

Documentation sur `typedef`

abonné_otc
typedef struct abonné_otc abonné_otc

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

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

Documentation sur les types d'énumération

otc_code_erreur_abonné
énumération otc_code_erreur_abonné

Liste des codes d'erreur pour les abonnés OpenTok.

Cette liste répertorie plusieurs codes d'erreur associés à un abonné.

Recenseur
OTC_SUBSCRIBER_INTERNAL_ERROR Erreur interne lors de l'abonnement.
OTC_SUBSCRIBER_SESSION_DISCONNECTED Vous essayez de vous abonner à un flux dans une session dont vous vous êtes déconnecté.
OTC_SUBSCRIBER_SERVER_CANNOT_FIND_STREAM 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 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 Dépassement du délai d'attente lors de la tentative d'abonnement.
OTC_SUBSCRIBER_WEBRTC_ERROR Échec de la connexion WebRTC de l'abonné.
OTC_SUBSCRIBER_PEER_CONNECTION_NOT_CONNECTED La connexion entre pairs n'est pas encore établie.
OTC_SUBSCRIBER_DECRYPTION_INTERNAL_ERROR Erreur interne lors du déchiffrement d'un paquet
OTC_SUBSCRIBER_ENCRYPTION_SECRET_MISMATCH Incohérence secrète lors du déchiffrement d'un paquet
OTC_SUBSCRIBER_DECRYPTION_UNSUPPORTED_CODEC Codec multimédia non pris en charge pour le décryptage

Documentation des fonctions

otc_subscriber_delete()
otc_status otc_suppression_abonné ( abonné_otc * abonné )

Libère une instance d'abonné, y compris toutes les ressources matérielles et d'interface utilisateur qui y sont associées.

Paramètres : | | | | --- | --- | | abonné | L'abonné à supprimer. |

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

otc_subscriber_get_audio_volume()
otc_status otc_subscriber_get_audio_volume ( const abonné_otc * abonné,
double * volume
)

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

La valeur par défaut est 100.

Paramètres : | | | | --- | --- | | abonné | L'instance de l'abonné. | | volume | Le volume de l'abonné. |

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

Voir aussi : otc_code_erreur

otc_subscriber_get_preferred_framerate()
otc_status otc_subscriber_get_preferred_framerate ( const abonné_otc * abonné,
float * débit_préféré
)

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

Paramètres : | | | | --- | --- | | subscriber | L'instance de l'abonné. | | preferred_framerate | La fréquence d'images préférée associée à l'abonné. |

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

Voir aussi : otc_code_erreur

otc_subscriber_get_preferred_resolution()
otc_status otc_subscriber_get_preferred_resolution ( const abonné_otc * abonné,
uint32_t * largeur_préférée,
uint32_t * hauteur_préférée
)

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

Paramètres : | | | | --- | --- | | subscriber | L'instance de l'abonné. | | preferred_width | La largeur souhaitée de l'abonné. | | preferred_height | La hauteur souhaitée de l'abonné. |

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

Voir aussi : otc_code_erreur

otc_subscriber_get_rtc_stats_report()
otc_status otc_subscriber_get_rtc_stats_report ( const abonné_otc * abonné )

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 : | | | | --- | --- | | abonné | L'abonné. |

otc_subscriber_get_session()
otc_session * otc_subscriber_get_session ( const abonné_otc * abonné )

Renvoie le otc_session associée à cette instance.

Paramètres : | | | | --- | --- | | abonné | L'instance de l'abonné. |

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

otc_subscriber_get_stream()
otc_stream * otc_subscriber_get_stream ( const abonné_otc * abonné )

Renvoie le flux associé à l'abonné.

Paramètres : | | | | --- | --- | | abonné | L'instance d'abonné à partir de laquelle récupérer le flux. |

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

otc_subscriber_get_subscribe_to_audio()
otc_bool otc_subscriber_get_subscribe_to_audio ( const abonné_otc * abonné )

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

Paramètres : | | | | --- | --- | | abonné | L'instance de l'abonné. |

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

otc_subscriber_get_subscribe_to_captions()
otc_bool otc_subscriber_get_subscribe_to_captions ( const abonné_otc * abonné )

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

Paramètres : | | | | --- | --- | | abonné | L'instance de l'abonné. |

Retourne : Indique 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_subscribe_to_video()
otc_bool otc_subscriber_get_subscribe_to_video ( const abonné_otc * abonné )

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

Paramètres : | | | | --- | --- | | abonné | L'instance de l'abonné. |

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

otc_subscriber_get_subscriber_id()
const char * otc_subscriber_get_subscriber_id ( const abonné_otc * abonné )

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

Paramètres : | | | | --- | --- | | abonné | L'instance de l'abonné. |

Résultats : Un identifiant unique pour l'abonné. Cette valeur peut être nulle en cas d'erreur.

otc_subscriber_get_user_data()
void * otc_subscriber_get_user_data ( const abonné_otc * abonné )

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

Paramètres : | | | | --- | --- | | abonné | L'instance de l'abonné. |

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

otc_subscriber_new()
abonné_otc * otc_subscriber_new ( const otc_stream * flux,
const struct otc_subscriber_callbacks * rappels
)

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

Paramètres : | | | | --- | --- | | stream | L'objet Stream correspondant au flux auquel vous allez vous abonner. | | callbacks | Structure contenant les pointeurs vers les fonctions de rappel de l'abonné. |

Retourne : La nouvelle instance de Subscriber. Cette valeur peut être nulle en cas d'erreur.

otc_subscriber_set_audio_volume()
otc_status otc_subscriber_set_audio_volume ( abonné_otc * abonné,
double volume
)

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 : | | | | --- | --- | | abonné | L'instance de l'abonné. | | volume | Le volume de l'abonné. |

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

Voir aussi : otc_code_erreur

otc_subscriber_set_preferred_framerate()
otc_status otc_subscriber_set_preferred_framerate ( abonné_otc * abonné,
flotter débit_préféré
)

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

La valeur par défaut est 100.

Paramètres : | | | | --- | --- | | subscriber | L'instance d'abonné qui sera concernée. | | preferred_framerate | La fréquence d'images préférée de l'abonné. |

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

Voir aussi : otc_code_erreur

otc_subscriber_set_preferred_resolution()
otc_status otc_subscriber_set_preferred_resolution ( abonné_otc * abonné,
uint32_t largeur_préférée,
uint32_t hauteur_préférée
)

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

Paramètres : | | | | --- | --- | | subscriber | L'instance d'abonné qui sera concernée. | | preferred_width | La largeur souhaitée de l'abonné. | | preferred_height | La hauteur souhaitée de l'abonné. |

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

Voir aussi : otc_code_erreur

otc_subscriber_set_rtc_stats_report_cb()
otc_status otc_subscriber_set_rtc_stats_report_cb ( abonné_otc * abonné,
struct otc_subscriber_rtc_stats_report_cb cb
)

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

Paramètres : | | | | --- | --- | | subscriber | L'instance de l'abonné. | | cb | Le 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). |

otc_subscriber_set_subscribe_to_audio()
otc_status otc_subscriber_set_subscribe_to_audio ( abonné_otc * abonné,
otc_bool s'abonner_à_la_version_audio
)

S'abonne au flux audio.

Paramètres : | | | | --- | --- | | subscriber | L'instance d'abonné concernée. | | subscribe_to_audio | Indique s'il faut s'abonner ou non au flux audio. |

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

otc_subscriber_set_subscribe_to_captions()
otc_status otc_subscriber_set_subscribe_to_captions ( abonné_otc * abonné,
otc_bool s'abonner aux sous-titres
)

S'abonne aux sous-titres de la diffusion.

Paramètres : | | | | --- | --- | | subscriber | L'instance d'abonné concernée. | | subscribe_to_captions | Indique s'il faut s'abonner aux sous-titres ou non. |

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

otc_subscriber_set_subscribe_to_video()
otc_status otc_subscriber_set_subscribe_to_video ( abonné_otc * abonné,
otc_bool s'abonner_à_la_vidéo
)

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

Paramètres : | | | | --- | --- | | subscriber | L'instance d'abonné concernée. | | subscribe_to_video | Indique s'il faut s'abonner à la vidéo ou non. |

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