publisher.h
Ce fichier contient la définition de type d'un éditeur OpenTok ainsi que plusieurs déclarations de fonctions.
Structures de données : otc_publisher_video_layer_stats, otc_publisher_audio_stats, otc_publisher_video_stats, otc_publisher_media_link_stats, otc_publisher_callbacks, otc_publisher_rtc_stats, otc_publisher_rtc_stats_report_cb
Comprend : base.h, config.h, stream.h, video_frame.h, camera_capture_resolution.h, media_transformer.h, video_capturer.h, media_utils.h
#define OTC_MAX_VIDEO_LAYERS
#define OTC_MAX_VIDEO_LAYERS 3
typedef otc_publisher
Définition du type d'éditeur OpenTok.
Type représentant un diffuseur d'un flux audio-vidéo vers une session OpenTok.
typedef struct otc_publisher otc_publisher;
typedef otc_publisher_settings
Définition du type de paramètres d'éditeur OpenTok.
typedef struct otc_publisher_settings otc_publisher_settings;
énumération otc_publisher_error_code
Liste des codes d'erreur pour les éditeurs OpenTok.
Cette énumération regroupe plusieurs codes d'erreur associés à un éditeur.
| Nom | Valeur | Description |
|---|---|---|
OTC_PUBLISHER_INTERNAL_ERROR |
2000 |
Erreur interne. |
OTC_PUBLISHER_SESSION_DISCONNECTED |
1010 |
La session à partir de laquelle l'éditeur publiait a été interrompue. |
OTC_PUBLISHER_TIMED_OUT |
1541 |
Délai d'attente dépassé lors de la tentative de publication. |
OTC_PUBLISHER_UNABLE_TO_PUBLISH |
1500 |
Erreur : impossible de publier. |
OTC_PUBLISHER_WEBRTC_ERROR |
1610 |
Erreur WebRTC. |
OTC_PUBLISHER_CAPTIONS_CHANGE_RATE_LIMIT_ERROR |
5010 |
Le serveur a rejeté une demande de modification des sous-titres pour cet éditeur, car trop de demandes ont été effectuées en peu de temps. Vous pouvez réessayer dans quelques secondes. |
OTC_PUBLISHER_ENCRYPTION_INTERNAL_ERROR |
6001 |
Erreur interne lors du chiffrement d'un paquet |
OTC_PUBLISHER_ENCRYPTION_UNSUPPORTED_CODEC |
6005 |
Codec multimédia non pris en charge pour le chiffrement |
OTC_PUBLISHER_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. |
énumération otc_publisher_video_type
Énumération des types de vidéos par éditeur.
Cette liste répertorie les différents types de vidéos pris en charge.
| Nom | Valeur | Description |
|---|---|---|
OTC_PUBLISHER_VIDEO_TYPE_CAMERA |
1 |
Flux vidéo de la caméra. |
OTC_PUBLISHER_VIDEO_TYPE_SCREEN |
2 |
Capture d'écran d'un flux vidéo. |
énumération otc_media_type
Type de média.
| Nom | Valeur | Description |
|---|---|---|
OTC_MEDIA_TYPE_VIDEO |
0 |
|
OTC_MEDIA_TYPE_AUDIO |
énumération otc_video_bitrate_preset
Ces préréglages permettent aux développeurs d'appliquer des stratégies de bande passante sans avoir à spécifier manuellement les débits binaires. Les préréglages s'excluent mutuellement de la configuration manuelle des débits binaires.
Pour plus de détails, voir Publisher Max Bitrate.
| Nom | Description |
|---|---|
OTC_VIDEO_BITRATE_PRESET_DEFAULT |
Il s'agit du mode par défaut. |
OTC_VIDEO_BITRATE_PRESET_BW_SAVER |
Applique des restrictions modérées afin de réduire l'utilisation de la bande passante tout en conservant une qualité vidéo raisonnable. |
OTC_VIDEO_BITRATE_PRESET_EXTRA_BW_SAVER |
Applique des contraintes strictes afin de réduire au minimum l'utilisation de la bande passante. |
OTC_VIDEO_BITRATE_PRESET_CUSTOM |
Correspond à un débit binaire configuré manuellement à l'aide de otc_publisher_set_max_video_bitrate(). Cette valeur est renvoyée par le getter du préréglage uniquement à des fins de suivi interne et ne peut pas être transmise au setter du préréglage. |
énumération otc_degradation_preference
Pour plus de détails, voir Préférence de dégradation.
| Nom | Valeur | Description |
|---|---|---|
OTC_DEGRADATION_PREFERENCE_NOT_SET |
-1 |
Valeur par défaut. Le moteur vidéo déterminera le niveau de dégradation optimal. |
OTC_DEGRADATION_PREFERENCE_MAINTAIN_FRAMERATE_AND_RESOLUTION |
0 |
Le moteur vidéo ne réduira pas la résolution et s'efforcera de maintenir une fréquence d'images constante. Dans certaines versions de la norme, cette option est désignée par « DISABLED », ce qui signifie qu'aucune dégradation ne sera appliquée lorsque les ressources sont limitées. |
OTC_DEGRADATION_PREFERENCE_MAINTAIN_FRAMERATE |
1 |
Le moteur vidéo s'efforcera de maintenir une fréquence d'images constante, mais pourra réduire la résolution si nécessaire. |
OTC_DEGRADATION_PREFERENCE_MAINTAIN_RESOLUTION |
2 |
Le moteur vidéo ne réduira pas la résolution, mais pourra réduire la fréquence d'images si nécessaire. |
OTC_DEGRADATION_PREFERENCE_BALANCED |
3 |
Le moteur vidéo s'efforcera de trouver un juste équilibre entre la réduction de la résolution et celle de la fréquence d'images lorsque cela s'avérera nécessaire. |
Fonctions
| Nom | Description |
|---|---|
otc_publisher_new(name, capturer, callbacks) → {otc_publisher *} |
Crée un nouveau otc_publisher instance. |
otc_publisher_settings_new() → {otc_publisher_settings *} |
Crée un nouveau otc_paramètres_éditeur instance. |
otc_publisher_settings_delete(settings) → {otc_status} |
Supprime un otc_paramètres_éditeur instance. |
otc_publisher_settings_set_name(settings, name) → {otc_status} |
Définit le nom souhaité pour un éditeur à créer à l'aide de otc_publisher_new_with_settings. |
otc_publisher_settings_set_video_capturer(settings, capturer) → {otc_status} |
Définit le capteur vidéo à utiliser pour la création d'un éditeur otc_publisher_new_with_settings. |
otc_publisher_settings_set_audio_track(settings, enabled) → {otc_status} |
Permet à un éditeur de créer une piste audio à l'aide de otc_publisher_new_with_settings. |
otc_publisher_settings_set_video_track(settings, enabled) → {otc_status} |
Permet à un éditeur de créer une piste vidéo à l'aide de otc_publisher_new_with_settings. |
otc_publisher_settings_set_sender_stats_track(settings, enabled) → {otc_status} |
Permet de créer un canal de statistiques d'expéditeur pour un éditeur à l'aide de otc_publisher_new_with_settings. |
otc_publisher_settings_set_stereo(settings, enabled) → {otc_status} |
Permet à un éditeur de créer un flux audio stéréo à l'aide de otc_publisher_new_with_settings. |
otc_publisher_settings_set_opus_dtx(settings, enabled) → {otc_status} |
Permet Opus DTX pour qu'un éditeur soit créé à l'aide de otc_publisher_new_with_settings. |
otc_publisher_settings_set_auto_gain_control(settings, enabled) → {otc_status} |
Permet de mettre en place un système de contrôle automatique du gain audio pour un éditeur à l'aide de otc_publisher_new_with_settings. |
otc_publisher_settings_set_noise_suppression(settings, enabled) → {otc_status} |
Permet de mettre en place une suppression du bruit pour qu'un éditeur puisse être créé à l'aide de otc_publisher_new_with_settings. |
otc_publisher_settings_set_echo_cancellation(settings, enabled) → {otc_status} |
Permet de mettre en place une annulation d'écho acoustique pour un diffuseur à réaliser à l'aide de otc_publisher_new_with_settings. |
otc_publisher_settings_set_disable_audio_processing(settings, disabled) → {otc_status} |
Quand otc_publisher_settings_set_disable_audio_processing est fixé à true, les réglages individuels relatifs à l'annulation de l'écho acoustique, au contrôle automatique du gain et à la suppression du bruit seront ignorés et le signal audio ne sera pas traité du tout. |
otc_publisher_settings_set_default_camera_capture_resolution(settings, camera_capture_resolution) → {otc_status} |
Définit la résolution de capture de la caméra pour les périphériques de capture vidéo par défaut. |
otc_publisher_settings_set_scalable_screenshare(settings, enabled) → {otc_status} |
Autoriser l'utilisation de la vidéo adaptative vidéo évolutive pour un éditeur qui dispose de la otc_publisher_video_type fixé à OTC_PUBLISHER_VIDEO_TYPE_SCREEN avec otc_publisher_new_with_settings. |
otc_publisher_settings_set_allow_audio_capture_while_muted(settings, enabled) → {otc_status} |
Quand otc_publisher_settings_set_allow_audio_capture_while_muted est fixé à false, le microphone sera automatiquement désactivé lorsque tous les intervenants auront coupé leur son. |
otc_publisher_new_with_settings(callbacks, settings) → {otc_publisher *} |
Crée un nouveau otc_publisher instance. |
otc_publisher_delete(publisher) → {otc_status} |
Libère une instance d'éditeur, ainsi que toutes les ressources matérielles qui lui sont associées. |
otc_publisher_get_stream(publisher) → {otc_stream *} |
Renvoie le flux associé à l'éditeur. |
otc_publisher_set_publish_video(publisher, publish_video) → {otc_status} |
Faut-il publier une vidéo ou non ? |
otc_publisher_set_publish_audio(publisher, publish_audio) → {otc_status} |
Faut-il publier ou non l'enregistrement audio ? |
otc_publisher_set_publish_captions(publisher, publish_captions) → {otc_status} |
Activer ou non les légendes. |
otc_publisher_get_publish_video(publisher) → {otc_bool} |
Indique si l'éditeur publie ou non une vidéo. |
otc_publisher_get_publish_audio(publisher) → {otc_bool} |
Indique si l'éditeur diffuse du contenu audio ou non. |
otc_publisher_get_publish_captions(publisher) → {otc_bool} |
Indique si l'éditeur dispose de sous-titres actifs. |
otc_publisher_set_captions_input_language(publisher, language) → {otc_status} |
Définit la langue de saisie préférée pour les sous-titres d'un éditeur donné. |
otc_publisher_get_captions_input_language(publisher) → {const char *} |
Récupère la langue de saisie des sous-titres configurée pour un éditeur donné. |
otc_publisher_get_session(publisher) → {otc_session *} |
Renvoie le otc_session associée à cette instance d'éditeur. |
otc_publisher_set_max_audio_bitrate(publisher, bitrate) → {otc_status} |
Définit le débit binaire audio maximal pour l'éditeur. |
otc_publisher_set_rtc_stats_report_cb(publisher, cb) → {otc_status} |
Définit la fonction de rappel du rapport statistique RTC pour l'éditeur. |
otc_publisher_get_rtc_stats_report(publisher) → {otc_status} |
Récupère le rapport statistique RTC de l'éditeur. |
otc_publisher_get_publisher_id(publisher) → {const char *} |
Récupère l'identifiant unique d'un éditeur. |
otc_publisher_set_video_type(publisher, video_type) → {otc_status} |
Définit le type de vidéo de l'éditeur. |
otc_publisher_get_video_type(publisher) → {enum otc_publisher_video_type} |
Récupère le type de vidéo de l'éditeur. |
otc_publisher_get_user_data(publisher) → {void *} |
Récupère les données utilisateur d'un éditeur donné. |
otc_publisher_get_name(publisher) → {const char *} |
Récupère le nom d'un éditeur donné. |
otc_publisher_set_video_transformers(publisher, transformers, size) → {otc_status} |
Le tableau peut être composé de transformateurs vidéo Vonage fournis par ml-library et/ou de transformateurs personnalisés. |
otc_publisher_set_audio_transformers(publisher, transformers, size) → {otc_status} |
Le tableau peut être composé de transformateurs audio Vonage fournis par la bibliothèque ml et/ou de transformateurs personnalisés. |
otc_publisher_set_target_scalability_mode(publisher, scalability_mode) → {otc_status} |
Cette méthode peut être appelée à tout moment ; il n'est pas nécessaire que la négociation de la branche acheminée soit terminée. |
otc_publisher_get_target_scalability_mode(publisher) → {const char *} |
Il s'agit d'une fonctionnalité en version bêta. |
otc_publisher_set_max_video_bitrate(publisher, bitrate_bps) → {otc_status} |
Renvoie le débit binaire vidéo maximal actuel, exprimé en bits par seconde (bps). |
otc_publisher_get_max_video_bitrate(publisher) → {int} |
Renvoie le débit binaire vidéo maximal actuellement configuré, en bits par seconde (bps). |
otc_publisher_set_video_bitrate_preset(publisher, preset) → {otc_status} |
Applique une stratégie prédéfinie de débit binaire vidéo pour contrôler le comportement de l'encodeur. |
otc_publisher_get_video_bitrate_preset(publisher) → {enum otc_video_bitrate_preset} |
Si un débit binaire personnalisé a déjà été défini à l'aide de otc_publisher_set_max_video_bitrate(), cette méthode renvoie la valeur OTC_VIDEO_BITRATE_PRESET_CUSTOM. |
otc_publisher_set_degradation_preference(publisher, degradation_preference) → {otc_status} |
|
otc_publisher_get_degradation_preference(publisher) → {enum otc_degradation_preference} |
|
otc_publisher_settings_set_subscriber_audio_fallback_enabled(settings, enabled) → {otc_status} |
Active ou désactive la fonctionnalité de repli audio pour les abonnés (pour les abonnés au flux publié). La fonctionnalité de repli audio pour les abonnés est disponible dans les sessions qui utilisent le Vonage Video Media Router. |
otc_publisher_settings_set_publisher_audio_fallback_enabled(settings, enabled) → {otc_status} |
Active ou désactive la fonctionnalité de repli audio de l'éditeur. |
otc_publisher_settings_set_preferred_video_codecs(settings, codecs, num_codecs) → {otc_status} |
Cette fonction permet de spécifier une liste explicite et ordonnée de codecs vidéo auxquels donner la priorité lors de la négociation. |
otc_publisher_settings_set_preferred_video_codecs_automatic(settings) → {otc_status} |
En mode automatique, le SDK détermine l'ordre de priorité des codecs le plus approprié, en remplaçant les paramètres par défaut du projet configurés dans le tableau de bord. |
otc_publisher_new(nom, capturer, callbacks) → {otc_publisher *}
Crée un nouveau otc_publisher instance.
Paramètres :
| Nom | Type | Description |
|---|---|---|
name |
const char * | Le nom de l'éditeur. Les autres clients peuvent récupérer les noms des flux au cours de la session. |
capturer |
const struct otc_video_capturer_callbacks * | Utilisez ce paramètre si vous souhaitez fournir un outil de capture vidéo personnalisé. S'il est défini sur null, l'éditeur utilise un outil de capture vidéo par défaut qui exploite la caméra du système. |
callbacks |
const struct otc_publisher_callbacks * | Un pointeur vers la structure contenant les pointeurs vers les fonctions de rappel de l'éditeur. |
Retours :
Un nouveau otc_publisher instance. En cas d'erreur, cette valeur est nulle.
otc_publisher_settings_new() → {otc_publisher_settings *}
Crée un nouveau otc_paramètres_éditeur instance.
Retours :
Un nouveau otc_paramètres_éditeur instance
otc_publisher_settings_delete(settings) → {otc_status}
Supprime un otc_paramètres_éditeur instance.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Les otc_paramètres_éditeur instance à supprimer. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_settings_set_name(settings, name) → {otc_status}
Définit le nom souhaité pour un éditeur à créer à l'aide de otc_publisher_new_with_settings.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Les otc_paramètres_éditeur instance concernée. |
name |
const char * | Nom de l'éditeur. Les autres clients peuvent récupérer les noms des flux au cours de la session. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_settings_set_video_capturer(settings, capturer) → {otc_status}
Définit le capteur vidéo à utiliser pour la création d'un éditeur otc_publisher_new_with_settings.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Les otc_paramètres_éditeur instance concernée. |
capturer |
const struct otc_video_capturer_callbacks * | Le dispositif de capture vidéo. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_settings_set_audio_track(settings, enabled) → {otc_status}
Permet à un éditeur de créer une piste audio à l'aide de otc_publisher_new_with_settings.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Les otc_paramètres_éditeur instance concernée. |
enabled |
otc_bool | Activer/désactiver la présence d'une piste audio pour un éditeur à créer avec otc_publisher_new_with_settings. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_settings_set_video_track(settings, enabled) → {otc_status}
Permet à un éditeur de créer une piste vidéo à l'aide de otc_publisher_new_with_settings.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Les otc_paramètres_éditeur instance concernée. |
enabled |
otc_bool | Activer/désactiver la présence d'une piste vidéo pour un éditeur à créer avec otc_publisher_new_with_settings. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_settings_set_sender_stats_track(settings, enabled) → {otc_status}
Permet de créer un canal de statistiques d'expéditeur pour un éditeur à l'aide de otc_publisher_new_with_settings. Actuellement, cette fonctionnalité ne prend en charge que les appels comptant plus de deux participants. Par défaut, le canal des statistiques de l'expéditeur est désactivé.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Les otc_paramètres_éditeur instance concernée. |
enabled |
otc_bool | Activer/désactiver la création d'un canal de statistiques de l'expéditeur pour un éditeur à l'aide de otc_publisher_new_with_settings. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_settings_set_stereo(settings, enabled) → {otc_status}
Permet à un éditeur de créer un flux audio stéréo à l'aide de otc_publisher_new_with_settings.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Les otc_paramètres_éditeur instance concernée. |
enabled |
otc_bool | Activer/désactiver la prise en charge de l'audio stéréo pour un éditeur à créer avec otc_publisher_new_with_settings. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_settings_set_opus_dtx(settings, enabled) → {otc_status}
Permet Opus DTX pour qu'un éditeur soit créé à l'aide de otc_publisher_new_with_settings. L'activation d'Opus DTX permet de réduire la consommation de bande passante dans les flux comportant de longues périodes de silence.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Les otc_paramètres_éditeur instance concernée. |
enabled |
otc_bool | Permet d'activer (true) ou de désactiver (false, valeur par défaut) la prise en charge d'Opus DTX. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_settings_set_auto_gain_control(settings, enabled) → {otc_status}
Permet de mettre en place un système de contrôle automatique du gain audio pour un éditeur à l'aide de otc_publisher_new_with_settings.
Cela ne fonctionne pas dans le SDK Linux de la Video API de Vonage.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Les otc_paramètres_éditeur instance concernée. |
enabled |
otc_bool | Permet d'activer (true, valeur par défaut) ou de désactiver (false) le contrôle automatique de gain. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_settings_set_noise_suppression(settings, enabled) → {otc_status}
Permet de mettre en place une suppression du bruit pour qu'un éditeur puisse être créé à l'aide de otc_publisher_new_with_settings.
Remarque : Cette fonction ne s'applique qu'au SDK macOS de la Video API Vonage. Elle ne fonctionne pas dans le SDK Linux de la Video API Vonage.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Les otc_paramètres_éditeur instance concernée. |
enabled |
otc_bool | Permet d'activer (true, valeur par défaut) ou de désactiver (false) la suppression du bruit. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_settings_set_echo_cancellation(settings, enabled) → {otc_status}
Permet de mettre en place une annulation d'écho acoustique pour un diffuseur à réaliser à l'aide de otc_publisher_new_with_settings.
Remarque : Cette fonction ne s'applique qu'au SDK macOS de la Video API Vonage. Elle ne fonctionne pas dans le SDK Linux de la Video API Vonage.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Les otc_paramètres_éditeur instance concernée. |
enabled |
otc_bool | Permet d'activer (true, valeur par défaut) ou de désactiver (false) la prise en charge de l'annulation de l'écho acoustique. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_settings_set_disable_audio_processing(settings, disabled) → {otc_status}
Quand otc_publisher_settings_set_disable_audio_processing est fixé à true, les paramètres individuels relatifs à l'annulation de l'écho acoustique, au contrôle automatique du gain et à la suppression du bruit seront ignorés et le signal audio ne sera pas traité du tout. La valeur par défaut est false. Voir otc_publisher_new_with_settings.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Les otc_paramètres_éditeur instance concernée. |
disabled |
otc_bool |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_settings_set_default_camera_capture_resolution(settings, camera_capture_resolution) → {otc_status}
Définit la résolution de capture de la caméra pour les périphériques de capture vidéo par défaut.
Les cartes d'acquisition vidéo personnalisées ne doivent pas respecter la résolution d'acquisition définie par otc_publisher_settings_set_default_camera_capture_resolution, cette fonctionnalité est réservée aux cartes d'acquisition vidéo par défaut.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Les otc_paramètres_éditeur instance concernée. |
camera_capture_resolution |
const énumération otc_camera_capture_resolution | Résolution d'enregistrement de la caméra pour les logiciels de capture vidéo par défaut. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_settings_set_scalable_screenshare(settings, enabled) → {otc_status}
Autoriser l'utilisation de la vidéo adaptative vidéo évolutive pour un éditeur qui dispose de la otc_publisher_video_type fixé à OTC_PUBLISHER_VIDEO_TYPE_SCREEN avec otc_publisher_new_with_settings.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Les otc_paramètres_éditeur instance concernée. |
enabled |
const otc_bool | Activer/désactiver l'utilisation de la vidéo adaptative pour les flux de partage d'écran. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_settings_set_allow_audio_capture_while_muted(settings, enabled) → {otc_status}
Quand otc_publisher_settings_set_allow_audio_capture_while_muted est fixé à false, le microphone sera automatiquement désactivé lorsque tous les intervenants auront coupé leur micro. Le microphone sera automatiquement réactivé dès qu’au moins un intervenant réactivera son micro. Si le paramètre est réglé sur true, le micro restera toujours activé, même lorsque tous les éditeurs auront coupé leur son. Notez que lorsque le micro est désactivé, les fonctions de rappel telles que `audio_level` ou `audio_data` ne seront plus appelées pour les éditeurs. La valeur par défaut est true. Voir otc_session_new_with_settings.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Pointeur vers l'objet des paramètres de session. |
enabled |
const otc_bool |
Retours :
otc_status Renvoie le statut de l'opération.
otc_publisher_new_with_settings(callbacks, settings) → {otc_publisher *}
Crée un nouveau otc_publisher instance.
Paramètres :
| Nom | Type | Description |
|---|---|---|
callbacks |
const struct otc_publisher_callbacks * | Un pointeur vers la structure contenant les pointeurs vers les fonctions de rappel de l'éditeur. |
settings |
otc_publisher_settings * | La structure « settings » contenant les paramètres souhaités pour l'éditeur. |
Retours :
Un nouveau otc_publisher instance. En cas d'erreur, cette valeur est nulle.
otc_publisher_delete(publisher) → {otc_status}
Libère une instance d'éditeur, ainsi que toutes les ressources matérielles qui lui sont associées.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
otc_publisher * | L'instance d'éditeur à supprimer. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_get_stream(publisher) → {otc_stream *}
Renvoie le flux associé à l'éditeur. Aucun rappel dans otc_publisher_callbacks sera appelée à la suite de l'appel de cette méthode (ou par la suite).
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
otc_publisher * | L'instance de l'éditeur à partir de laquelle récupérer le flux. |
Retours :
Le flux associé à l'éditeur. En cas d'erreur, cette valeur est nulle.
otc_publisher_set_publish_video(publisher, publish_video) → {otc_status}
Faut-il publier la vidéo ou non ? Par défaut, les flux publient à la fois l'audio et la vidéo.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
otc_publisher * | L'éditeur concerné. |
publish_video |
otc_bool | Faut-il publier une vidéo ou non ? |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_set_publish_audio(publisher, publish_audio) → {otc_status}
Publier ou non le son. Par défaut, les flux publient à la fois le son et la vidéo.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
otc_publisher * | L'éditeur concerné. |
publish_audio |
otc_bool | Faut-il publier ou non l'enregistrement audio ? |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_set_publish_captions(publisher, publish_captions) → {otc_status}
Activer ou non les légendes. Par défaut, cette option est désactivée.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
otc_publisher * | L'éditeur concerné. |
publish_captions |
otc_bool | Faut-il activer ou non les sous-titres ? |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_get_publish_video(publisher) → {otc_bool}
Indique si l'éditeur publie ou non une vidéo.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
const otc_publisher * | L'instance de l'éditeur. |
Retours :
Que l'éditeur publie ou non des vidéos.
otc_publisher_get_publish_audio(publisher) → {otc_bool}
Indique si l'éditeur diffuse du contenu audio ou non.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
const otc_publisher * | L'instance de l'éditeur. |
Retours :
Que l'éditeur publie ou non des contenus audio.
otc_publisher_get_publish_captions(publisher) → {otc_bool}
Indique si l'éditeur dispose de sous-titres actifs.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
const otc_publisher * | L'instance de l'éditeur. |
Retours :
Que l'éditeur ait activé ou non les sous-titres.
otc_publisher_set_captions_input_language(publisher, language) → {otc_status}
Définit la langue de saisie préférée pour les sous-titres d'un éditeur donné.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
otc_publisher * | L'instance de l'éditeur. |
language |
const char * | Un code de langue pris en charge ou la valeur NULL pour conserver la sélection par défaut. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_get_captions_input_language(publisher) → {const char *}
Récupère la langue de saisie des sous-titres configurée pour un éditeur donné.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
const otc_publisher * | L'instance de l'éditeur. |
Retours :
Langue d'entrée configurée. Elle peut être NULL si elle n'est pas définie.
otc_publisher_get_session(publisher) → {otc_session *}
Renvoie le otc_session associée à cette instance d'éditeur.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
const otc_publisher * | L'instance de l'éditeur. |
Retours :
Les otc_session associée à cette instance. En cas d'erreur, cette valeur est nulle.
otc_publisher_set_max_audio_bitrate(publisher, bitrate) → {otc_status}
Définit le débit binaire audio maximal pour l'éditeur.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
otc_publisher * | L'éditeur concerné. |
bitrate |
uint32_t | Le débit binaire souhaité en kbps. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_set_rtc_stats_report_cb(publisher, cb) → {otc_status}
Définit la fonction de rappel du rapport statistique RTC pour l'éditeur.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
otc_publisher * | L'instance de l'éditeur. |
cb |
const struct otc_publisher_rtc_stats_report_cb | Les otc_publisher_rtc_stats_report_cb structure contenant la fonction de rappel pour le rapport sur les statistiques de l'horloge en temps réel (RTC). |
Voir : : - otc_publisher_get_rtc_stats_report.
Retours :
otc_status
otc_publisher_get_rtc_stats_report(publisher) → {otc_status}
Récupère le rapport statistique RTC de l'éditeur. Il s'agit d'une opération asynchrone. Créez un otc_publisher_rtc_stats_report_cb et la passer dans la structure otc_publisher_set_rtc_stats_report_cb fonction avant d'appeler cette fonction. Lorsque les statistiques sont disponibles, la otc_publisher_set_rtc_stats_report_cb est appelée.
Voir aussi otc_publisher_callbacks.on_audio_stats, otc_publisher_callbacks.on_video_statset otc_subscriber_get_rtc_stats_report.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
otc_publisher * | L'éditeur. |
Retours :
otc_status
otc_publisher_get_publisher_id(publisher) → {const char *}
Récupère l'identifiant unique d'un éditeur.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
const otc_publisher * | L'instance de l'éditeur. |
Retours :
Identifiant unique de l'éditeur. En cas d'erreur, cette valeur est nulle.
otc_publisher_set_video_type(publisher, video_type) → {otc_status}
Définit le type de vidéo de l'éditeur. Par défaut, le type de vidéo est défini sur OTC_PUBLISHER_VIDEO_TYPE_CAMERA (ce qui indique que la source de la vidéo est une caméra). Définissez cette valeur sur OTC_PUBLISHER_VIDEO_TYPE_SCREEN pour indiquer que la source de la vidéo est un partage d'écran. Les autres clients peuvent détecter le type de vidéo des flux de la session (afin de déterminer le type de source vidéo).
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
struct otc_publisher * | L'éditeur concerné. |
video_type |
énumération otc_publisher_video_type | Le type de vidéo pour l'éditeur. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_get_video_type(publisher) → {enum otc_publisher_video_type}
Récupère le type de vidéo de l'éditeur. Voir la section otc_publisher_set_video_type fonction.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
const struct otc_publisher * | L'instance de l'éditeur. |
Retours :
Le type de vidéo de l'éditeur.
otc_publisher_get_user_data(publisher) → {void *}
Récupère les données utilisateur d'un éditeur donné.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
const struct otc_publisher * | L'instance de l'éditeur. |
Retours :
Un pointeur vers les données utilisateur en mémoire.
otc_publisher_get_name(publisher) → {const char *}
Récupère le nom d'un éditeur donné.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
const struct otc_publisher * | L'instance de l'éditeur. |
Retours :
Le nom.
otc_publisher_set_video_transformers(publisher, transformers, size) → {otc_status}
Le tableau peut être composé de transformateurs vidéo Vonage fournis par la bibliothèque ml-library et/ou de transformateurs personnalisés. Les transformateurs contiennent un pointeur vers une fonction de rappel appelée à chaque image vidéo.
Remarque : Cette fonction ne s'applique qu'au SDK macOS de la Video API Vonage. Elle ne fonctionne pas dans le SDK Linux de la Video API Vonage.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
otc_publisher * | L'instance de l'éditeur. |
transformers |
otc_video_transformer * * | Tableau de pointeurs opaques otc_video_transformer dans l'ordre dans lequel ils doivent être appliqués au flux. |
size |
uint8_t | taille du tableau. |
Retours :
une erreur en cas d'erreur ; sinon, OTC_SUCCESS.
otc_publisher_set_audio_transformers(publisher, transformers, size) → {otc_status}
Le tableau peut être composé de transformateurs audio Vonage fournis par la bibliothèque ml et/ou de transformateurs personnalisés. Les transformateurs contiennent un pointeur vers une fonction de rappel appelée à chaque trame audio.
Remarque : Cette fonction ne s'applique qu'au SDK macOS de la Video API Vonage. Elle ne fonctionne pas dans le SDK Linux de la Video API Vonage.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
otc_publisher * | L'instance de l'éditeur. |
transformers |
otc_audio_transformer * * | Tableau de pointeurs opaques otc_audio_transformer dans l'ordre dans lequel ils doivent être appliqués au flux. |
size |
uint8_t | taille du tableau. |
Retours :
une erreur en cas d'erreur ; sinon, OTC_SUCCESS.
otc_publisher_set_target_scalability_mode(publisher, scalability_mode) → {otc_status}
Cette méthode peut être appelée à tout moment ; il n'est pas nécessaire que la négociation de la liasse acheminée soit terminée. Le mode sera appliqué dès que la liasse acheminée sera établie.
Si un codec autre que SVC (VP8, H.264) est négocié sur la liaison acheminée, le mode applicable le plus proche est utilisé : les couches spatiales sont forcées à la valeur 1, ce qui préserve la dimension temporelle (par exemple, L2T2 → L1T2 lorsque VP8 est négocié).
Il s'agit d'une fonctionnalité en version bêta.
Erreurs :
- Renvoie OTC_ERROR si le mode demandé n'est pas un mode d'évolutivité valide (c'est-à-dire s'il ne s'agit pas de L1T1, L1T2, L1T3, L2T1, L2T2, L2T3, L3T1, L3T2 ou L3T3).
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
otc_publisher * | L'instance de l'éditeur. |
scalability_mode |
const char * | Le mode d'évolutivité cible. |
Retours :
OTC_SUCCESS si l'opération aboutit ; sinon, un code d'erreur.
otc_publisher_get_target_scalability_mode(publisher) → {const char *}
Il s'agit d'une fonctionnalité en version bêta.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
otc_publisher * | L'instance de l'éditeur. |
Retours :
Mode d'évolutivité cible défini par l'appelant, ou NULL s'il n'est pas explicitement défini.
otc_publisher_set_max_video_bitrate(publisher, bitrate_bps) → {otc_status}
Renvoie le débit binaire vidéo maximal actuel, exprimé en bits par seconde (bps). Si aucun débit binaire n'a été explicitement défini via otc_publisher_set_max_video_bitrate(), ou si un préréglage de débit binaire est actif (y compris le préréglage par défaut), cette fonction renvoie 0.
Remarque : Une valeur de retour égale à 0 indique qu'aucune limite manuelle de débit binaire n'est appliquée et que le flux fonctionne selon une configuration prédéfinie.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
otc_publisher * | L'instance de l'éditeur. |
bitrate_bps |
int |
Retours :
Débit binaire vidéo maximal actuel, exprimé en bits par seconde ; la valeur est égale à 0 si ce paramètre n'est pas défini ou si un préréglage est utilisé.
otc_publisher_get_max_video_bitrate(publisher) → {int}
Renvoie le débit binaire vidéo maximal actuellement configuré, en bits par seconde (bps). Si aucun débit binaire n'a été défini manuellement via otc_publisher_set_max_video_bitrate(), ou si un préréglage est actif (y compris celui par défaut), cette fonction renvoie 0.
Remarque : Une valeur de retour égale à 0 indique qu'aucune limite de débit binaire explicite n'est appliquée et que le flux utilise plutôt un comportement basé sur des préréglages.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
const otc_publisher * | L'instance de l'éditeur. |
Retours :
Débit binaire vidéo maximal actuel, exprimé en bits par seconde, ou 0 s'il n'a pas été défini manuellement.
otc_publisher_set_video_bitrate_preset(publisher, preset) → {otc_status}
Applique une stratégie prédéfinie de débit binaire vidéo afin de contrôler le comportement de l'encodeur. Ces préréglages visent à trouver un équilibre entre la qualité vidéo et l'utilisation de la bande passante, en fonction des besoins de l'application.
Remarque : Le préréglage OTC_VIDEO_BITRATE_PRESET_CUSTOM ne peut pas être défini directement. L'appel de otc_publisher_set_max_video_bitrate() remplacera le préréglage et fera en sorte que la méthode de récupération du préréglage renvoie la valeur OTC_VIDEO_BITRATE_PRESET_CUSTOM.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
otc_publisher * | L'instance de l'éditeur. |
preset |
énumération otc_video_bitrate_preset | Une valeur provenant de otc_video_bitrate_preset pour postuler. |
Retours :
une erreur en cas d'erreur ; sinon, OTC_SUCCESS.
otc_publisher_get_video_bitrate_preset(publisher) → {enum otc_video_bitrate_preset}
Si un débit binaire personnalisé a déjà été défini à l'aide de otc_publisher_set_max_video_bitrate(), cette méthode renvoie la valeur OTC_VIDEO_BITRATE_PRESET_CUSTOM.
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
const otc_publisher * | L'instance de l'éditeur. |
Retours :
Le préréglage de débit binaire actif.
otc_publisher_set_degradation_preference(publisher, degradation_preference) → {otc_status}
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
otc_publisher * | L'instance de l'éditeur. |
degradation_preference |
énumération otc_degradation_preference | La préférence de dégradation. |
Retours :
OTC_SUCCESS ou une erreur.
otc_publisher_get_degradation_preference(publisher) → {enum otc_degradation_preference}
Paramètres :
| Nom | Type | Description |
|---|---|---|
publisher |
const otc_publisher * | L'instance de l'éditeur. |
Retours :
La préférence actuelle en matière de dégradation.
otc_publisher_settings_set_subscriber_audio_fallback_enabled(settings, enabled) → {otc_status}
Active ou désactive la fonctionnalité de repli audio pour les abonnés (pour les abonnés au flux publié)
La fonctionnalité de repli audio pour les abonnés est disponible dans les sessions utilisant le Vonage Video Media Router. Lorsque la fonctionnalité de repli audio est activée (par défaut), si le Vonage Video Media Router détecte une dégradation significative de la qualité d'un flux pour un abonné spécifique, il désactive la vidéo pour cet abonné afin de préserver la qualité audio.
Le paramètre par défaut est OTC_TRUE (la fonctionnalité de repli audio est activée). Lorsque l'on utilise le type de vidéo « écran », le paramètre de repli audio des abonnés est défini par défaut sur OTC_FALSE, afin d'éviter toute interruption de la vidéo chez les abonnés.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Les paramètres de l'éditeur concernés. |
enabled |
const otc_bool | Que l'on souhaite ou non activer la fonctionnalité de repli audio. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_settings_set_publisher_audio_fallback_enabled(settings, enabled) → {otc_status}
Active ou désactive la fonctionnalité de repli audio de l'éditeur.
Lorsque la fonctionnalité de repli audio de l'éditeur est activée, si l'éditeur constate que la qualité d'un flux vidéo s'est considérablement dégradée, il désactive ce flux afin de préserver la qualité audio et continue à transmettre le flux audio. Le capteur associé à cet éditeur ne sera pas désactivé, et les images capturées resteront visibles côté éditeur.
Le paramètre par défaut est OTC_FALSE (la fonctionnalité de repli audio est désactivée). Lorsque vous utilisez le type de vidéo « écran » dans une session exploitant le serveur multimédia OpenTok, le paramètre de repli audio de l'éditeur est défini par défaut sur OTC_FALSE, afin d'éviter toute interruption de la vidéo chez les abonnés.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | Les paramètres de l'éditeur concernés. |
enabled |
const otc_bool | Que l'on souhaite ou non activer la fonctionnalité de repli audio. |
Retours :
Valeur de retour indiquant soit une erreur, soit une réussite.
otc_publisher_settings_set_preferred_video_codecs(settings, codecs, num_codecs) → {otc_status}
Cette fonction permet de spécifier une liste explicite et ordonnée de codecs vidéo auxquels accorder la priorité lors de la négociation. Les codecs indiqués figureront en tête de l'offre SDP (dans l'ordre indiqué), mais d'autres codecs pris en charge pourront tout de même être inclus avec une priorité inférieure.
Cela ne limite pas la négociation à ces codecs uniquement.
Le passage d'une liste vide entraînera une erreur OT_INVALID_PARAMETER. Si cette fonction n'est pas appelée, le SDK revient au comportement par défaut défini dans les paramètres du projet Dashboard.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | L'instance des paramètres de l'éditeur à modifier. |
codecs |
const otc_video_codec_type * | Une liste de codecs vidéo à prioriser (ne doit pas être vide). |
num_codecs |
size_t | Le nombre d'éléments du tableau « codecs ». |
Retours :
OTC_SUCCESS si l'opération aboutit ; OT_INVALID_PARAMETER si la liste est vide ou non valide.
otc_publisher_settings_set_preferred_video_codecs_automatic(settings) → {otc_status}
En mode automatique, le SDK détermine l'ordre de priorité des codecs le plus approprié, en remplaçant les paramètres par défaut du projet configurés dans le tableau de bord.
Cela permet de déléguer facilement le choix du codec au SDK sans avoir à définir manuellement une liste.
Paramètres :
| Nom | Type | Description |
|---|---|---|
settings |
otc_publisher_settings * | L'instance des paramètres de l'éditeur à modifier. |
Retours :
OTC_SUCCESS si l'opération aboutit ; sinon, un code d'erreur.