OpenTok Publisher. En savoir plus...

#include "config.h" #include "stream.h" #include "video_frame.h" #include "audio_data.h" #include "camera_capture_resolution.h" #include "media_transformer.h" #include "video_capturer.h"

Description détaillée

OpenTok Publisher.

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

Documentation sur `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.

otc_paramètres_éditeur

Définition du type de paramètres d'éditeur OpenTok.

Documentation sur les types d'é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.

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.

otc_video_bitrate_preset

Stratégies prédéfinies pour contrôler le débit binaire vidéo dans le flux d'un éditeur.

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.

Documentation des fonctions

otc_publisher_delete()

Libère une instance d'éditeur, ainsi que toutes les ressources matérielles qui lui sont associées.

Paramètres : | | | | --- | --- | | éditeur | L'instance d'éditeur à supprimer. |

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

otc_publisher_get_audio_fallback_enabled()

Indique si la fonctionnalité de solution de secours audio de l'éditeur est activée ou non. Voir la section otc_publisher_set_audio_fallback_enabled fonction.

Cette fonction est obsolète.

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

Retours : Indique si la fonctionnalité de repli audio de l'éditeur est activée ou non.

otc_publisher_get_max_video_bitrate()

Récupère le débit binaire vidéo maximal défini pour le flux vidéo de cet éditeur.

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 : | | | | | --- | --- | --- | | [in] | publisher | L'instance de l'éditeur. |

Retourne : Le 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_get_name()

Récupère le nom d'un éditeur donné.

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

Renvoie : Le nom.

otc_publisher_get_publish_audio()

Indique si l'éditeur diffuse du contenu audio ou non.

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

Retours : Indique si l'éditeur publie ou non du contenu audio.

otc_publisher_get_publish_captions()

Indique si l'éditeur dispose de sous-titres actifs.

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

Retours : Indique si l'éditeur a activé ou non les sous-titres.

otc_publisher_get_publish_video()

Indique si l'éditeur publie ou non une vidéo.

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

Retours : Indique si l'éditeur publie ou non des vidéos.

otc_publisher_get_publisher_id()

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

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

Résultats : Identifiant unique de l'éditeur. En cas d'erreur, cette valeur est nulle.

otc_publisher_get_rtc_stats_report()

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

otc_publisher_get_session()

Renvoie le otc_session associée à cette instance d'éditeur.

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

Retours : Le otc_session associée à cette instance. En cas d'erreur, cette valeur est nulle.

otc_publisher_get_stream()

Renvoie le flux associé à l'éditeur.

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

Retourne : Le flux associé à l'éditeur. En cas d'erreur, cette valeur est nulle.

otc_publisher_get_user_data()

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

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

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

otc_publisher_get_video_bitrate_preset()

Récupère le préréglage de débit binaire vidéo actuellement actif pour le flux de cet éditeur.

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 : | | | | | --- | --- | --- | | [in] | publisher | L'instance de l'éditeur. |

Retours : Le préréglage de débit binaire actif.

otc_publisher_get_video_type()

Récupère le type de vidéo de l'éditeur. Voir la section otc_publisher_set_video_type fonction.

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

Retourne : Le type de vidéo de l'éditeur.

otc_publisher_new()

Crée une nouvelle instance de `otc_publisher`.

Paramètres : | | | | --- | --- | | name | Le nom de l'éditeur. Les autres clients peuvent récupérer les noms des flux de la session. | | capturer | Utilisez ce paramètre si vous souhaitez fournir un capteur vidéo personnalisé. S'il est défini sur null, l'éditeur utilise un capteur vidéo par défaut qui exploite la caméra du système. | | callbacks | Un pointeur vers la structure contenant les pointeurs vers les fonctions de rappel de l'éditeur. |

Retourne : Une nouvelle instance de `otc_publisher`. En cas d'erreur, cette valeur est nulle.

otc_publisher_new_with_settings()

Crée une nouvelle instance de `otc_publisher`.

Paramètres : | | | | --- | --- | | callbacks | Un pointeur vers la structure contenant les pointeurs vers les fonctions de rappel de l'éditeur. | | settings | La structure « settings » contenant les paramètres souhaités pour l'éditeur. |

Retourne : Une nouvelle instance de `otc_publisher`. En cas d'erreur, cette valeur est nulle.

otc_publisher_set_audio_fallback_enabled()

Active ou désactive la fonctionnalité de repli audio pour les abonnés.

La fonctionnalité de repli audio est disponible dans les sessions utilisant OpenTok Media Router. Lorsque cette fonctionnalité est activée (par défaut), si OpenTok 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.

Pour désactiver la fonctionnalité de repli audio, appelez la fonction otc_publisher_set_audio_fallback_enabled fonction (en lui transmettant la valeur OTC_FALSE) avant d'appeler la otc_session_publish fonction.

Cette fonction est obsolète. Voir otc_publisher_settings_set_subscriber_audio_fallback_enabled.

Paramètres : | | | | --- | --- | | éditeur | L'éditeur concerné. | | activé | Indique si l'on souhaite activer ou non la fonctionnalité de repli audio. |

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

otc_publisher_set_audio_transformers()

Définit un tableau de transformateurs audio pour le flux audio de cet éditeur. Si la valeur est nulle, les transformateurs sont réinitialisés.

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 : | | | | | --- | --- | --- | | [in] | publisher | L'instance de l'éditeur. | | [in] | transformers | Tableau de pointeurs opaques vers otc_audio_transformer, dans l'ordre dans lequel ils doivent être appliqués au flux. | | [in] | size | Taille du tableau. |

Résultats : une erreur en cas d'erreur, sinon OTC_SUCCESS.

otc_publisher_set_max_audio_bitrate()

Définit le débit binaire audio maximal pour l'éditeur.

Paramètres : | | | | --- | --- | | éditeur | L'éditeur concerné. | | débit binaire | Le débit binaire souhaité en kbps. |

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

otc_publisher_set_max_video_bitrate()

Récupère le débit binaire vidéo maximal défini pour le flux vidéo de cet éditeur.

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 : | | | | | --- | --- | --- | | [in] | publisher | L'instance de l'éditeur. |

Retourne : Le débit binaire vidéo maximal actuel, exprimé en bits par seconde, ou 0 si cette valeur n'est pas définie ou si un préréglage est utilisé.

otc_publisher_set_publish_audio()

Publier ou non le son. Par défaut, les flux publient à la fois le son et la vidéo.

Paramètres : | | | | --- | --- | | publisher | L'éditeur concerné. | | publish_audio | Indique s'il faut publier ou non le contenu audio. |

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

otc_publisher_set_publish_captions()

Activer ou non les légendes. Par défaut, cette option est désactivée.

Paramètres : | | | | --- | --- | | publisher | L'éditeur concerné. | | publish_captions | Indique s'il faut activer ou non le sous-titrage. |

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

otc_publisher_set_publish_video()

Faut-il publier la vidéo ou non ? Par défaut, les flux publient à la fois l'audio et la vidéo.

Paramètres : | | | | --- | --- | | publisher | L'éditeur concerné. | | publish_video | Indique s'il faut publier la vidéo ou non. |

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

otc_publisher_set_rtc_stats_report_cb()

Définit la fonction de rappel du rapport statistique RTC pour l'éditeur.

Paramètres : | | | | --- | --- | | publisher | L'instance de l'éditeur. | | cb | Le 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 aussi : otc_publisher_get_rtc_stats_report.

otc_publisher_set_video_bitrate_preset()

Définit un préréglage de débit binaire vidéo pour le flux vidéo de cet éditeur.

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 : | | | | | --- | --- | --- | | [in] | publisher | L'instance de l'éditeur. | | [in] | preset | Une valeur comprise entre otc_video_bitrate_preset pour postuler. |

Résultats : une erreur en cas d'erreur, sinon OTC_SUCCESS.

otc_publisher_set_video_transformers()

Définit un tableau de transformateurs vidéo pour le flux vidéo de ce diffuseur. Si la valeur est nulle, les transformateurs sont réinitialisés.

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 : | | | | | --- | --- | --- | | [in] | publisher | L'instance de l'éditeur. | | [in] | transformers | Tableau de pointeurs opaques vers des otc_video_transformer, dans l'ordre dans lequel ils doivent être appliqués au flux. | | [in] | size | Taille du tableau. |

Résultats : une erreur en cas d'erreur, sinon OTC_SUCCESS.

otc_publisher_set_video_type()

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 : | | | | --- | --- | | éditeur | L'éditeur concerné. | | type_vidéo | Le type de vidéo de l'éditeur. |

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

otc_publisher_settings_delete()

Supprime une instance de `otc_publisher_settings`.

Paramètres : | | | | --- | --- | | settings | L'instance « otc_publisher_settings » à supprimer. |

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

otc_publisher_settings_new()

Crée une nouvelle instance de `otc_publisher_settings`.

Renvoie : Une nouvelle instance de `otc_publisher_settings`

otc_publisher_settings_set_allow_audio_capture_while_muted()

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 : | | | | --- | --- | | settings | Pointeur vers l'objet des paramètres de session. | | enable | Indicateur booléen permettant de désactiver (OTC_FALSE, valeur par défaut) ou d'activer (OTC_TRUE) cet indicateur. |

Retour : otc_status Renvoie le statut de l'opération.

otc_publisher_settings_set_audio_track()

Permet à un éditeur de créer une piste audio à l'aide de otc_publisher_new_with_settings.

Paramètres : | | | | --- | --- | | settings | L'instance « otc_publisher_settings » concernée. | | enabled | Active/désactive la création d'une piste audio pour un éditeur otc_publisher_new_with_settings. |

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

otc_publisher_settings_set_auto_gain_control()

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 : | | | | --- | --- | | settings | L'instance otc_publisher_settings concernée. | | enabled | Indique s'il faut activer (true, valeur par défaut) ou désactiver (false) le contrôle automatique du gain. |

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

otc_publisher_settings_set_default_camera_capture_resolution()

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 : | | | | --- | --- | | camera_capture_resolution | Résolution de capture de la caméra pour les capteurs vidéo par défaut. | | settings | Instance « otc_publisher_settings » à modifier. |

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

otc_publisher_settings_set_disable_audio_processing()

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 : | | | | --- | --- | | settings | L'instance « otc_publisher_settings » concernée. | | enabled | Indique s'il faut activer (true) ou désactiver (false, valeur par défaut) la prise en charge du traitement audio. |

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

otc_publisher_settings_set_echo_cancellation()

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 : | | | | --- | --- | | settings | L'instance otc_publisher_settings concernée. | | enabled | Indique s'il faut activer (true, valeur par défaut) ou désactiver (false) la prise en charge de l'annulation de l'écho acoustique. |

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

otc_publisher_settings_set_name()

Définit le nom souhaité pour un éditeur à créer à l'aide de otc_publisher_new_with_settings.

Paramètres : | | | | --- | --- | | settings | L'instance « otc_publisher_settings » concernée. | | name | Le nom de l'éditeur. Les autres clients peuvent récupérer les noms des flux de la session. |

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

otc_publisher_settings_set_noise_suppression()

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 : | | | | --- | --- | | settings | L'instance otc_publisher_settings concernée. | | enabled | Indique s'il faut activer (true, valeur par défaut) ou désactiver (false) la suppression du bruit. |

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

otc_publisher_settings_set_opus_dtx()

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 : | | | | --- | --- | | settings | L'instance « otc_publisher_settings » concernée. | | enabled | Indique s'il faut activer (true) ou désactiver (false, valeur par défaut) la prise en charge d'Opus DTX. |

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

otc_publisher_settings_set_publisher_audio_fallback_enabled()

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 : | | | | --- | --- | | paramètres | Les paramètres de l'éditeur concernés. | | activé | Indique si l'on souhaite activer ou non la fonctionnalité de repli audio. |

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

otc_publisher_settings_set_scalable_screenshare()

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 : | | | | --- | --- | | settings | L'instance « otc_publisher_settings » concernée. | | enabled | Active/désactive l'utilisation de la vidéo évolutive pour les flux de partage d'écran. |

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

otc_publisher_settings_set_stereo()

Permet à un éditeur de créer un flux audio stéréo à l'aide de otc_publisher_new_with_settings.

Paramètres : | | | | --- | --- | | settings | L'instance « otc_publisher_settings » concernée. | | enabled | Active/désactive la prise en charge de l'audio stéréo pour un éditeur à créer avec otc_publisher_new_with_settings. |

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

otc_publisher_settings_set_subscriber_audio_fallback_enabled()

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 OpenTok Media Router. Lorsque la fonctionnalité de repli audio est activée (par défaut), si l'OpenTok 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 : | | | | --- | --- | | paramètres | Les paramètres de l'éditeur concernés. | | activé | Indique si l'on souhaite activer ou non la fonctionnalité de repli audio. |

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

otc_publisher_settings_set_video_capturer()

Définit le capteur vidéo à utiliser pour la création d'un éditeur otc_publisher_new_with_settings.

Paramètres : | | | | --- | --- | | settings | L'instance « otc_publisher_settings » concernée. | | capturer | Le dispositif de capture vidéo. |

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

otc_publisher_settings_set_video_track()

Permet à un éditeur de créer une piste vidéo à l'aide de otc_publisher_new_with_settings.

Paramètres : | | | | --- | --- | | settings | L'instance « otc_publisher_settings » concernée. | | enabled | Active/désactive la création d'une piste vidéo pour un éditeur otc_publisher_new_with_settings. |

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