ApsaraVideo Live:API AliRtcEngine

Crée une instance AliRtcEngine.

static AliEngine *Create(const char *extras);

Quand appeler

Appelez cette méthode pour créer une instance AliRtcEngine avant d'appeler toute autre API du SDK ARTC.

Limites

Le SDK ne prend en charge qu'une seule instance AliRtcEngine par application.

Descriptions des métriques

Valeur de retour

Renvoie un objet singleton de la classe AliEngine.

Détruit l'instance AliRtcEngine.

static void Destroy(AliEngineDestroyCompletionCallback *callback = nullptr);

Cette méthode détruit l'objet singleton AliRtcEngine et libère toutes ses ressources internes. Après l'appel de cette méthode, vous ne pouvez plus utiliser les autres méthodes AliRtcEngine ni aucun rappel. Pour les utiliser à nouveau, vous devez appeler Create afin de créer une nouvelle instance.

Quand appeler

Appelez cette méthode pour libérer l'instance après avoir fini d'utiliser Real-Time Communication.

Limites

Pour éviter les interblocages (deadlocks), n'appelez pas cette méthode dans les rappels du SDK.

Paramètres

Récupère une instance d'interface de fonctionnalité.

virtual int QueryInterface(AliEngineInterfaceIdType iid, void** pInterface) = 0;

Cette méthode récupère une instance d'une interface de fonctionnalité spécifique. Lorsque vous développez des applications pour Real-Time Communication sur la plateforme Windows, de nombreuses fonctionnalités avancées sont fournies via des classes d'interface correspondantes, telles que la gestion des périphériques audio (AliEngineInterfaceAudioDeviceManager), la gestion des périphériques vidéo (AliEngineInterfaceVideoDeviceManager) et le moteur multimédia (AliEngineInterfaceMediaEngine). Avant d'appeler les méthodes associées, vous devez utiliser la méthode QueryInterface pour obtenir des instances de ces interfaces.

Paramètres

Valeur de retour

• 0 : L'appel a réussi.

• <0 : L'appel a échoué.

Active ou désactive le mode de compatibilité H5.

static void SetH5CompatibleMode(bool comp);

Paramètres

Vérifie si le mode de compatibilité H5 est activé.

static bool GetH5CompatibleMode();

Valeur de retour

true : La compatibilité H5 est activée. false : La compatibilité H5 est désactivée.

Définit les rappels de l'écouteur d'événements.

virtual int SetEngineEventListener(AliEngineEventListener *listener) = 0;

Cette méthode définit un écouteur de rappel pour le SDK. En configurant cet écouteur, vous pouvez recevoir divers événements de notification du moteur, tels que l'entrée ou la sortie d'utilisateurs d'un canal, les changements d'état du réseau et l'état des flux audio et vidéo.

Vous devez implémenter la classe AliEngineEventListener pour personnaliser les méthodes d'événement que vous souhaitez écouter. Par défaut, toutes les méthodes ont des implémentations vides, il n'est donc pas nécessaire de toutes les implémenter. Vous pouvez implémenter uniquement les méthodes d'événement dont vous avez besoin.

Rappels associés

Si une exception se produit lors d'une opération, le SDK tente d'abord de récupérer automatiquement grâce à son mécanisme interne de nouvelle tentative. Pour les erreurs qui ne peuvent pas être résolues automatiquement, le SDK notifie votre application via des interfaces de rappel prédéfinies. Voici les principaux rappels pour les problèmes que le SDK ne peut pas gérer et qui nécessitent que votre application les écoute et y réponde :

Paramètres

Valeur de retour

• 0 : Succès.

• Une valeur non nulle : Échec. Cela peut être dû à un paramètre listener invalide ou à une initialisation incorrecte du SDK.

Interroge la version actuelle du SDK.

static const char *GetSDKVersion();

Valeur de retour

Le numéro de version actuel du SDK au format chaîne. Exemple : "2.5.0.x".

Définit le profil du canal.

virtual int SetChannelProfile(const AliEngineChannelProfile channelProfile) = 0;

Cette méthode définit le profil du canal. Elle propose actuellement des profils pour les scénarios d'appel vidéo et les scénarios de diffusion interactive :

• Profil d'appel vidéo : Tous les utilisateurs ont le rôle streamer et peuvent publier et s'abonner à des flux.

• Mode de diffusion interactive : Vous devez appeler la méthode <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#c99c2b257dd8o" id="4e50f781a01e1">SetClientRole</a> pour définir le rôle de l'utilisateur. Définissez le rôle des utilisateurs qui ingèrent des flux dans le canal sur streamer (AliRTCSdkInteractive). Si un utilisateur a seulement besoin de tirer des flux et n'ingère pas de flux, définissez son rôle sur viewer (AliRTCSdkLive). Ce mode est recommandé pour les scénarios RTC.

Quand appeler

Vous ne pouvez appeler cette méthode qu'avant de rejoindre un canal. Vous ne pouvez pas la réinitialiser lorsque vous êtes dans le canal. Vous pouvez la réinitialiser après avoir quitté le canal.

Paramètres

Valeur de retour

• 0 : L'appel de la méthode a réussi.

• Autres valeurs : L'appel de la méthode a échoué.

  • -1 : Le SDK n'est pas initialisé ou a été détruit.

Définit le profil audio.

virtual int SetAudioProfile(int audioProfile, int audioScene) = 0;

Cette méthode définit le profil d'encodage audio et le scénario audio. Pour plus d'informations, consultez Opérations et configurations audio courantes. Le SDK ARTC utilise par défaut le mode haute qualité (AliEngineHighQualityMode) et le mode scénario musical (AliEngineSceneMusicMode). Si les paramètres par défaut ne répondent pas à vos besoins, vous pouvez appeler cette méthode pour les configurer.

Quand appeler

Vous ne pouvez appeler cette méthode qu'avant de rejoindre un canal. Vous ne pouvez pas la réinitialiser après avoir rejoint le canal. Vous pouvez la réinitialiser après avoir quitté le canal.

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Vérifie si le mode actuel est audio uniquement.

virtual bool IsAudioOnlyMode() = 0;

Valeur de retour

true : Le mode actuel est audio uniquement. false : Le mode actuel est audio et vidéo.

Définit le mode sur audio uniquement ou audio et vidéo.

virtual int SetAudioOnlyMode(bool audioOnly) = 0;

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Rejoint un canal.

virtual int JoinChannel(const char *token, const char *channelId, const char *userId, const char *userName) = 0;

Cette méthode permet de rejoindre un canal. Dans ARTC, les utilisateurs sont organisés par canaux. Les utilisateurs doivent rejoindre un canal pour publier ou s'abonner à des flux audio et vidéo. Cette méthode, JoinChannel[2/3] et JoinChannel[3/3] peuvent toutes être utilisées pour rejoindre un canal. Elles diffèrent par leurs méthodes d'authentification et les informations utilisateur qu'elles transmettent, comme suit :

• Cette méthode sert à rejoindre un canal avec un seul paramètre. Vous devez transmettre un jeton généré pour une jointure à paramètre unique en utilisant Authentification basée sur un jeton. Nous vous recommandons d'utiliser cette méthode pour rejoindre un canal dans les scénarios RTC.

• JoinChannel[2/3] sert à rejoindre un canal avec plusieurs paramètres. Vous devez transmettre un jeton multiparamètre généré en utilisant Authentification basée sur un jeton ainsi que les informations utilisateur qui ont servi à générer le jeton.

• JoinChannel[3/3] sert aux scénarios d'interaction en temps réel avec l'IA. Vous devez transmettre un jeton à paramètre unique et définir la propriété utilisateur capabilityProfile en fonction du scénario.

Quand appeler

Appelez cette méthode après avoir créé le moteur.

Limites

• Après avoir rejoint un canal avec succès, pour rejoindre un autre canal, vous devez d'abord appeler LeaveChannel pour quitter le canal actuel. Vous ne pouvez appeler la jointure à un autre canal qu'après avoir reçu le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#b70203f9ea0mz" id="b2522e57e4vom">OnLeaveChannelResult</a>.

• Cette méthode ne prend en charge la jointure qu'à un seul canal à la fois.

• Les applications ayant des ID d'application différents ne peuvent pas communiquer entre elles.

• N'appelez pas cette méthode lors d'une nouvelle tentative après un échec de jointure à un canal.

Rappels associés

Un appel réussi à cette méthode déclenche les rappels suivants :

• Le résultat de la jointure du client local à un canal est renvoyé via le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#7cbf47a35bcel" id="cad6eb9b1bwx7">OnJoinChannelResult</a> de AliRtcEngineEventListener.

• Après avoir rejoint le canal avec succès, le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#3333f6e9d344q" id="fab4a94264m28">OnRemoteUserOnLineNotify</a> est déclenché sur les clients distants.

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Une valeur non nulle : L'appel de la méthode a échoué.

Rejoint un canal.

virtual int JoinChannel(const AliEngineAuthInfo &authInfo,
                                 const char *userName) = 0;

Cette méthode permet de rejoindre un canal. Dans ARTC, les utilisateurs sont organisés par canaux. Les utilisateurs doivent rejoindre un canal pour publier ou s'abonner à des flux audio et vidéo. Cette méthode, JoinChannel[1/3] et JoinChannel[3/3] peuvent toutes être utilisées pour rejoindre un canal. Elles diffèrent par leurs méthodes d'authentification et les informations utilisateur qu'elles transmettent, comme suit :

• JoinChannel[1/3] sert à rejoindre un canal avec un seul paramètre. Vous devez transmettre un jeton généré pour une jointure à paramètre unique en utilisant Authentification basée sur un jeton. Nous vous recommandons d'utiliser cette méthode pour rejoindre un canal dans les scénarios RTC.

• Cette méthode sert à rejoindre un canal avec plusieurs paramètres. Vous devez transmettre un jeton multiparamètre généré en utilisant Authentification basée sur un jeton ainsi que les informations utilisateur qui ont servi à générer le jeton.

• JoinChannel[3/3] sert aux scénarios d'interaction en temps réel avec l'IA. Vous devez transmettre un jeton à paramètre unique et définir la propriété utilisateur capabilityProfile en fonction du scénario.

Limites

• Après avoir rejoint un canal avec succès, pour rejoindre un autre canal, vous devez d'abord appeler LeaveChannel pour quitter le canal actuel. Vous ne pouvez appeler la jointure à un autre canal qu'après avoir reçu le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#b70203f9ea0mz" id="fcd2fac6abf0y">OnLeaveChannelResult</a>.

• Cette méthode ne prend en charge la jointure qu'à un seul canal à la fois.

• Les applications ayant des ID d'application différents ne peuvent pas communiquer entre elles.

Rappels associés

Un appel réussi à cette méthode déclenche les rappels suivants :

• Le client local est notifié du résultat de la jointure à un canal via le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#7cbf47a35bcel" id="b3db8c610ewua">OnJoinChannelResult</a>.

• Après avoir rejoint un canal avec succès, le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#3333f6e9d344q" id="a1297d33bcd92">OnRemoteUserOnLineNotify</a> est déclenché sur les clients distants.

Paramètres

Rejoint un canal.

virtual int JoinChannel(const char *token, const char *channelId, const char *userId, const AliEngineChannelParam &userParam) = 0;

Cette méthode permet de rejoindre un canal. Dans ARTC, les utilisateurs sont organisés par canaux. Ils doivent rejoindre un canal pour publier ou s'abonner aux flux audio et vidéo. Cette méthode, ainsi que JoinChannel[1/3] et JoinChannel[2/3], peuvent toutes être utilisées pour rejoindre un canal. Elles diffèrent par leurs méthodes d'authentification et les informations utilisateur qu'elles transmettent, comme suit :

• JoinChannel[1/3] est une méthode à paramètre unique pour rejoindre un canal dans les scénarios RTC. Vous devez transmettre un jeton généré pour la connexion à paramètre unique en utilisant l'authentification basée sur un jeton. Nous vous recommandons d'utiliser cette méthode pour rejoindre un canal dans les scénarios RTC.

• JoinChannel[2/3] sert à rejoindre un canal avec plusieurs paramètres. Vous devez transmettre un jeton multiparamètre généré à l'aide de l'authentification basée sur un jeton ainsi que les informations utilisateur ayant servi à générer le jeton.

• Cette méthode est destinée aux scénarios d'interaction en temps réel avec l'IA. Vous devez transmettre un jeton à paramètre unique et définir la propriété utilisateur capabilityProfile en fonction du scénario. Pour communiquer avec un agent IA, définissez-la sur AliCapabilityProfileHuman.

Limites

• Après avoir rejoint un canal avec succès, si vous souhaitez rejoindre un autre canal, vous devez d'abord appeler leaveChannel pour quitter le canal actuel. Vous ne pourrez rejoindre à nouveau un canal qu'après avoir reçu le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#b70203f9ea0mz" id="15ec544e3985m">OnLeaveChannelResult</a>.

• Cette méthode permet de rejoindre un seul canal à la fois.

• Les applications ayant des ID d'application différents ne peuvent pas communiquer entre elles.

• N'appelez pas cette méthode lors d'une nouvelle tentative après un échec de connexion à un canal.

Rappels associés

Un appel réussi à cette méthode déclenche les rappels suivants :

• Le résultat de la connexion de l'utilisateur local au canal est fourni via le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#7cbf47a35bcel" id="5d109191c950l">OnJoinChannelResult</a>.

• Une fois que vous avez rejoint le canal avec succès, le client distant déclenche le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#3333f6e9d344q" id="fa6f8d9357glx">OnRemoteUserOnLineNotify</a>.

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Une valeur différente de zéro : L'appel de la méthode a échoué.

Vous pouvez quitter le canal.

virtual int LeaveChannel() = 0;

Après avoir appelé cette méthode, le SDK met fin à l'appel audio et vidéo et quitte le canal actuel.

Quand appeler

• Appelez cette méthode pour quitter un canal.

• Vous devez appeler cette méthode pour quitter le canal actuel avant d'en rejoindre un nouveau.

Rappels associés

• L'appel de cette méthode déclenche le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#b70203f9ea0mz" id="9626ae24d89ue">OnLeaveChannelResult</a> sur le client local, qui indique si le client a bien quitté le canal.

• Utilisateurs distants : Un appel réussi à cette API déclenche le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#44ce12a0ecj52" id="0dfcab6a6fylt">OnRemoteUserOffLineNotify</a>.

Description de la réponse

Une valeur de 0 indique que l'appel de la méthode a réussi. Toute autre valeur indique que l'appel de la méthode a échoué.

Vérifie si l'utilisateur se trouve actuellement dans un canal.

virtual bool IsInCall() = 0;

Valeur de retour

true : L'utilisateur se trouve dans un canal. false : L'utilisateur ne se trouve pas dans un canal.

Définit le rôle de l'utilisateur.

virtual int SetClientRole(const AliEngineClientRole clientRole) = 0;

Cette méthode définit le rôle de l'utilisateur en tant que streamer (diffuseur) ou viewer (spectateur).

En mode de diffusion interactive, avant de rejoindre un canal :

• Si vous définissez le rôle de l'utilisateur sur streamer, le SDK publie automatiquement les flux audio et vidéo locaux et reçoit par défaut les flux audio et vidéo des autres streamers.

• Si vous définissez le rôle de l'utilisateur sur viewer, le SDK ne publie pas les flux audio et vidéo locaux, mais reçoit les flux audio et vidéo des autres streamers.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal. Appelez-la avant la connexion pour définir le rôle de l'utilisateur, ou après la connexion pour changer de rôle.

Limites

Cette méthode n'est effective qu'en mode de diffusion interactive. Cela signifie que vous devez appeler la méthode <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#901e748242y3g" id="322c3da902jpt">SetChannelProfile</a> et définir le profil du canal sur AliEngineInteractiveLive.

En mode de diffusion interactive, nous vous recommandons d'appeler explicitement cette méthode pour définir le rôle de l'utilisateur avant de rejoindre un canal.

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Récupère le type de rôle actuel de l'utilisateur (streamer ou viewer).

virtual AliEngineClientRole GetClientRole() = 0;

Valeur de retour

Si l'appel de la méthode réussit, il renvoie un objet AliEngineClientRole. Il s'agit d'un type d'énumération indiquant que le rôle est soit streamer (0), soit viewer (1).

Actualise les informations d'authentification.

virtual int RefreshAuthInfo(const AliEngineAuthInfo &authInfo) = 0;

Cette méthode met à jour les informations d'authentification. Le jeton expire après une certaine période. Lorsque le jeton expire, le SDK ne peut plus se connecter au serveur.

Quand appeler

Dans les situations suivantes :

• Lorsque vous recevez le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#9f8ebe177degw" id="f52a19bb78yoi">OnAuthInfoWillExpire</a>, indiquant que les informations d'authentification sont sur le point d'expirer, nous vous recommandons de régénérer un jeton sur votre serveur, puis d'appeler cette méthode avec le nouveau jeton.

• Si vous ne mettez pas à jour le jeton à temps, le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#09c4ec9160eom" id="440c501877fxr">OnAuthInfoExpired</a> est déclenché pour vous notifier que l'authentification a expiré. Vous devez alors régénérer le jeton et appeler JoinChannel pour rejoindre à nouveau le canal.

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Actualise les informations d'authentification.

virtual int RefreshAuthInfo(const char *token) = 0;

Cette méthode met à jour le jeton. Le jeton expire après une certaine période. Lorsque le jeton expire, le SDK ne peut plus se connecter au serveur.

Quand appeler

Dans les situations suivantes, nous vous recommandons de régénérer le jeton sur votre serveur, puis d'appeler cette méthode pour transmettre le nouveau jeton :

• Lorsque vous recevez le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#9f8ebe177degw" id="b21949148djrc">OnAuthInfoWillExpire</a>, indiquant que les informations d'authentification sont sur le point d'expirer.

• Si le jeton n'est pas mis à jour à temps, le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#09c4ec9160eom" id="62df9bf63786v">OnAuthInfoExpired</a> est déclenché pour indiquer que l'authentification a expiré. Dans ce cas, vous devez appeler JoinChannel pour rejoindre à nouveau le canal.

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Active ou désactive la publication du flux audio local.

virtual int PublishLocalAudioStream(bool enabled) = 0;

Cette méthode contrôle la publication du flux audio collecté localement. Le SDK publie le flux audio par défaut. Si vous ne souhaitez pas publier le flux audio par défaut, vous pouvez appeler PublishLocalAudioStream(false) avant de rejoindre le canal pour désactiver la publication du flux audio.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal. Si vous l'appelez avant de rejoindre un canal, vous modifiez la configuration par défaut, qui prend effet lors de la connexion au canal.

Rappels associés

Lorsque l'état de la diffusion du flux audio local change, le client local déclenche le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#eb8fab7f5ak7v" id="c584949653jn5">OnAudioPublishStateChanged</a> pour signaler le dernier état de la diffusion du flux audio. Le client distant déclenche le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#ff1f7c8581r3r" id="75f2096b1efxy">OnRemoteTrackAvailableNotify</a> pour signaler les modifications apportées aux flux audio et vidéo de l'utilisateur distant.

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Interroge si la publication du flux audio est actuellement autorisée.

virtual bool IsLocalAudioStreamPublished() = 0;

Valeur de retour

true : La publication est autorisée. false : La publication n'est pas autorisée.

Définit s'il faut s'abonner aux flux audio distants par défaut.

virtual int SetDefaultSubscribeAllRemoteAudioStreams(bool sub) = 0;

Cette méthode configure l'abonnement par défaut aux flux audio des utilisateurs distants. Ce paramètre affecte le comportement d'abonnement aux flux audio pour les nouveaux utilisateurs qui rejoignent le canal. Nous vous recommandons de le définir sur true, sauf si vous avez des exigences particulières.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal.

• Avant de rejoindre un canal :

  • Le SDK s'abonne par défaut aux flux audio des utilisateurs distants lorsque vous rejoignez un canal. Si vous souhaitez modifier ce comportement, appelez cette méthode avant de rejoindre le canal.

• Après avoir rejoint un canal :

  • Si vous souhaitez arrêter l'abonnement par défaut, appelez <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e51a461de2k9t" id="e95a7e2d6fjwt">SetDefaultSubscribeAllRemoteAudioStreams</a>(false). Vous ne vous abonnerez alors pas aux flux audio des utilisateurs qui rejoindront le canal ultérieurement.

  • Après avoir arrêté l'abonnement par défaut, vous pouvez appeler <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#957e547813q56" id="1a391bcabc66e">SubscribeRemoteAudioStream</a> pour reprendre l'abonnement au flux audio d'un utilisateur spécifique. Si vous souhaitez reprendre l'abonnement pour plusieurs utilisateurs, vous devez appeler cette méthode plusieurs fois.

  • Après avoir arrêté l'abonnement par défaut, l'appel à <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e51a461de2k9t" id="e79b5ad58awcw">SetDefaultSubscribeAllRemoteAudioStreams</a>(true) reprend l'abonnement uniquement pour les flux audio des utilisateurs qui rejoignent le canal par la suite. Il ne s'abonne pas aux flux des utilisateurs distants qui ont rejoint le canal pendant que l'abonnement était arrêté.

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Arrête ou reprend l'abonnement au flux audio d'un utilisateur distant spécifique.

virtual int SubscribeRemoteAudioStream(const char* uid, bool sub) = 0;

Cette méthode arrête ou reprend l'abonnement au flux audio d'un utilisateur distant spécifique. Nous vous recommandons de le définir sur true, sauf si vous avez des exigences particulières.

Paramètres

Description de la réponse

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Arrête ou reprend la réception de tous les flux audio distants.

virtual int SubscribeAllRemoteAudioStreams(bool sub) = 0;

Cette méthode est l'interrupteur principal pour l'abonnement aux flux audio distants. Nous vous recommandons de le définir sur true. Si vous le définissez sur false, les événements suivants se produisent :

• L'abonnement à tous les flux audio distants dans le canal actuel est arrêté.

• Les utilisateurs qui rejoignent le canal ultérieurement ne seront pas non plus abonnés.

• Vous ne pouvez pas utiliser <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#957e547813q56" id="aface4ad3920l">SubscribeRemoteAudioStream</a> pour contrôler le flux audio d'un utilisateur spécifique.

Pour vous réabonner, appelez à nouveau cette méthode et définissez-la sur true pour reprendre l'abonnement.

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Publie ou arrête la publication du flux de la caméra.

virtual int PublishLocalVideoStream(bool enabled) = 0;

Cette méthode contrôle la publication du flux vidéo collecté localement.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal.

Si vous l'appelez avant de rejoindre un canal, vous modifiez la configuration par défaut, qui prend effet lors de la connexion au canal.

Rappels associés

Lorsque l'état de la diffusion du flux audio local change, le client local déclenche le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#6bf4efbd1cadl" id="d37709b09147d">OnVideoPublishStateChanged</a> pour signaler le nouvel état de la diffusion du flux audio, et le client distant déclenche le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#ff1f7c8581r3r" id="f16e4b51bchqb">OnRemoteTrackAvailableNotify</a> pour signaler les modifications apportées aux flux audio et vidéo de l'utilisateur distant.

Paramètres

Valeur de retour

• 0 : L'appel de la méthode a réussi.

• <0 : L'appel de la méthode a échoué.

Active ou désactive l'envoi du flux vidéo.

virtual int PublishLocalVideoStream(bool enabled, AliEngineVideoTrack track) = 0;

Cette méthode contrôle la publication du flux vidéo collecté localement.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal.

Si vous l'appelez avant de rejoindre un canal, vous modifiez la configuration par défaut, qui prend effet lors de la connexion au canal.

Rappels associés

Lorsque l'état de la diffusion du flux vidéo local change, le client local déclenche le rappel <a baseurl="t2713962_v5_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#6bf4efbd1cadl" id="18a9d4b47ezcc">OnVideoPublishStateChanged</a> pour signaler le dernier état de la diffusion du flux vidéo. Le client distant déclenche le rappel <a baseurl="t2713962_v5_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#ff1f7c8581r3r" id="d01e7a574f92o">OnRemoteTrackAvailableNotify</a> pour notifier que les flux audio et vidéo de l'utilisateur distant ont changé.

Paramètres

Retourne

• 0 : L'appel de la méthode a réussi.

• <0 : L'appel de la méthode a échoué.

Interroge si la publication du flux vidéo est actuellement autorisée.

virtual bool IsLocalVideoStreamPublished() = 0;

Valeur de retour

true : Le flux de la caméra est publié. false : Le flux de la caméra n'est pas publié.

Définit s'il faut recevoir les flux vidéo par défaut.

virtual int SetDefaultSubscribeAllRemoteVideoStreams(bool sub) = 0;

Cette méthode définit s'il faut s'abonner aux flux vidéo par défaut. Le SDK s'abonne par défaut.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal.

• Avant de rejoindre un canal :

  • Vous pouvez utiliser cette méthode pour annuler le paramètre d'abonnement par défaut.

• Après avoir rejoint un canal :

  • Pour arrêter l'abonnement par défaut, appelez SetDefaultSubscribeAllRemoteVideoStreams(false). Cela empêchera l'abonnement aux flux vidéo des utilisateurs qui rejoindront le canal ultérieurement.

  • Après avoir arrêté l'abonnement par défaut, si vous souhaitez reprendre l'abonnement au flux vidéo d'un utilisateur spécifique, appelez la méthode SubscribeRemoteVideoStream. Pour reprendre l'abonnement pour plusieurs utilisateurs, vous devez l'appeler plusieurs fois.

  • Après l'arrêt de l'abonnement par défaut, un appel à SetDefaultSubscribeAllRemoteVideoStreams(false) reprend uniquement les flux audio des utilisateurs qui rejoignent le canal ultérieurement.

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Interrompt ou reprend l'abonnement au flux vidéo d'un utilisateur distant.

virtual int SubscribeRemoteVideoStream(const char* uid, AliEngineVideoTrack track, bool sub) = 0;

Cette méthode permet de s'abonner ou de se désabonner du flux vidéo d'un utilisateur spécifique.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal.

Paramètres

Valeur de retour

• true : Le paramétrage a réussi.

• false : Le paramétrage a échoué.

Interrompt ou reprend la réception de tous les flux vidéo distants.

virtual int SubscribeAllRemoteVideoStreams(bool sub) = 0;

Cette méthode constitue le commutateur principal pour l'abonnement aux flux vidéo distants. Si vous la définissez sur false, les événements suivants se produisent :

• L'abonnement à tous les flux vidéo distants dans le canal actuel est interrompu.

• Les flux vidéo des nouveaux utilisateurs qui rejoignent ultérieurement le canal ne seront pas non plus reçus, même si vous avez appelé <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#2cbc54790brn3" id="b7b0080f3cnoq">SetDefaultSubscribeAllRemoteVideoStreams</a>(true) pour activer l'abonnement par défaut.

• Vous ne pouvez pas utiliser <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#jyGTp" id="0e2edf97aa1g6">SubscribeRemoteVideoStream</a> pour contrôler indépendamment le flux audio d'un utilisateur spécifié.

Pour vous réabonner, appelez à nouveau cette méthode et définissez-la sur true pour reprendre l'abonnement.

Paramètres

Description de la réponse

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Interrompt ou reprend le flux multimédia d'un utilisateur distant spécifique.

virtual int SubscribeRemoteMediaStream(const char* uid, AliEngineVideoTrack videoTrack, bool subVideo,  bool subAudio) = 0;

Cette méthode permet de s'abonner simultanément aux flux audio et vidéo distants.

Méthodes associées

Contrairement à SubscribeRemoteMediaStream[2/2], cette méthode utilise deux paramètres booléens, subVideo et subAudio, pour déterminer s'il faut s'abonner aux flux audio et vidéo distants. Le paramètre videoTrack contrôle le flux vidéo à extraire.

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Interrompt ou reprend le flux multimédia d'un utilisateur distant spécifique.

virtual int SubscribeRemoteMediaStream(const char* uid, AliEngineVideoTrack videoTrack, AliEngineAudioTrack audioTrack) = 0;

Cette méthode permet de s'abonner simultanément aux flux audio et vidéo distants.

Méthodes associées

Contrairement à SubscribeRemoteMediaStream[1/2], cette méthode utilise les paramètres videoTrack et audioTrack pour informer le SDK de l'état d'abonnement souhaité en un seul appel. Par exemple :

• Pour s'abonner au flux de la caméra et au flux du microphone, définissez respectivement videoTrack et audioTrack sur AliRtcVideoTrackCamera et AliRtcAudioTrackMic lors de l'appel de la méthode.

• Pour se désabonner du flux de la caméra tout en conservant le flux du microphone, appelez à nouveau la méthode et définissez respectivement videoTrack et audioTrack sur AliRtcVideoTrackNo et AliRtcAudioTrackMic.

• Pour annuler les deux abonnements, appelez à nouveau la méthode et définissez respectivement videoTrack et audioTrack sur AliRtcVideoTrackNo et AliRtcAudioTrackNo.

• Pour s'abonner simultanément au flux de la caméra et au flux de partage d'écran, définissez videoTrack sur AliRtcVideoTrackBoth. Le même principe s'applique à l'audio.

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

S'abonne au flux d'un utilisateur spécifié entre canaux.

virtual int SubscribeRemoteDestChannelStream(const char* channelId, const char* uid, AliEngineVideoTrack track, bool sub_audio, bool sub) = 0;

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Ajuste le volume de lecture d'un utilisateur distant spécifié.

virtual int SetRemoteAudioVolume(const char *uid, int volume) = 0;

Paramètres

Valeur de retour

• 0 : Succès.

• Une valeur non nulle : Échec.

Interrompt ou reprend l'envoi des données audio locales.

virtual int MuteLocalMic(bool mute, AliEngineMuteLocalAudioMode mode = AliEngineMuteLocalAudioModeDefault) = 0;

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal.

Rappels associés

Après un appel réussi, le rappel <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#a15f0a6cf6id7" id="f4ae88f094vqy">OnUserAudioMuted</a> est déclenché sur les clients distants pour indiquer si l'utilisateur est en sourdine.

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Interrompt ou reprend la lecture de l'audio distant.

virtual int MuteRemoteAudio(const char *uid,
                                    bool mute) = 0;

Cette API sert uniquement à interrompre ou reprendre la lecture audio pour un utilisateur distant spécifié. Elle n'affecte pas l'extraction du flux ni le décodage de l'audio distant. Pour se désabonner du flux audio d'un utilisateur, appelez <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#957e547813q56" id="89841a0989t7y">SubscribeRemoteAudioStream</a>.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal.

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Interrompt ou reprend la lecture des pistes audio de tous les utilisateurs distants.

virtual int MuteAllRemoteAudio(bool mute) = 0;

Utilisez cette méthode pour interrompre ou reprendre toute la lecture audio distante.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal.

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Une valeur non nulle : L'appel de la méthode a échoué.

Démarre la collecte audio.

virtual int StartAudioCapture() = 0;

Cette méthode démarre la collecte audio. Vous pouvez également l'appeler avant de rejoindre un canal pour anticiper le démarrage de la collecte audio. Si elle n'est pas configurée, le SDK contrôle automatiquement le périphérique de collecte audio. Pour démarrer la collecte audio après qu'elle a été arrêtée par un appel à stopAudioCapture, appelez cette méthode.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal.

Méthodes associées

• La méthode StartAudioCapture[2/2] permet de contrôler si le périphérique de collecte audio reste activé après avoir quitté le canal, via un paramètre.

Rappels associés

Après avoir appelé cette méthode pour modifier l'état de la collecte audio locale, vous pouvez récupérer le changement d'état via le rappel OnLocalAudioStateChange.

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Démarre la collecte audio.

virtual int StartAudioCapture(bool keepAlive) = 0;

Arrête la capture audio du microphone après la mise en sourdine.

Cette méthode démarre la collecte audio. Vous pouvez également l'appeler avant de rejoindre un canal pour anticiper le démarrage de la collecte audio. Si elle n'est pas configurée, le SDK contrôle automatiquement le périphérique de collecte audio.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal.

Méthodes associées

Contrairement à StartAudioCapture[1/2], cette méthode vous permet de contrôler si le périphérique de collecte reste activé après avoir quitté le canal, grâce au paramètre keepAlive.

Rappels associés

Après avoir appelé cette méthode pour modifier l'état de la collecte audio locale, vous pouvez récupérer le changement d'état via le rappel OnLocalAudioStateChange.

Paramètres

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Arrête la collecte audio.

virtual int StopAudioCapture() = 0;

Après avoir démarré la collecte du périphérique audio avec StartAudioCapture, vous pouvez appeler cette méthode pour l'arrêter.

Rappels associés

Après avoir appelé cette méthode pour modifier l'état de la collecte audio locale, vous pouvez récupérer le changement d'état via le rappel OnLocalAudioStateChange.

Valeur de retour

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Définit la fréquence du rappel de volume et le coefficient de lissage.

virtual int EnableAudioVolumeIndication(int interval, int smooth, int reportVad) = 0;

Cette méthode permet au SDK de signaler périodiquement à l'application les informations relatives au volume des utilisateurs locaux publiant du contenu et de l'utilisateur distant ayant le volume instantané le plus élevé.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal.

Rappels associés

Après un appel réussi à cette méthode, si des utilisateurs publient du contenu dans le canal, le SDK déclenche les deux rappels suivants à l'intervalle de temps défini :

• Le volume audio de l'interlocuteur est signalé via le rappel OnAudioVolumeCallback. La fréquence du rappel est déterminée par le paramètre interval.

• Détection d'activité vocale. Lorsqu'un utilisateur actif est détecté, l'UID de l'interlocuteur est signalé via le rappel OnActiveSpeaker.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal.

Paramètres

Description de la réponse

0 : L'appel de la méthode a réussi. Autres valeurs : L'appel de la méthode a échoué.

Démarre le périphérique de lecture audio.

virtual int StartAudioPlayer() = 0;

Cette méthode permet de démarrer la lecture audio à l'avance. Si elle n'est pas configurée, le SDK démarre automatiquement la lecture audio après s'être abonné à un flux audio.

Valeur de retour

• 0 : Succès.

• Une valeur non nulle : Échec. Un code d'erreur est renvoyé.

Arrête la lecture audio.

virtual int StopAudioPlayer() = 0;

Cette méthode permet d'arrêter la lecture audio. Elle correspond à AliEngine::StartAudioPlayer.

Paramètres

Aucun.

Valeur de retour

• 0 : Succès.

• Une valeur non nulle : Échec. Un code d'erreur est renvoyé.

Définit le volume de lecture.

virtual int SetPlayoutVolume(int volume) = 0;

Paramètres

Valeur de retour

• 0 : Succès.

• Une valeur non nulle : Échec. Un code d'erreur est renvoyé.

virtual int SetRecordingVolume(int volume) = 0;

Paramètres

Description de la réponse

• 0 : Succès.

• Une valeur non nulle : Échec. Un code d'erreur est renvoyé.

Lit un fichier audio.

virtual int PlayAudioFileTest(const char* filePath) = 0;

Paramètres

Valeur de retour

• 0 : Succès.

• <0 : Échec.

Arrête la lecture du fichier audio.

virtual int StopAudioFileTest() = 0;

Valeur de retour

• 0 : Succès.

• <0 : Échec.

Démarre un test de capture audio avant un appel.

virtual int StartAudioCaptureTest() = 0;

Cette méthode permet de démarrer un test de capture audio. Vous pouvez utiliser le résultat du rappel AliEngineEventListener::OnTestAudioVolumeCallback pour déterminer si la capture audio fonctionne correctement.

Valeur de retour

• 0 : Succès.

• <0 : Échec.

Arrête le test de capture audio.

virtual int StopAudioCaptureTest() = 0;

Valeur de retour

• 0 : Succès.

• <0 : Échec.

Active ou désactive la capture et la publication audio du système.

virtual int EnableSystemAudioRecording(bool enable, const char *path = nullptr, const char *device_id = nullptr) = 0;

Cette méthode active ou désactive la capture audio du système, telle que les sons émis par les navigateurs et les applications.

Paramètres

Valeur de retour

• 0 : L'appel de méthode a réussi.

• <0 : L'appel de méthode a échoué.

Vérifie si la capture et la publication audio du système sont actuellement activées.

virtual bool IsSystemAudioRecording() = 0;

Valeur de retour

• true : Activé.

• false : Désactivé.

Définit le volume de capture et de publication audio du système.

virtual int SetSystemAudioRecordingVolume(int volume) = 0;

Cette méthode n'est valide que sur les plateformes Windows et macOS.

Ce paramètre ne peut être défini qu'après l'activation de la capture et de la publication audio du système. Sinon, le paramètre est ignoré.

Paramètres

Valeur de retour

• 0 : Succès.

• <0 : Échec.

Récupère le volume actuel de capture et de publication audio du système.

virtual int GetSystemAudioRecordingVolume() = 0;

Cette méthode n'est valide que sur les plateformes Windows et macOS.

Valeur de retour

Le volume de publication de la capture système.

Définit le volume de lecture audio du système.

virtual int SetSystemAudioPlayoutVolume(int volume) = 0;

Cette méthode n'est valide que sur les plateformes Windows et macOS.

Ce paramètre ne peut être défini qu'après l'activation de la capture et de la publication audio du système. Sinon, le paramètre est ignoré.

Paramètres

Valeur de retour

• 0 : Succès.

• <0 : Échec.

Récupère le volume actuel de lecture audio du système.

virtual int GetSystemAudioPlayoutVolume() = 0;

Cette méthode n'est valide que sur les plateformes Windows et macOS.

Valeur de retour

Le système suit le volume de lecture.

Récupère la liste des périphériques d'enregistrement du système.

virtual AliEngineDeviceInfoList* GetAudioCaptureList() = 0;

Valeur de retour

Un pointeur vers la liste des périphériques d'enregistrement, AliEngineDeviceInfoList *.

Récupère le nom du périphérique d'enregistrement utilisé.

virtual String GetCurrentAudioCaptureName() = 0;

Valeur de retour

Le nom du périphérique de capture audio actuel.

Récupère l'ID du périphérique d'enregistrement utilisé.

virtual String GetCurrentAudioCaptureID() = 0;

Valeur de retour

L'ID du périphérique d'enregistrement actuellement utilisé.

Sélectionne un périphérique d'enregistrement par son nom.

virtual int SetCurrentAudioCaptureName(const char* captureName) = 0;

Paramètres

Valeur de retour

0 en cas de succès, autres valeurs en cas d'échec.

Sélectionne un périphérique d'enregistrement par son ID.

virtual int SetCurrentAudioCaptureID(const char* captureID) = 0;

Paramètres

Valeur de retour

0 en cas de succès, autres valeurs en cas d'échec.

Récupère la liste des haut-parleurs du système.

virtual AliEngineDeviceInfoList* GetAudioPlayerList() = 0;

Valeur de retour

Un pointeur vers la liste des haut-parleurs du système, AliEngineDeviceInfoList *.

Récupère la liste des haut-parleurs enregistrables du système (pour l'enregistrement interne au système).

virtual AliEngineDeviceInfoList* GetSystemRecordAudioPlayerList() = 0;

Valeur de retour

La liste des périphériques de lecture audio est principalement utilisée comme dernier paramètre pour EnableSystemAudioRecording afin de capturer l'audio de lecture du système.

Récupère le nom du haut-parleur actuellement utilisé.

virtual String GetCurrentAudioPlayerName() = 0;

Valeur de retour

Le nom du périphérique de lecture audio actuel.

Récupère l'ID du haut-parleur actuellement utilisé.

virtual String GetCurrentAudioPlayerID() = 0;

Valeur de retour

L'ID du périphérique de lecture audio actuel.

Sélectionne un haut-parleur par son nom.

virtual int SetCurrentAudioPlayerName(const char* playerName) = 0;

Valeur de retour

Le nom du périphérique de lecture audio.

Sélectionne un haut-parleur par son ID.

virtual int SetCurrentAudioPlayerID(const char* playerID) = 0;

Paramètres

Valeur de retour

0 en cas de succès, autres valeurs en cas d'échec.

Définit le volume du périphérique de capture audio. La plage de volume est [0, 100].

virtual int SetRecordingDeviceVolume(int volume) = 0;

Liste des paramètres

Valeur de retour

0 en cas de succès, autres valeurs en cas d'échec.

Récupère le volume du périphérique de capture audio.

virtual int GetRecordingDeviceVolume() = 0;

Valeur de retour

>=0 renvoie le volume. Les autres valeurs indiquent un échec.

Définit le volume du périphérique de lecture audio. La plage de volume est [0, 100].

virtual int SetPlaybackDeviceVolume(int volume) = 0;

Paramètres

Valeur de retour

0 en cas de succès, autres valeurs en cas d'échec.

Récupère le volume du périphérique de lecture audio.

virtual int GetPlaybackDeviceVolume() = 0;

Valeur de retour

>=0 pour le volume système. Autres valeurs pour un échec.

Coupe le son du périphérique de capture audio.

virtual int SetRecordingDeviceMute(bool mute) = 0;

Paramètres

Valeur de retour

0 en cas de succès, autres valeurs en cas d'échec.

Récupère l'état de mise en sourdine du périphérique de capture audio.

virtual bool GetRecordingDeviceMute() = 0;

Valeur de retour

Indique si l'enregistrement est en sourdine.

Coupe le son du périphérique de lecture audio.

virtual int SetPlaybackDeviceMute(bool mute) = 0;

Paramètres

Valeur de retour

0 en cas de succès, autres valeurs en cas d'échec.

Récupère l'état de mise en sourdine du périphérique de lecture audio.

virtual bool GetPlaybackDeviceMute() = 0;

Valeur de retour

Indique si le périphérique de lecture est en sourdine.

Définit le mode d'effet de modification de la voix.

virtual int SetAudioEffectVoiceChangerMode(const AliEngineAudioEffectVoiceChangerMode &mode) = 0;

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Définit le paramètre de hauteur tonale.

virtual int SetAudioEffectPitchValue(double value) = 0;

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Définit le mode d'effet de réverbération.

virtual int SetAudioEffectReverbMode(const AliEngineAudioEffectReverbMode& mode) = 0;

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Définit le type d'effet de réverbération et les paramètres spécifiques.

virtual int SetAudioEffectReverbParamType(const AliEngineAudioEffectReverbParamType& type,
                                                  float value) = 0;

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Définit le mode d'effet sonore d'embellissement prédéfini.

virtual int SetAudioEffectBeautifyMode(const AliEngineAudioEffectBeautifyMode& mode) = 0;

Cette méthode définit les modes d'embellissement prédéfinis au sein du SDK. Elle convient aux scénarios nécessitant l'embellissement de la qualité vocale humaine, tels que le streaming vocal en direct, le karaoké et les réseaux sociaux vocaux. En sélectionnant différents modes d'embellissement, vous pouvez modifier l'effet auditif de la voix humaine, par exemple en renforçant le magnétisme ou en améliorant la clarté. Cela améliore l'expérience d'écoute des utilisateurs distants.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal.

Paramètres

Valeur de retour

• 0 : Le paramétrage a réussi.

• Une valeur non nulle : Le paramétrage a échoué.

Définit les paramètres de l'égaliseur audio (EQ) pour ajuster le gain d'une bande de fréquence spécifiée.

virtual int SetAudioEffectEqualizationParam(const AliEngineAudioEffectEqualizationBandFrequency &bandIndex, float gain) = 0;

Cette méthode ajuste la voix humaine ou le signal audio collecté localement à l'aide d'un égaliseur graphique. En ajustant le gain (en dB) de l'une des 10 bandes de fréquence fixes, vous pouvez personnaliser le timbre. Elle convient aux scénarios tels que l'optimisation de la clarté vocale, l'amélioration de la voix humaine et l'aide à la réduction du bruit.

L'égaliseur prend en charge l'ajustement de tout le spectre audio de 31 Hz à 16 kHz, avec un total de 10 bandes de fréquence standard. La valeur de gain pour chaque bande peut être définie indépendamment, allant de [-15, 15] dB, avec une valeur par défaut de 0 dB (ni amplification ni atténuation).

Limites

• L'égaliseur ne peut pas être utilisé seul avant l'activation du mode d'embellissement. Vous devez appeler cette méthode après avoir appelé setAudioEffectBeautifyMode.

Paramètres

Description de la réponse

0 : Le paramétrage a réussi.

Une valeur non nulle : Le paramétrage a échoué.

Ajoute un flux audio externe.

virtual int AddExternalAudioStream(const AliEngineExternalAudioStreamConfig& config) = 0;

Cette méthode ajoute un nouveau flux audio externe. Les étapes sont les suivantes :

1. Appelez <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#991b862eb353w" id="08ee3d1ed35jj">AddExternalAudioStream</a> pour ajouter un flux audio externe et obtenir l'ID du flux audio externe.

2. Appelez <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e6cf3f7cef0g6" id="fae817d0f00p3">PushExternalAudioStreamRawData</a> pour pousser les données audio vers le flux audio créé.

3. Lorsque l'appel se termine, vous devez appeler <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#u27oe" id="3b9a3eb119umh">RemoveExternalAudioStream</a> pour supprimer le flux audio externe.

Pour plus d'informations sur la publication d'audio personnalisé collecté dans un canal, consultez Custom audio collection.

Paramètres

Valeur de retour

Une valeur supérieure à 0 indique un appel de méthode réussi et renvoie l'ID du flux audio externe. Les autres valeurs indiquent un appel de méthode échoué.

Injecte des données de flux audio externe.

virtual int PushExternalAudioStreamRawData(int streamId, AliEngineAudioRawData& data) = 0;

Cette méthode transmet des données dans le flux audio spécifié. Les étapes sont les suivantes :

1. Appelez l'API <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#991b862eb353w" id="3836ac109732c">AddExternalAudioStream</a> pour ajouter un flux audio externe et obtenir l'ID du flux audio externe.

2. Appelez PushExternalAudioStreamRawData pour transmettre les données audio dans le flux audio créé.

3. Lorsque l'appel se termine, vous devez appeler <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#u27oe" id="398ea88d61fn0">RemoveExternalAudioStream</a> pour supprimer le flux audio externe.

Pour plus d'informations sur la publication d'audio personnalisé collecté dans un canal, consultez Custom audio collection.

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Définit le volume de publication du flux audio externe.

virtual int SetExternalAudioStreamPublishVolume(int streamId, int vol) = 0;

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Définit le volume de publication du flux audio externe.

virtual int SetExternalAudioStreamPlayoutVolume(int streamId, int vol) = 0;

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Récupère le volume de publication du flux audio externe.

virtual int GetExternalAudioStreamPublishVolume(int streamId) = 0;

Paramètres

Renvoie

[0, 100] : Le volume de publication. Une valeur inférieure à 0 indique un échec.

Récupère le volume de lecture du flux audio externe.

virtual int GetExternalAudioStreamPlayoutVolume(int streamId) = 0;

Paramètres

Valeur de retour

[0, 100] : le volume de lecture. Une valeur inférieure à 0 indique un échec.

Supprime un flux audio externe.

virtual int RemoveExternalAudioStream(int streamId) = 0;

Cette méthode supprime le flux audio externe correspondant en fonction du paramètre streamId transmis. Elle correspond à la méthode AddExternalAudioStream.

Quand appeler

Si vous souhaitez utiliser la fonctionnalité d'entrée audio personnalisée, vous devez appeler la méthode AddExternalAudioStream pour ajouter un flux audio et obtenir l'ID du flux audio externe. Vous pouvez ensuite appeler l'interface <a baseurl="t2713962_v4_0_0.xdita" data-node="4904760" data-root="16090" data-tag="xref" href="#e6cf3f7cef0g6" id="bdab74f108i1p">PushExternalAudioStreamRawData</a> pour transmettre vos données audio au SDK. Lorsque vous souhaitez arrêter l'entrée audio personnalisée, appelez cette interface pour supprimer le flux audio externe correspondant et libérer les ressources.

Paramètres

Valeur de retour

0 en cas de succès, toute autre valeur en cas d'échec.

Récupère les informations d'un fichier audio.

virtual int GetAudioFileInfo(const char *filePath) = 0;

Il s'agit d'une méthode asynchrone. Vous pouvez récupérer les informations du fichier audio via AliEngineEventListener::OnAudioFileInfo.

Paramètres

Valeur de retour

• 0 : Succès.

• Une valeur non nulle : Échec. Un code d'erreur est renvoyé.

Démarre le mixage audio pour l'accompagnement.

virtual int StartAudioAccompany(const char *filePath, const AliEngineAudioAccompanyConfig& config) = 0;

Il s'agit d'une méthode asynchrone. Vous pouvez écouter l'état du lecteur d'accompagnement audio via AliEngineEventListener::OnAudioAccompanyStateChanged.

Paramètres

Valeur de retour

• 0 : Succès.

• Une valeur non nulle : Échec. Un code d'erreur est renvoyé.

Arrête le mixage audio pour l'accompagnement.

virtual int StopAudioAccompany() = 0;

Valeur de retour

• 0 : Succès.

• Une valeur non nulle : Échec. Un code d'erreur est renvoyé.

Définit le volume de l'accompagnement.

 virtual int SetAudioAccompanyVolume(int volume) = 0;

Paramètres

Valeur de retour

• 0 : Succès.

• Une valeur non nulle : Échec. Un code d'erreur est renvoyé.

Définit le volume de publication de l'accompagnement.

virtual int SetAudioAccompanyPublishVolume(int volume) = 0;

Paramètres

Valeur de retour

• 0 : Succès.

• Une valeur non nulle : Échec. Un code d'erreur est renvoyé.

Récupère le volume de publication de l'accompagnement.

virtual int GetAudioAccompanyPublishVolume() = 0;

Valeur de retour

Le volume de publication de l'accompagnement. La plage est [0-100].

Définit le volume de lecture local pour l'accompagnement.

virtual int SetAudioAccompanyPlayoutVolume(int volume) = 0;

Paramètres

Valeur de retour

• 0 : Succès.

• Une valeur non nulle : Échec. Un code d'erreur est renvoyé.

Récupère le volume de lecture local pour l'accompagnement.

virtual int GetAudioAccompanyPlayoutVolume() = 0;

Valeur de retour

Le volume de lecture local pour l'accompagnement. La plage est [0-100].

Met en pause le mixage audio pour l'accompagnement.

virtual int PauseAudioAccompany() = 0;

Description de la réponse

• 0 : Succès.

• Une valeur non nulle : Échec. Un code d'erreur est renvoyé.

Reprend le mixage audio pour l'accompagnement.

virtual int ResumeAudioAccompany() = 0;

Description de la réponse

• 0 : Succès.

• Une valeur non nulle : Échec. Un code d'erreur est renvoyé.

Récupère la durée du fichier d'accompagnement en millisecondes.

virtual int GetAudioAccompanyDuration() = 0;

Description de la réponse

La durée du fichier d'accompagnement audio en millisecondes.

Récupère la progression de la lecture du fichier d'accompagnement en millisecondes.

virtual int GetAudioAccompanyCurrentPosition() = 0;

Valeur de retour

La position de lecture actuelle du fichier d'accompagnement audio en millisecondes.

Définit la position de lecture du fichier d'accompagnement.

virtual int SetAudioAccompanyPosition(int pos) = 0;

Description de la réponse

• 0 : Succès.

• Une valeur non nulle : Échec. Un code d'erreur est renvoyé.

Précharge un fichier d'effet sonore.

virtual int PreloadAudioEffect(unsigned int soundId,
                                       const char *filePath) = 0;

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Supprime un fichier d'effet sonore préchargé.

virtual int UnloadAudioEffect(unsigned int soundId) = 0;

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Démarre la lecture d'un effet sonore.

virtual int PlayAudioEffect(unsigned int soundId, const char *filePath, const AliEngineAudioEffectConfig& config) = 0;

Paramètres

Retourne

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Arrête la lecture d'un effet sonore.

virtual int StopAudioEffect(unsigned int soundId) = 0;

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Arrête la lecture de tous les effets sonores.

- (int)StopAllAudioEffects;

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Met en pause un effet sonore.

virtual int PauseAudioEffect(unsigned int soundId) = 0;

Paramètres

Description de la réponse

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Met en pause tous les effets sonores.

virtual int PauseAllAudioEffects() = 0;

Description de la réponse

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Reprend la lecture d'un effet sonore.

virtual int ResumeAudioEffect(unsigned int soundId) = 0;

Paramètres

Description de la réponse

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Reprend la lecture de tous les effets sonores.

virtual int ResumeAllAudioEffects() = 0;

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Définit le volume de publication pour un effet sonore.

virtual int SetAudioEffectPublishVolume(unsigned int soundId, int volume) = 0;

Paramètres

Retourne

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Récupère le volume de publication d'un effet sonore.

virtual int GetAudioEffectPublishVolume(unsigned int soundId) = 0;

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Définit le volume de lecture local pour tous les effets sonores.

virtual int SetAllAudioEffectsPublishVolume(int volume) = 0;

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Définit le volume de lecture local pour un effet sonore.

virtual int SetAudioEffectPlayoutVolume(unsigned int soundId, int volume) = 0;

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Récupère le volume de lecture local d'un effet sonore.

virtual int GetAudioEffectPlayoutVolume(unsigned int soundId) = 0;

Paramètres

Description de la réponse

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Définit le volume de lecture pour tous les effets sonores.

virtual int SetAllAudioEffectsPlayoutVolume(int volume) = 0;

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Définit le volume de publication pour tous les effets sonores.

virtual int SetAllAudioEffectsPublishVolume(int volume) = 0;

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Définit la fenêtre de rendu et les paramètres de dessin pour l'aperçu local.

virtual int SetLocalViewConfig(AliEngineVideoCanvas renderConfig,
                                         AliEngineVideoTrack track) = 0;

Cette méthode configure la vue d'aperçu local. Elle lie la vue d'affichage du flux vidéo local et définit le mode de rendu, le mode miroir et l'angle de rotation de la vue de l'utilisateur local. Elle affecte uniquement l'aperçu de l'utilisateur local et non la vidéo publiée. Pour configurer la vue d'un utilisateur distant, appelez SetRemoteViewConfig.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal.

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Définit les préférences de capture de la caméra.

virtual int SetCameraCapturerConfiguration(const AliEngineCameraCapturerConfiguration& config) = 0;

Cette méthode configure les préférences de capture de la caméra, telles que la direction de la caméra et la fréquence d'images de capture.

Quand appeler

Vous devez effectuer ce paramétrage avant d'activer la caméra. Par exemple, appelez-la avant les opérations suivantes :

• StartPreview (démarre l'aperçu)

• JoinChannel (rejoint un canal)

Paramètres

Valeur de retour

0 : L'appel de méthode a réussi. Autres valeurs : L'appel de méthode a échoué.

Désactive ou réactive la capture vidéo locale.

virtual int EnableLocalVideo(bool enabled) = 0;

Cette méthode contrôle l'activation et la désactivation de la capture vidéo locale. Lorsque la capture vidéo locale est désactivée, ni l'aperçu local ni le flux publié ne contiennent de données vidéo, mais cela n'affecte pas la réception de la vidéo distante. Si vous appelez cette méthode pour désactiver la capture de la caméra locale, l'aperçu local et le flux publié distant resteront sur la dernière image.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal.

Rappels associés

Après un appel réussi à cette méthode, le rappel OnUserVideoEnabled notifie les utilisateurs distants.

Paramètres