ApsaraVideo Live:Interface AliRtcEngine

Type de flux vidéo.

audioTrack

AliRtcAudioEffectVoiceChangerMode

Type de flux audio.

Valeur de retour

0 : Succès.
<0 : Échec.

subscribeRemoteDestChannelStream

S'abonne au flux d'un utilisateur spécifique entre différents canaux.

public abstract int subscribeRemoteDestChannelStream(String channelId, String uid, AliRtcVideoTrack track, boolean sub_audio, boolean sub);

Paramètres

Parameter	Type	Description
channelId	String	ID du canal distant.
uid	String	ID de l'utilisateur distant.
track	AliRtcVideoTrack	Flux vidéo auquel s'abonner.
sub_audio	boolean	Arrête ou reprend l'extraction du flux audio d'un utilisateur distant spécifique. Valeurs possibles : true (par défaut) : Reprendre. false : Arrêter.
sub	boolean	Arrête ou reprend l'abonnement au flux d'un utilisateur spécifique entre différents canaux.

Valeur de retour

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

subscribeRemoteDestChannelAllStream

Arrête ou reprend l'abonnement aux flux de tous les utilisateurs entre différents canaux.

public abstract int subscribeRemoteDestChannelAllStream(String channelId, AliRtcVideoTrack track, boolean sub_audio, boolean sub);

Paramètres

Paramètre	Type	Description
channelId	String	ID du canal cible distant.
videoTrack	AliRtcVideoTrack	Type de flux vidéo auquel s'abonner.
sub_audio	boolean	Indique s'il faut s'abonner aux flux audio des utilisateurs distants. true : s'abonne aux flux audio des utilisateurs du canal cible. false : arrête l'abonnement aux flux audio des utilisateurs du canal cible.
sub	boolean	Arrête ou reprend l'abonnement à un flux utilisateur spécifié entre canaux. true : s'abonne. false : se désabonne.

Valeur de retour

0 : l'appel de méthode a réussi.
Valeur non nulle : l'appel de méthode a échoué.

setRemoteAudioVolume

Ajuste le volume de lecture d'un flux extrait.

public abstract int setRemoteAudioVolume(String uid, int volume);

Cette interface permet à l'utilisateur local d'ajuster le volume de lecture du flux audio d'un utilisateur spécifié sur l'appareil local.

Remarque

Ce paramètre affecte uniquement l'expérience d'écoute sur l'appareil local.

Paramètres

Paramètre

Type

Description

uid

String

ID utilisateur. Identifiant unique de l'utilisateur, généralement attribué par le serveur d'application.

volume

int

Volume de lecture. La plage est [0, 100].

0 : muet.
100 : volume d'origine.

Valeur de retour

0 : l'appel de méthode a réussi.
Valeur non nulle : l'appel de méthode a échoué. Par exemple, la valeur du volume n'est pas valide.

muteLocalMic

Arrête ou reprend l'envoi des données audio locales.

public abstract int muteLocalMic(boolean mute, AliRtcMuteLocalAudioMode mode);

Remarque

La mise en sourdine consiste à envoyer des trames silencieuses dans le flux audio. Les modules de collecte et d'encodage continuent de fonctionner.

Quand appeler

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

Rappels associés

Une fois l'appel réussi, l'utilisateur distant déclenche la notification <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#ea457055e4izi" id="cce3d390a3xud">onUserAudioMuted</a> pour indiquer si cet utilisateur est en sourdine.

Paramètres

Paramètre

Type

Description

mute

boolean

Arrête ou reprend l'envoi des données audio locales. Valeurs valides :

true : envoie des trames silencieuses pour l'audio local.
false (par défaut) : reprend.

mode

AliRtcMuteLocalAudioMode

Mode de sourdine. Le mode par défaut est la sourdine du microphone.

Valeur de retour

0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec. La mise en sourdine envoie uniquement des trames silencieuses pour les données audio. Les modules de collecte et d'encodage continuent de fonctionner.

muteRemoteAudioPlaying

Arrête ou reprend la lecture audio distante.

public abstract int muteRemoteAudioPlaying(String uid, boolean mute);

Cette API sert uniquement à arrêter ou reprendre la lecture de l'audio d'un utilisateur distant spécifié. Elle n'affecte pas l'extraction ni le décodage du flux audio distant. Pour vous désabonner du flux audio d'un utilisateur, appelez <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e09342eeb0z4k" id="66a2ef0919jjg">subscribeRemoteAudioStream</a>.

Quand appeler

Vous pouvez définir ce paramètre avant ou après avoir rejoint un canal.

Paramètres

Paramètre

Type

Description

uid

String

ID utilisateur.

mute

boolean

Arrête ou reprend la lecture audio distante. Valeurs valides :

true : arrête la lecture.
false (par défaut) : reprend la lecture.

Valeur de retour

0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

muteAllRemoteAudioPlaying

Arrête ou reprend toute la lecture audio distante.

public abstract int muteAllRemoteAudioPlaying(boolean mute);

Cette méthode arrête ou reprend toute la lecture audio distante.

Remarque

Cette méthode arrête uniquement la lecture. L'extraction et le décodage des flux ne sont pas affectés.

Quand appeler

Vous pouvez définir ce paramètre avant ou après avoir rejoint un canal.

Paramètres

Paramètre

Type

Description

mute

boolean

Arrête ou reprend toute la lecture audio distante. Valeurs valides :

true : arrête la lecture.
false (par défaut) : reprend la lecture.

Valeur de retour

0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

startAudioCapture[1/2]

Active la capture audio.

public abstract int startAudioCapture();

Cette interface permet de démarrer la capture audio. Vous pouvez l'appeler avant de rejoindre une réunion pour anticiper le démarrage de la capture. Si vous n'appelez pas cette interface, le SDK gère automatiquement le périphérique de capture audio. Pour redémarrer la capture audio après l'avoir arrêtée via stopAudioCapture, appelez cette interface.

Quand appeler

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

Interfaces associées

<a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#b71a48f4b84n0" id="4565abdceeq8i">startAudioCapture[2/2]</a> utilise des paramètres pour contrôler si le périphérique de capture audio reste activé après avoir quitté une réunion.

Rappels associés

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

Valeur de retour

0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

startAudioCapture[2/2]

Active la capture audio.

public abstract int startAudioCapture(boolean keepAlive);

La mise en sourdine désactive la capture du microphone.

Cette méthode contrôle l'activation de la collecte audio. Vous pouvez également l'appeler avant de rejoindre un canal pour activer la collecte audio par anticipation. Si vous ne définissez pas ce paramètre, le SDK gère automatiquement le périphérique de collecte audio.

Quand appeler

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

Interfaces associées

Par rapport à startAudioCapture[1/2], cette API vous permet d'utiliser le paramètre keepAlive pour contrôler si le périphérique de capture reste actif après avoir quitté la session.

Rappels associés

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

Paramètres

Paramètre

Type

Description

keepAlive

boolean

État du périphérique de collecte après avoir quitté le canal. Valeurs valides :

true : le périphérique de collecte reste activé après avoir quitté le canal.
false (par défaut) : le périphérique de collecte est désactivé après avoir quitté le canal.

Valeur de retour

0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

stopAudioCapture

Désactive la capture audio.

public abstract int stopAudioCapture();

Le SDK active la capture audio par défaut. Sans configuration spécifique, des actions telles que le démarrage d'un aperçu ou la jonction d'un canal lancent automatiquement la capture audio. Pour arrêter la collecte du périphérique audio, appelez cette méthode.

Rappels associés

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

Valeur de retour

0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

setDefaultAudioRoutetoSpeakerphone

Définit si la sortie audio par défaut est le haut-parleur.

public abstract int setDefaultAudioRoutetoSpeakerphone(boolean defaultToSpeakerphone);

Cette méthode définit le périphérique de routage audio par défaut avant de rejoindre un canal. Vous pouvez choisir de sortir par défaut vers l'écouteur ou le haut-parleur. Le SDK utilise le haut-parleur par défaut. Si vous souhaitez modifier cette configuration par défaut, appelez cette méthode avant de rejoindre un canal.

La priorité de routage audio est prédéfinie dans le SDK et bascule automatiquement en fonction de l'état de connexion des périphériques externes. L'ordre de priorité est le suivant : Casque filaire > Casque Bluetooth > Paramètres utilisateur > Paramètres par défaut. Par conséquent, si aucun périphérique externe n'est connecté et que la route audio n'est pas définie à l'aide de enableSpeakerphone, les paramètres par défaut sont utilisés.

Pour plus d'informations sur les paramètres de routage audio, consultez Paramètres de routage audio.

Les appareils mobiles disposent généralement de deux périphériques de routage audio : l'écouteur et le haut-parleur.

Lorsque la route audio est l'écouteur, le son est plus faible et ne peut être entendu clairement que lorsque l'oreille est proche. Cela offre une meilleure confidentialité et convient pour répondre aux appels.
Lorsque la route audio est le haut-parleur, le son est plus fort et peut être entendu sans tenir le téléphone près du visage, permettant ainsi une fonction « mains libres ».

Interfaces associées

Cette API permet de modifier les paramètres de routage audio par défaut. L'API enableSpeakerphone sert à définir le périphérique de routage actuel.

Quand appeler

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

Paramètres

Paramètre

Type

Description

defaultToSpeakerphone

boolean

Indique s'il faut utiliser le haut-parleur par défaut.

true : mode haut-parleur (haut-parleur par défaut).
false : mode écouteur.

Valeur de retour

0 : l'appel de méthode a réussi.
<0 : l'appel de méthode a échoué.

enableSpeakerphone

Définit la sortie audio sur l'écouteur ou le haut-parleur.

public abstract int enableSpeakerphone(boolean enable);

Cette méthode définit le périphérique de lecture audio actuel après avoir rejoint un canal, en choisissant entre l'écouteur et le haut-parleur. Si cette fonctionnalité n'est pas définie, le périphérique défini par le routage audio par défaut est utilisé pour la lecture.

La priorité de routage audio est prédéfinie dans le SDK et bascule automatiquement en fonction de l'état de connexion des périphériques externes. La priorité est la suivante : Casque filaire > Casque Bluetooth > Paramètres utilisateur > Paramètres par défaut. Par conséquent, lorsqu'un périphérique externe est connecté, cet appel d'API n'a aucun effet. Pour plus d'informations sur les paramètres de routage audio, consultez Paramètres de routage audio.

Quand appeler

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

Interfaces associées

<a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#d4dab00b21ebx" id="944fb5797e773">setDefaultAudioRoutetoSpeakerphone</a> modifie les paramètres de routage audio par défaut. Cette API définit le périphérique de routage actuel.

Paramètres

Paramètre

Type

Description

enable

boolean

Définit la sortie audio sur l'écouteur ou le haut-parleur. Valeurs valides :

true (par défaut) : mode haut-parleur.
false : mode écouteur.

Valeur de retour

0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

isSpeakerOn

Indique si la sortie audio actuelle est l'écouteur ou le haut-parleur.

public abstract boolean isSpeakerOn();

Valeur de retour

true : Haut-parleur. false : Écouteur.

enableAudioVolumeIndication

Active l'indication du volume audio des utilisateurs.

public abstract int enableAudioVolumeIndication(int interval, int smooth, int reportVad);

Cette interface permet au SDK de signaler périodiquement à votre application les informations relatives au volume de l'utilisateur local qui publie un flux et de l'utilisateur distant présentant le volume instantané le plus élevé. Pour utiliser cette fonctionnalité, implémentez la classe AliRtcAudioVolumeObserver et appelez l'interface registerAudioVolumeObserver pour enregistrer l'objet récepteur.

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 publiant des flux sont présents dans le canal, le SDK déclenche les deux rappels suivants à l'intervalle défini :

Le volume audio de l'orateur est notifié via le rappel AliRtcAudioVolumeObserver#onAudioVolume. La fréquence du rappel est déterminée par l'intervalle.
Détection d'activité vocale. Lorsqu'un utilisateur actif est détecté, l'UID de l'orateur est renvoyé via le rappel AliRtcAudioVolumeObserver#onActiveSpeaker.

Paramètres

Parameter	Type	Description
interval	int	Intervalle de temps. Unité : ms. Valeur par défaut : 300 ms. Plage : valeur minimale ≥ 10 ms. Nous vous recommandons de définir une valeur comprise entre 300 ms et 500 ms. Une valeur ≤ 0 désactive les fonctionnalités d'indication du volume et du haut-parleur.
smooth	int	Coefficient de lissage. Une valeur plus élevée indique un degré de lissage plus important, tandis qu'une valeur plus faible signifie un degré de lissage moins élevé et de meilleures performances en temps réel. Valeur par défaut : 3. Plage : 0 à 9. Nous vous recommandons de définir la valeur sur 3.
reportVad	int	Interrupteur de détection d'activité vocale locale. 1 : Activé. Le rappel s'effectue via l'interface AliRtcAudioVolumeObserver. 0 (par défaut) : Désactivé.

Valeur de retour

0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

enableEarBack

Active la surveillance intra-auriculaire.

public abstract int enableEarBack(boolean enable);

Cette méthode active ou désactive la fonctionnalité de surveillance intra-auriculaire. Nous vous recommandons d'activer la surveillance intra-auriculaire lorsque vous portez un casque (filaire ou Bluetooth) pour obtenir de meilleurs résultats.

Quand appeler

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

Paramètres

Parameter

Type

Description

enable

boolean

Indique s'il faut activer la surveillance intra-auriculaire. Valeurs valides :

true : Activer la surveillance intra-auriculaire.
false (par défaut) : Désactiver la surveillance intra-auriculaire.

Valeur de retour

0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

setEarBackVolume

Définit le volume de la surveillance intra-auriculaire.

public abstract int setEarBackVolume(int volume) ;

Cette méthode définit le volume de la surveillance intra-auriculaire. Elle ne prend effet qu'après avoir activé la fonctionnalité de surveillance intra-auriculaire en appelant enableEarBack.

Quand appeler

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

Paramètres

Parameter

Type

Description

volume

int

Volume. La plage est [0, 100]. La valeur par défaut est 100.

0 : Mise en sourdine.
100 : (Par défaut) Volume d'origine.

Valeur de retour

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

startAudioPlayer

Active le dispositif de lecture audio.

public abstract int startAudioPlayer();

Cette méthode permet de contrôler l'activation anticipée de la lecture audio. Si vous ne configurez pas cette option, le SDK active automatiquement la lecture audio après l'abonnement à un flux audio.

Valeur de retour

0 : Succès.
Valeur non nulle : Échec. Un code d'erreur est renvoyé.

stopAudioPlayer

Désactive le dispositif de lecture audio.

 public abstract int stopAudioPlayer();

Cette méthode arrête la lecture audio et correspond à startAudioPlayer.

Valeur de retour

0 : Succès.
Valeur non nulle : Échec. Un code d'erreur est renvoyé.

setPlayoutVolume

Définit le volume de lecture local.

public abstract int setPlayoutVolume(int volume);

Paramètres

Parameter

Type

Description

volume

int

Volume de lecture. La plage est [0, 400].

0 : Mise en sourdine.
100 : Volume d'origine.
>100 : Augmentation du volume.

Valeur de retour

0 : Succès.
Valeur non nulle : Échec.

setRecordingVolume

Définit le volume d'enregistrement.

public abstract int setRecordingVolume(int volume);

Paramètres

Parameter

Type

Description

volume

int

Volume d'enregistrement. La plage est [0, 400].

0 : Mise en sourdine.
100 : Volume d'origine.
>100 : Augmentation du volume.

Valeur de retour

0 : Succès.
Valeur non nulle : Échec.

playAudioFileTest

Lit un fichier audio.

public abstract int playAudioFileTest(String filePath) ;

Cette méthode lit un fichier audio avant de rejoindre un canal afin de tester la lecture audio.

Quand appeler

Vous ne pouvez appeler cette méthode qu'avant de rejoindre un canal.

Limites

Les appels multiples se remplacent mutuellement. Un nouvel appel arrête tout fichier en cours de lecture.

Paramètres

Parameter

Type

Description

filePath

Chemin du fichier.

Valeur de retour

0 : Succès.
Valeur non nulle : Échec.

stopAudioFileTest

Arrête la lecture du fichier audio.

public abstract int stopAudioFileTest();

Cette méthode correspond à playAudioFileTest et arrête la lecture du fichier audio.

Limites

Vous ne pouvez appeler cette méthode qu'avant de rejoindre un canal.

Valeur de retour

0 : Succès.
Valeur non nulle : Échec.

startAudioCaptureTest

Active la détection du dispositif de capture audio avant un appel.

public abstract int startAudioCaptureTest();

Vous pouvez utiliser cette méthode pour démarrer un test de capture audio afin de vérifier si votre dispositif de capture audio local fonctionne correctement avant un appel. Après avoir appelé cette méthode, le SDK vous signale les informations de volume du dispositif de capture via le rappel AliRtcAudioVolumeObserver::OnTestAudioVolume.

Quand appeler

Appelez cette méthode avant de rejoindre un canal. Une fois le test terminé, assurez-vous d'appeler stopAudioCaptureTest pour arrêter la détection du dispositif et éviter les problèmes liés à l'occupation du dispositif.

Valeur de retour

0 : Succès.
Valeur non nulle : Échec. Un code d'erreur est renvoyé.

stopAudioCaptureTest

Désactive la détection de la capture audio.

public abstract int stopAudioCaptureTest();

Cette méthode arrête la détection du dispositif de capture audio. Vous devez appeler cette méthode pour arrêter le test après avoir appelé startAudioCaptureTest.

Quand appeler

Appelez cette méthode avant de rejoindre un canal.

Valeur de retour

0 : Succès.
Valeur non nulle : Échec. Un code d'erreur est renvoyé.

setAudioEffectVoiceChangerMode

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

public abstract int setAudioEffectVoiceChangerMode(AliRtcAudioEffectVoiceChangerMode mode);

Paramètres

Parameter

Type

Description

mode

Mode d'effet de modification de la voix. La valeur par défaut est AliRtcSdk_AudioEffect_Voice_Changer_OFF (désactivé).

Valeur de retour

0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

setAudioEffectPitchValue

Définit le paramètre de transposition de hauteur.

public abstract int setAudioEffectPitchValue(double value);

Paramètres

Parameter

Type

Description

value

double

La plage de paramètres est [0,5, 2,0]. La valeur par défaut est 1,0, ce qui signifie que la hauteur reste inchangée.

Valeur de retour

0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

setAudioEffectReverbMode

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

public abstract int setAudioEffectReverbMode(AliRtcAudioEffectReverbMode mode);

Paramètres

Parameter

Type

Description

mode

AliRtcAudioEffectReverbMode

Mode d'effet de réverbération. La valeur par défaut est AliRtcAudioEffectReverb_Off (désactivé).

Valeur de retour

0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

setAudioEffectReverbParamType

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

public abstract int setAudioEffectReverbParamType(AliRtcAudioEffectReverbParamType type, float value);

Paramètres

Parameter

Type

Description

type

AliRtcAudioEffectReverbParamType

Paramètre d'effet de réverbération.

value

float

Valeur spécifique du paramètre.

Valeur de retour

0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

setAudioEffectBeautifyMode

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

public abstract int setAudioEffectBeautifyMode(AliRtcAudioEffectBeautifyMode mode);

Cette méthode définit certains modes d'embellissement vocal prédéfinis au sein du SDK. Elle convient aux scénarios nécessitant un embellissement vocal, 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é, ce qui 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

Parameter

Type

Description

mode

AliRtcAudioEffectBeautifyMode

Mode d'effet d'embellissement vocal. Consultez la définition de l'énumération pour plus de détails.

Valeur de retour

0 : Succès.
Valeur non nulle : Échec.

setAudioEffectEqualizationParam

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

public abstract int setAudioEffectEqualizationParam(AliRtcAudioEffectEqualizationBandFrequency bandIndex, float gain);

Cette méthode ajuste l'égaliseur graphique pour les signaux audio ou vocaux capturés localement. En ajustant le gain (en dB) de l'une des 10 bandes de fréquences fixes, vous pouvez personnaliser le timbre. Elle convient à des 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équences standard. Le gain de chaque bande peut être défini indépendamment, dans une plage allant de -15 à 15 dB, avec une valeur par défaut de 0 dB (ni amplification ni atténuation).

Limites

Vous ne pouvez pas utiliser l'égaliseur avant d'avoir activé le mode d'embellissement. Vous devez appeler cette interface après avoir appelé setAudioEffectBeautifyMode.

Paramètres

Paramètre

Type

Description

bandIndex

AliRtcAudioEffectEqualizationBandFrequency

L'index de la bande de fréquence à ajuster, correspondant à un segment de la fréquence centrale (31 Hz à 16 kHz).

gain

float

Valeur du gain en dB. La plage est [-15, 15].

Valeur de retour

0 : Succès.

Valeur non nulle : Échec.

addExternalAudioStream

Ajoute un flux audio externe.

public abstract int addExternalAudioStream(AliRtcExternalAudioStreamConfig config);

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

Appelez l'API <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#42b363024fich" id="20c33a9acb0ui">addExternalAudioStream</a> pour ajouter un flux audio externe et obtenir l'ID du flux audio externe.
Appelez <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#930f22d3dcdco" id="d3deb62b2fl0f">pushExternalAudioStreamRawData</a> pour pousser les données audio vers le flux audio créé.
Lorsque l'appel se termine, vous devez appeler <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#0333f86114078" id="16d826dedcli6">removeExternalAudioStream</a> pour supprimer le flux audio externe.

Pour publier de l'audio collecté de manière personnalisée dans un canal, consultez Collecte audio personnalisée.

Paramètres

Paramètre

Type

Description

config

AliRtcExternalAudioStreamConfig

Configuration du flux audio externe.

Valeur de retour

Une valeur supérieure à 0 indique que l'appel de la méthode a réussi et correspond à l'ID du flux audio externe. Toute autre valeur indique un échec.

pushExternalAudioStreamRawData

Injecte des données de flux audio externe.

public abstract int pushExternalAudioStreamRawData(int streamId, AliRtcAudioFrame rawData);

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

Appelez l'API <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#42b363024fich" id="8822f2932e9ep">addExternalAudioStream</a> pour ajouter un flux audio externe et obtenir l'ID du flux audio externe.
Appelez <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#930f22d3dcdco" id="880fe8cd02j10">pushExternalAudioStreamRawData</a> pour pousser les données audio dans le flux audio créé.
Lorsque l'appel se termine, vous devez appeler <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#0333f86114078" id="106c7aefa27c0">removeExternalAudioStream</a> pour supprimer le flux audio externe.

Pour publier de l'audio collecté de manière personnalisée dans un canal, consultez Collecte audio personnalisée.

Quand appeler

Appelez cette méthode après avoir rejoint un canal.

Paramètres

Paramètre

Type

Description

streamId

int

ID du flux audio externe.

rawData

AliRtcAudioFrame

Données audio.

Valeur de retour

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

setExternalAudioStreamPublishVolume

Définit le volume d'ingestion du flux audio externe.

public abstract int setExternalAudioStreamPublishVolume(int streamId, int publishVolume);

Paramètres

Paramètre

Type

Description

streamId

int

ID du flux audio externe.

publishVolume

int

Volume d'ingestion. La plage est [0, 100].

Valeur de retour

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

getExternalAudioStreamPublishVolume

Obtient le volume d'ingestion du flux audio externe.

public abstract int getExternalAudioStreamPublishVolume(int streamId);

Paramètres

Paramètre

Type

Description

streamId

int

ID du flux audio externe.

Valeur de retour

[0, 100] Volume d'ingestion. < 0 : Échec.

setExternalAudioStreamPlayoutVolume

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

public abstract int setExternalAudioStreamPlayoutVolume(int streamId, int playoutVolume);

Paramètres

Paramètre

Type

Description

streamId

int

ID du flux audio externe.

playoutVolume

int

Volume de lecture. La plage est [0, 100].

Valeur de retour

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

getExternalAudioStreamPlayoutVolume

Obtient le volume de lecture du flux audio externe.

public abstract int getExternalAudioStreamPlayoutVolume(int streamId);

Paramètres

Paramètre

Type

Description

streamId

int

ID du flux audio externe.

Valeur de retour

[0, 100] Volume de lecture. Une valeur < 0 indique un échec.

removeExternalAudioStream

Supprime un flux audio externe.

public abstract int removeExternalAudioStream(int streamId);

Cette méthode supprime le flux audio externe correspondant en fonction du streamId fourni. 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. Ensuite, appelez la méthode pushExternalAudioStreamRawData pour injecter vos données audio dans le SDK. Lorsque vous souhaitez arrêter l'entrée audio personnalisée, appelez cette méthode pour supprimer le flux audio externe correspondant et libérer les ressources.

Paramètres

Paramètre

Type

Description

streamId

int

ID du flux audio externe. Il s'agit de la valeur de retour lorsque la méthode addExternalAudioStream est appelée avec succès.

Valeur de retour

0 : Succès.
<0 : Échec. Un code d'erreur est renvoyé.

getAudioFileInfo

Obtient les informations sur un fichier audio.

public abstract int getAudioFileInfo(String fileName);

Vous pouvez appeler cette API asynchrone pour obtenir les informations de durée d'un fichier. Vous pouvez obtenir les informations sur le fichier audio via onAudioFileInfo.

Paramètres

Paramètre

Type

Description

fileName

String

Chemin du fichier audio.

Valeur de retour

0 : Succès.
Valeur non nulle : Un code d'erreur est renvoyé.

startAudioAccompany

Démarre le mixage d'accompagnement.

public abstract int startAudioAccompany(String fileName, AliRtcAudioAccompanyConfig config) ;

Cette méthode lit un fichier d'accompagnement local ou en ligne. Il s'agit d'une méthode asynchrone. Après avoir appelé cette méthode, vous pouvez écouter l'état de la lecture de l'accompagnement via AliRtcEngineNotify#onAudioAccompanyStateChanged.

Quand appeler

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

Limites

Contrairement aux effets sonores, un seul accompagnement peut être lu à la fois. Des appels répétés écraseront la lecture de l'accompagnement précédent.

Paramètres

Paramètre

Type

Description

fileName

String

Chemin du fichier d'accompagnement.

config

AliRtcAudioAccompanyConfig

Configuration de la lecture de l'accompagnement, incluant si la lecture est locale uniquement, si elle remplace le microphone, le nombre de boucles, la position de départ, le volume et d'autres paramètres.

Valeur de retour

0 : Succès.
Valeur non nulle : Échec. Un code d'erreur est renvoyé.

stopAudioAccompany

Arrête le mixage d'accompagnement.

public abstract int stopAudioAccompany() ;

Cette méthode correspond à startAudioAccompany et arrête la lecture de l'accompagnement.

Quand appeler

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

Valeur de retour

0 : Succès.
Valeur non nulle : Échec. Un code d'erreur est renvoyé.

setAudioAccompanyVolume

Définit le volume de l'accompagnement, y compris le volume de lecture local et le volume d'ingestion.

public abstract int setAudioAccompanyVolume( int volume) ;

Cette méthode définit le volume de l'accompagnement pour la lecture locale et l'ingestion de flux. De plus, setAudioAccompanyPlayoutVolume et setAudioAccompanyPublishVolume définissent respectivement uniquement le volume de lecture local et le volume d'ingestion du flux d'accompagnement.

Paramètres

Paramètre

Type

Description

volume

int

Volume de l'accompagnement. La plage est [0, 100].

0 : Muet.

100 : Volume du fichier original.

Valeur de retour

0 : Succès.
Valeur non nulle : Échec. Un code d'erreur est renvoyé.

setAudioAccompanyPublishVolume

Définit le volume d'ingestion de l'accompagnement.

public abstract int setAudioAccompanyPublishVolume(int volume) ;

Paramètres

Paramètre

Type

Description

volume

int

Volume de l'accompagnement. La plage est [0, 100].

0 : Muet.

100 : Volume du fichier original.

Valeur de retour

0 : Succès.
Valeur non nulle : Échec. Un code d'erreur est renvoyé.

getAudioAccompanyPublishVolume

Obtient le volume d'ingestion de l'accompagnement.

public abstract int getAudioAccompanyPublishVolume() ;

Valeur de retour

Le volume d'ingestion de la musique d'accompagnement.

[0-100] : Succès.
Autre : Code d'erreur.

setAudioAccompanyPlayoutVolume

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

public abstract int setAudioAccompanyPlayoutVolume(int volume) ;

Paramètres

Paramètre

Type

Description

volume

int

Volume de l'accompagnement. La plage est [0, 100].

0 : Muet.

100 : Volume du fichier original.

Valeur de retour

0 : Succès.
Valeur non nulle : Échec. Un code d'erreur est renvoyé.

getAudioAccompanyPlayoutVolume

Obtient le volume de lecture local de l'accompagnement.

public abstract int getAudioAccompanyPlayoutVolume() ;

Valeur de retour

Le volume de lecture local de la musique d'accompagnement.

[0-100] : Succès.
Autre : Code d'erreur.

pauseAudioAccompany

Met en pause le mixage d'accompagnement.

public abstract int pauseAudioAccompany();

Valeur de retour

0 : Succès.
Valeur non nulle : Échec. Un code d'erreur est renvoyé.

resumeAudioAccompany

Reprend le mixage d'accompagnement.

public abstract int resumeAudioAccompany();

Valeur de retour

0 : Succès.
Valeur non nulle : Échec. Un code d'erreur est renvoyé.

getAudioAccompanyDuration

Obtient la durée du fichier d'accompagnement, en millisecondes.

public abstract int getAudioAccompanyDuration();

Cette méthode permet d'obtenir la durée du fichier d'accompagnement audio actuel.

Valeur de retour

>=0 : Durée du fichier d'accompagnement.
<0 : Échec. Un code d'erreur est renvoyé.

getAudioAccompanyCurrentPosition

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

public abstract int getAudioAccompanyCurrentPosition();

Cette méthode permet d'obtenir la progression de la lecture du fichier d'accompagnement audio actuel, exprimée en millisecondes.

Valeur de retour

>=0 : Progression de la lecture du fichier d'accompagnement.
<0 : Échec. Un code d'erreur est renvoyé.

setAudioAccompanyPosition

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

public abstract int setAudioAccompanyPosition(int posMs);

Cette méthode permet de définir manuellement la progression de la lecture de l'accompagnement, par exemple pour faire glisser une barre de progression. Une fois cette méthode appelée avec succès, le fichier d'accompagnement reprendra la lecture à partir de la position posMs indiquée.

Paramètres

Paramètre

Type

Description

posMs

int

Position sur la barre de progression, en millisecondes.

Valeur de retour

0 : Succès.
Valeur non nulle : Échec. Un code d'erreur est renvoyé.

preloadAudioEffect

Précharge un fichier d'effet sonore.

public abstract int preloadAudioEffect(int soundId, String filePath);

Paramètres

Paramètre

Type

Description

soundId

int

ID attribué au fichier d'effet sonore par l'utilisateur.

filePath

String

Chemin d'accès au fichier d'effet sonore.

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

unloadAudioEffect

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

public abstract int unloadAudioEffect(int soundId);

Paramètres

Paramètre

Type

Description

soundId

int

ID attribué au fichier d'effet sonore par l'utilisateur.

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

playAudioEffect

Lance la lecture d'un effet sonore.

public abstract int playAudioEffect(int soundId, String filePath, int cycles, boolean publish);

Paramètres

Paramètre	Type	Description
soundId	int	ID attribué au fichier d'effet sonore par l'utilisateur.
filePath	String	Chemin d'accès au fichier d'effet sonore.
cycles	int	Nombre de boucles. La valeur -1 signifie une boucle infinie.
publish	boolean	Indique si le flux audio de l'effet sonore doit être publié auprès des utilisateurs distants. Valeurs possibles : true : Publie le flux audio de l'effet sonore auprès des utilisateurs distants. false (par défaut) : Ne publie pas le flux audio de l'effet sonore auprès des utilisateurs distants.

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

stopAudioEffect

Arrête la lecture d'un effet sonore.

public abstract int stopAudioEffect(int soundId);

Paramètres

Paramètre

Type

Description

soundId

int

ID attribué au fichier d'effet sonore par l'utilisateur.

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

stopAllAudioEffects

Arrête la lecture de tous les effets sonores.

public abstract int stopAllAudioEffects();

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

setAudioEffectPublishVolume

Définit le volume de mixage d'ingestion pour l'effet sonore.

public abstract int setAudioEffectPublishVolume(int soundId, int volume);

Paramètres

Paramètre

Type

Description

soundId

int

ID attribué au fichier d'effet sonore par l'utilisateur.

volume

int

Volume de mixage. La plage va de 0 à 100. La valeur par défaut est 50.

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

getAudioEffectPublishVolume

Récupère le volume d'ingestion de l'effet sonore.

public abstract int getAudioEffectPublishVolume(int soundId);

Paramètres

Paramètre

Type

Description

soundId

int

ID attribué au fichier d'effet sonore par l'utilisateur.

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

setAudioEffectPlayoutVolume

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

public abstract int setAudioEffectPlayoutVolume(int soundId, int volume);

Paramètres

Paramètre

Type

Description

soundId

int

ID attribué au fichier d'effet sonore par l'utilisateur.

volume

int

Volume de mixage. La plage va de 0 à 100. La valeur par défaut est 50.

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

getAudioEffectPlayoutVolume

Récupère le volume de lecture local d'un effet sonore (Android et iOS).

public abstract int getAudioEffectPlayoutVolume(int soundId);

Paramètres

Paramètre

Type

Description

soundId

int

ID attribué au fichier d'effet sonore par l'utilisateur.

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

setAllAudioEffectsPublishVolume

Définit le volume de mixage d'ingestion pour tous les effets sonores.

public abstract int setAllAudioEffectsPublishVolume(int volume);

Paramètres

Paramètre

Type

Description

volume

int

Volume de mixage. La plage va de 0 à 100. La valeur par défaut est 50.

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

setAllAudioEffectsPlayoutVolume

Définit le volume de lecture local pour tous les effets sonores (Android et iOS).

public abstract int setAllAudioEffectsPlayoutVolume(int volume);

Paramètres

Paramètre

Type

Description

volume

int

Volume de mixage. La plage va de 0 à 100. La valeur par défaut est 50.

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

startRecord

Lance l'enregistrement d'un fichier multimédia.

public abstract boolean startRecord(AliRtcRecordType recordType, AliRtcRecordFormat recordFormat, String filePath, AliRtcRecordAudioConfig audioConfig, AliRtcRecordVideoConfig videoConfig, long maxSize, long maxDuration);

Paramètres

Paramètre

Type

Description

recordType

AliRtcRecordType

Type d'enregistrement.

recordFormat

AliRtcRecordFormat

Type de format (WAV, AAC, MP4).

filePath

String

Nom du fichier d'enregistrement.

audioConfig

AliRtcRecordAudioConfig

Configuration audio.

videoConfig

AliRtcRecordVideoConfig

Configuration vidéo.

maxSize

long

Taille maximale du fichier.

maxDuration

long

Durée maximale du fichier.

Valeur de retour

TRUE : Succès. Autre valeur : Échec.

Remarque

Lorsque vous enregistrez un flux vidéo, appelez cette API après la réussite de l'ingestion du flux (onVideoPublishStateChanged). Cette API enregistre le flux vidéo encodé localement et le sauvegarde en local.
Lors de l'enregistrement d'un flux audio, le fichier enregistré est un mélange des flux audio locaux et distants.

stopRecord

Arrête l'enregistrement d'un fichier multimédia.

  public abstract void stopRecord();

Paramètres

Aucun.

pauseAudioEffect

Met en pause un effet sonore.

public abstract int pauseAudioEffect(int soundId);

Paramètres

Paramètre

Type

Description

soundId

int

ID attribué au fichier d'effet sonore par l'utilisateur.

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

pauseAllAudioEffects

Met en pause tous les effets sonores.

public abstract int pauseAllAudioEffects();

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

resumeAudioEffect

Reprend la lecture d'un effet sonore.

public abstract int resumeAudioEffect(int soundId);

Paramètres

Paramètre

Type

Description

soundId

int

ID attribué au fichier d'effet sonore par l'utilisateur.

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

resumeAllAudioEffects

Reprend la lecture de tous les effets sonores.

public abstract int resumeAllAudioEffects();

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

createRenderSurfaceView

Crée une vue de rendu SurfaceView.

public abstract SophonSurfaceView createRenderSurfaceView(Context context);

Vous devez appeler cette méthode pour afficher la vue vidéo, au lieu de créer directement une SurfaceView. La méthode d'appel est la suivante :

Attribuez la valeur de retour à AliRtcVideoCanvas#view.
Appelez setLocalViewConfig pour définir la vue d'affichage de l'aperçu local ou appelez setRemoteViewConfig pour définir la vue d'affichage de l'aperçu distant.

Quand appeler

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

Limites

Appelez cette méthode dans le thread principal.

Paramètres

Paramètre

Type

Description

context

Context

Contexte de l'activité Android.

setLocalViewConfig

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

public abstract int setLocalViewConfig(AliRtcVideoCanvas viewConfig, AliRtcVideoTrack track);

Cette méthode permet de configurer la vue d'aperçu local. L'appel de cette méthode associe la fenêtre d'affichage (vue) au flux vidéo local et définit les paramètres de l'affichage de l'utilisateur local, tels que le mode de rendu, le mode miroir et l'angle de rotation. Elle n'affecte que l'écran d'aperçu de l'utilisateur local et n'influence pas le flux vidéo publié. Pour configurer la vue de l'interface utilisateur distante, appelez setRemoteViewConfig.

Remarque

Si le paramètre view dans AliRtcVideoCanvas est vide, le rendu s'arrête.
Pour réinitialiser le paramètre renderMode de AliRtcVideoCanvas pendant la lecture, conservez les autres paramètres inchangés et modifiez uniquement renderMode.
Pour réinitialiser le paramètre mirrorMode de AliRtcVideoCanvas pendant la lecture, conservez les autres paramètres inchangés et modifiez uniquement mirrorMode.
Nous vous recommandons d'appeler explicitement startPreview() pour démarrer l'aperçu local.

Quand appeler

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

Paramètres

Paramètre

Type

Description

viewConfig

AliRtcVideoCanvas

Paramètres de rendu, incluant la fenêtre de rendu et la méthode de rendu.

track

Type de flux vidéo.

Valeur de retour

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

setRemoteViewConfig

Définit la fenêtre de rendu et les paramètres de dessin pour une vidéo distante.

public abstract int setRemoteViewConfig(AliVideoCanvas canvas, String uid,AliRtcVideoTrack track);

Cette méthode associe une vue d'affichage à un flux vidéo spécifique provenant d'un utilisateur distant et configure les paramètres d'affichage de la vue distante, tels que le mode de rendu, le mode miroir et l'angle de rotation. Cela affecte uniquement l'image vidéo visible par l'utilisateur local. Pour configurer la vue d'aperçu local, appelez setLocalViewConfig.

Si le paramètre view dans AliRtcVideoCanvas est vide, le rendu s'arrête.
Pour réinitialiser le paramètre renderMode de AliRtcVideoCanvas pendant la lecture, conservez les autres paramètres inchangés et modifiez uniquement renderMode.
Pour réinitialiser le paramètre mirrorMode de AliRtcVideoCanvas pendant la lecture, conservez les autres paramètres inchangés et modifiez uniquement mirrorMode.

Quand appeler

Nous vous recommandons d'appeler cette méthode lorsque vous recevez le rappel onRemoteTrackAvailableNotify, c'est-à-dire lorsque la vidéo de l'utilisateur distant est disponible.

Paramètres

Paramètre

Type

Description

canvas

AliRtcVideoCanvas

Paramètres de rendu, incluant la fenêtre de rendu et la méthode de rendu.

uid

String

ID utilisateur.

track

AliEngineCameraCapturerConfiguration

Type de flux vidéo à configurer.

Valeur de retour

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

setCameraCapturerConfiguration

Configure les préférences de capture de la caméra.

public abstract int setCameraCapturerConfiguration(AliEngineCameraCapturerConfiguration cameraCapturerConfiguration);

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

Quand appeler

Vous devez définir cette configuration avant d'activer la caméra. Par exemple, appelez-la avant les opérations suivantes :

startPreview (démarrer l'aperçu)
joinChannel (rejoindre le canal)

Paramètres

Paramètre

Type

Description

cameraCapturerConfiguration

Préférences de capture de la caméra, incluant l'orientation de la caméra, la fréquence d'images, etc. Valeurs par défaut :

preference :
- ALIRTC_CAPTURER_OUTPUT_PREFERENCE_AUTO : le SDK ajuste automatiquement les paramètres de capture.
- ALIRTC_CAPTURER_OUTPUT_PREFERENCE_PREVIEW : aperçu haute définition. La capture privilégie la qualité de l'aperçu vidéo.
- ALIRTC_CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE : la capture sélectionne la résolution la plus proche de la résolution de publication, en privilégiant les performances de l'appareil.
cameraDirection : AliRtcCameraDirection.CAMERA_FRONT. La caméra frontale est utilisée par défaut.
fps : -1 indique l'utilisation du paramètre de fréquence d'images interne de l'encodeur. La valeur par défaut est 15.
cameraCaptureProfile : 0. Spécifie une résolution spécifique pour la capture vidéo.
disableVideoCaptureReverse : ne pas inverser l'image vidéo capturée en fonction du paramètre de ratio d'aspect. -1 : par défaut. 0 : non effectif. 1 : effectif.
captureObserverOriginal : indique si les données originales de l'image vidéo sont renvoyées via le rappel. -1 : par défaut. 0 : désactivé. 1 : activé.
textureEncode : indique si l'encodage de texture est utilisé. -1 : par défaut. 0 : désactivé. 1 : activé.
cameraTextureCapture : indique si la caméra active la capture de texture. -1 : par défaut. 0 : désactivé. 1 : activé.

Une valeur de -1 indique l'utilisation des paramètres par défaut internes du SDK.

Valeur de retour

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

enableLocalVideo

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

public abstract int enableLocalVideo(boolean enable);

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 des vidéos distantes. 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 se figeront sur la dernière image.

Remarque

La capture vidéo locale est activée par défaut dans le SDK.

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 de cette méthode, l'utilisateur distant est notifié via le rappel onUserVideoEnabled.

Paramètres

Paramètre

Type

Description

enable

boolean

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

true (par défaut) : réactiver.
false : désactiver.

Valeur de retour

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

muteLocalCamera

Arrête ou reprend l'envoi des données vidéo locales.

public abstract int muteLocalCamera(boolean mute, AliRtcVideoTrack track);

Lors de la publication d'un flux, vous pouvez appeler cette méthode pour publier des images vidéo entièrement noires. L'aperçu local reste normal, et les modules de capture, d'encodage et d'envoi continuent de fonctionner, mais le contenu vidéo est remplacé par des images noires.

Remarque

Vous pouvez appeler cette méthode pour contrôler l'envoi d'images noires sur un flux vidéo spécifique. Cela n'affecte pas les processus de capture et de transmission des données. Pour désactiver la capture, appelez la méthode enableLocalVideo. Pour arrêter l'envoi des données vidéo, appelez la méthode publishLocalVideoStream ou appelez <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7558afe6accq4" id="ee17216e55r3t">enableLocalVideo</a> stop collection.

Paramètres

Paramètre

Type

Description

mute

boolean

Arrête ou reprend l'envoi des données vidéo locales. Valeurs valides :

true : arrêter.
false (par défaut) : reprendre.

track

AliRtcVideoEncoderConfiguration

Type de flux vidéo dont l'état de publication doit être modifié.

Valeur de retour

0 indique que l'appel de la méthode a réussi.

isCameraOn

Vérifie si la caméra est activée.

public abstract boolean isCameraOn();

Valeur de retour

true : la caméra est activée. false : la caméra n'est pas activée.

setVideoEncoderConfiguration

Configure les propriétés d'encodage vidéo.

public abstract void setVideoEncoderConfiguration(AliRtcVideoEncoderConfiguration config);

Cette méthode définit les paramètres vidéo pour les propriétés d'encodage du flux vidéo, tels que la résolution, la fréquence d'images, le débit binaire et l'orientation vidéo. Nous vous recommandons d'appeler cette méthode pour tous les scénarios vidéo.

Remarque

Tous les paramètres définis ont des limites de plage correspondantes. Si un paramètre défini se trouve en dehors de la plage valide, le SDK l'ajuste automatiquement.

Quand appeler

Vous pouvez appeler cette méthode avant ou après avoir rejoint un canal. Si vous n'avez besoin de définir les propriétés d'encodage vidéo du flux de la caméra qu'une seule fois par session, nous vous recommandons de l'appeler avant de rejoindre le canal.

Limites

Le mirrorMode de cette méthode et setVideoMirrorMode peuvent tous deux configurer l'effet miroir pour la publication vidéo. Nous vous recommandons d'utiliser une seule de ces méthodes. L'utilisation simultanée de plusieurs méthodes peut entraîner une superposition des effets miroir, provoquant un échec ou une configuration incorrecte de l'effet miroir.

Paramètres

Paramètre

Type

Description

config

Propriétés d'encodage prédéfinies. Valeurs par défaut :

dimensions : [640, 480]. La valeur maximale est 1920x1080. Vous devez définir la résolution.
frameRate : 15
bitrate : 0. Le SDK calcule un débit d'encodage approprié en fonction de la résolution vidéo et du débit binaire.
keyFrameInterval : intervalle des images clés en millisecondes. La valeur par défaut est 0, ce qui signifie que le SDK le contrôle.
forceStrictKeyFrameInterval : indique si l'encodeur doit strictement respecter l'intervalle d'images clés défini. La valeur par défaut est false.
mirrorMode : 0
orientationMode : 0
rotation : 0
codecType : AliRtcVideoCodecTypeDefault
encoderType : AliRtcVideoEncodeCodecTypeDefault
seiForceFrontIFrame : -1
enableDynamicEncode : -1
disableDipenseResolutionChange : -1
enableDowngrade : -1
enableH264BFrame : -1
enableHevcBFrame : -1

Une valeur de -1 indique l'utilisation des paramètres par défaut internes du SDK.

setVideoDecoderConfiguration

Configure les propriétés de décodage vidéo.

    public abstract void setVideoDecoderConfiguration(AliRtcVideoDecoderConfiguration config);

Cette méthode définit les paramètres vidéo pour les propriétés de décodage du flux vidéo.

Quand appeler

Nous vous recommandons d'appeler cette méthode avant de rejoindre un canal.

Paramètres

Nom

Type

Description

config

AliRtcVideoDecoderConfiguration

Propriétés de décodage prédéfinies. Valeurs par défaut :

codecType : AliRtcVideoCodecTypeDefault. Type de décodage, incluant le décodage logiciel, le décodage matériel et le décodage de texture matériel.
enableDecoderBframe : -1. Indique s'il faut utiliser les images B. Si cette option est activée, le décodeur disposera d'une file d'attente tampon, augmentant ainsi la latence. Si l'expéditeur a activé les images B, vous devez activer cette option pour assurer un décodage correct.
textureBindContext : -1. Indique si la liaison du contexte de décodage de texture est prise en charge.

Une valeur de -1 indique l'utilisation des paramètres par défaut internes du SDK.

switchCamera

Bascule entre les caméras avant et arrière. La caméra avant est utilisée par défaut.

public abstract int switchCamera();

Cette méthode permet de basculer entre les caméras avant et arrière. La caméra avant est utilisée par défaut. Vous pouvez changer dynamiquement de caméra pendant l'exécution de l'application en fonction des caméras disponibles, sans redémarrer le flux vidéo ni reconfigurer la source vidéo.

Quand appeler

Appelez cette méthode après avoir activé la caméra avec succès.

Limites

Cette fonctionnalité est disponible uniquement sur Android et iOS.

Valeur de retour

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

getCurrentCameraDirection

Obtient l'orientation actuelle de la caméra.

public abstract AliRTCCameraDirection getCurrentCameraDirection();

Valeur de retour

Renvoie CAMERA_REAR(0) pour la caméra arrière.
Renvoie CAMERA_FRONT(1) pour la caméra avant.
Renvoie CAMERA_INVALID(-1) en cas d'erreur.

Remarque

Appelez cette méthode après l'activation de la caméra. Sinon, elle renverra CAMERA_INVALID(-1).

startPreview

Démarre l'aperçu local.

public abstract int startPreview();

Cette méthode lance l'aperçu vidéo local et active automatiquement la caméra. Pour arrêter l'aperçu local, appelez la méthode stopPreview.

Remarque

L'appel à leaveChannel pour quitter un canal arrête automatiquement l'aperçu local. Si vous ne publiez pas de flux caméra, celle-ci est automatiquement désactivée.

Quand appeler

Avant d'appeler cette méthode, définissez la vue pour l'aperçu local en appelant setLocalViewConfig. Sinon, l'aperçu ne s'affichera pas, mais cela n'affectera pas la publication.
Si nécessaire, vous pouvez appeler cette méthode pour démarrer l'aperçu avant de rejoindre un canal avec joinChannel. La caméra sera activée automatiquement.

Valeur de retour

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

stopPreview

Arrête l'aperçu local.

public abstract int stopPreview();

Cette méthode ferme l'aperçu vidéo local et désactive la caméra. Après l'arrêt de l'aperçu, l'extrémité locale reste sur la dernière image, ce qui n'affecte pas la publication.

Remarque

L'appel à leaveChannel pour quitter un canal arrête automatiquement l'aperçu local. Si vous ne publiez pas de flux caméra, celle-ci est automatiquement désactivée.

Quand appeler

Pour fermer l'aperçu après l'avoir démarré, appelez cette méthode.

Valeur de retour

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

setCameraZoom

Définit le facteur de zoom de la caméra.

public abstract int setCameraZoom(float zoom);

Définit le facteur de zoom de la caméra.

Limites

Seules les plateformes iOS et Android proposent cette interface.

Quand appeler

Ce paramètre prend effet uniquement après l'activation de la caméra. Le zoom est réinitialisé à chaque redémarrage de la caméra.

Paramètres

Paramètre

Type

Description

zoom

float

Facteur de zoom de la caméra. La plage va de 1 à la valeur de zoom maximale prise en charge par la caméra. Vous pouvez obtenir le facteur de zoom maximal pris en charge par l'appareil actuel en appelant GetCameraMaxZoomFactor.

Valeur de retour

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

GetCameraMaxZoomFactor

Obtient le facteur de zoom maximal pris en charge par la caméra.

public abstract float GetCameraMaxZoomFactor();

Valeur de retour

Le facteur de zoom maximal pris en charge par la caméra de l'appareil.

GetCurrentZoom

Obtient le paramètre actuel du facteur de zoom de la caméra.

public abstract float GetCurrentZoom();

Valeur de retour

Le facteur de zoom actuel de la caméra de l'appareil.

SetExposure

Définit l'exposition de la caméra.

public abstract int SetExposure(float exposure);

Lorsque la lumière ambiante est insuffisante ou trop intense, la qualité de la capture vidéo est affectée. Pour améliorer la qualité vidéo, utilisez cette méthode pour ajuster l'exposition de la caméra utilisée. Vous pouvez obtenir la plage d'exposition prise en charge par l'appareil actuel en appelant GetMinExposure et GetMaxExposure.

Paramètres

Paramètre

Type

Description

exposure

float

L'exposition de la caméra. La valeur par défaut est 0, ce qui signifie utiliser l'exposition par défaut de la caméra. Plus la valeur est élevée, plus l'exposition est importante. Si l'image vidéo est surexposée, réduisez le coefficient d'exposition. Si l'image vidéo est sous-exposée, entraînant une perte de détails dans les zones sombres, augmentez le coefficient d'exposition. Si l'exposition transmise se situe en dehors de la plage prise en charge par l'appareil, le SDK l'ajustera automatiquement.

Valeur de retour

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

GetCurrentExposure

Obtient l'exposition de la caméra.

public abstract float GetCurrentExposure();

Obtient le paramètre d'exposition de la caméra actuellement utilisée.

Valeur de retour

L'exposition actuelle de la caméra.

GetMinExposure

Obtient l'exposition minimale prise en charge par la caméra.

public abstract float GetMinExposure();

Valeur de retour

L'exposition minimale de la caméra.

GetMaxExposure

Obtient l'exposition maximale prise en charge par la caméra.

public abstract float GetMaxExposure();

Valeur de retour

L'exposition maximale de la caméra.

setCameraFlash

Active ou désactive le flash de la caméra.

public abstract int setCameraFlash(boolean flash);

Active ou désactive le flash.

Remarque

Généralement, seule la caméra arrière dispose d'une fonction flash.

Limites

Seules les plateformes iOS et Android proposent cette interface.

Paramètres

Paramètre

Type

Description

flash

boolean

Indique s'il faut activer le flash.

true : Activer le flash.
false : Désactiver le flash.

Valeur de retour

0 : Succès.
Valeur non nulle : Échec.

isCameraFocusPointSupported

Vérifie si l'appareil actuel prend en charge la mise au point manuelle.

public abstract boolean isCameraFocusPointSupported();

Vérifie si la caméra actuelle peut définir un point de mise au point pour prendre en charge la fonction de mise au point manuelle.

Limites

Seules les plateformes iOS et Android proposent cette interface.

Valeur de retour

true : L'appareil prend en charge la fonction de mise au point manuelle.
false : L'appareil ne prend pas en charge la fonction de mise au point manuelle.

isCameraExposurePointSupported

Vérifie si la définition d'un point d'exposition de la caméra est prise en charge.

public abstract boolean isCameraExposurePointSupported();

Vérifie si l'appareil actuel prend en charge la définition d'un point d'exposition.

Limites

Seules les plateformes iOS et Android proposent cette interface.

Valeur de retour

true : La définition d'un point d'exposition de la caméra est prise en charge.
false : La définition d'un point d'exposition de la caméra n'est pas prise en charge.

setCameraFocusPoint

Définit le point de mise au point manuelle pour la caméra.

public abstract int setCameraFocusPoint(float x, float y);

Définit le point de mise au point de la caméra actuelle. Après avoir appelé cette méthode, la caméra effectue un ajustement unique de l'exposition sur le point défini, puis maintient cette valeur de mise au point. Avant d'appeler cette méthode, nous vous recommandons d'appeler isCameraFocusPointSupported pour vérifier si l'appareil prend en charge la fonction de mise au point manuelle.

Limites

Seules les plateformes iOS et Android proposent cette interface.

Paramètres

Paramètre

Type

Description

float

La coordonnée sur l'axe des x.

float

La coordonnée sur l'axe des y.

Valeur de retour

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

setCameraExposurePoint

Définit le point d'exposition de la caméra.

public abstract int setCameraExposurePoint(float x, float y);

Définit le point d'exposition de la caméra. Après l'appel de cette méthode, la caméra effectue un ajustement unique de l'exposition sur le point défini et maintient cette valeur d'exposition. Avant d'appeler cette méthode, nous vous recommandons d'appeler isCameraExposurePointSupported pour vérifier si l'appareil prend en charge la fonction de mise au point manuelle.

Limites

Seules les plateformes iOS et Android proposent cette interface.

Paramètres

Paramètre

Type

Description

float

La coordonnée sur l'axe des x.

float

La coordonnée sur l'axe des y.

Valeur de retour

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

isCameraAutoFocusFaceModeSupported

Vérifie si la mise au point automatique sur les visages est prise en charge par la caméra.

public abstract boolean isCameraAutoFocusFaceModeSupported();

Vérifie si la mise au point automatique sur les visages est prise en charge par la caméra.

Quand appeler

Cela prend effet uniquement après l'activation de la caméra. Si la caméra n'est pas activée lors de l'appel, la méthode renvoie false par défaut. Si la caméra est activée et prend en charge à la fois la reconnaissance faciale et les fonctions de mise au point, elle renvoie true.

Limites

Seules les plateformes iOS et Android proposent cette interface.

Valeur de retour

true : La mise au point automatique sur les visages est prise en charge.
false : La mise au point automatique sur les visages n'est pas prise en charge.

setCameraAutoFocusFaceModeEnabled

Configure la mise au point sur les visages de la caméra.

public abstract boolean setCameraAutoFocusFaceModeEnabled(boolean enable);

Appelez cette méthode pour configurer la caméra afin qu'elle fasse la mise au point sur les visages en temps réel. Avant d'appeler cette méthode, appelez isCameraAutoFocusFaceModeSupported pour vérifier que l'appareil prend en charge cette fonctionnalité.

Limites

Seules les plateformes iOS et Android proposent cette interface.

Paramètres

Paramètre

Type

Description

enable

boolean

Active ou désactive la fonction de mise au point sur les visages de la caméra.

true : Activer.
false : Désactiver.

Valeur de retour

true : L'appel a réussi.
false : L'appel a échoué.

setVideoMirrorMode

Définit la capacité de mise en miroir vidéo pour l'aperçu et l'ingestion.

public abstract int setVideoMirrorMode(AliRtcVideoPipelineMirrorMode mirrorMode);

Définit s'il faut activer le mode miroir pour la vidéo d'aperçu local et le flux vidéo publié.

Remarque

Cette méthode a une priorité plus élevée que setLocalViewConfig&setVideoEncoderConfiguration. Pour définir le mode miroir vidéo, nous vous recommandons d'appeler cette méthode.

Quand appeler

Vous pouvez définir dynamiquement cette méthode avant et après avoir rejoint un canal. Le SDK enregistre l'état et effectue l'opération vidéo lorsqu'il peut agir sur l'aperçu et l'encodage (publication).

Limites

Cette méthode chevauche le paramètre mirrorMode dans setLocalViewConfig&setVideoEncoderConfiguration. Nous vous recommandons d'utiliser une seule méthode.

Paramètres

Paramètre

Type

Description

mirrorMode

AliRtcVideoPipelineMirrorMode

Définit le mode miroir.

Valeur de retour

0 : Succès.
<0 : Échec.
- AliRtcErrInner : Erreur interne du SDK. Vérifiez si l'instance du SDK a été créée avec succès.

setCapturePipelineScaleMode

Définit le moment de la mise à l'échelle de la capture vidéo.

public abstract void setCapturePipelineScaleMode(AliRtcCapturePipelineScaleMode mode);

Définit si la mise à l'échelle des données vidéo capturées se produit immédiatement lors de la capture ou uniquement pendant l'encodage. Par exemple, lorsque la résolution de capture et la résolution d'encodage sont incohérentes, vous pouvez définir le moment de la mise à l'échelle pour déterminer si les données d'aperçu et les données publiées sont cohérentes.

Quand appeler

Appelez cette méthode avant d'activer la caméra, par exemple avant de démarrer un aperçu avec startPreview ou de rejoindre un canal avec joinChannel.

Paramètres

Paramètre

Type

Description

mode

AliRtcCapturePipelineScaleMode

Le mode qui contrôle le moment de la mise à l'échelle de la capture. Par défaut, la mise à l'échelle est effectuée immédiatement lors de la capture.

Valeur de retour

Aucune.

setExternalVideoSource

Active une source d'entrée vidéo externe.

public abstract void setExternalVideoSource(boolean enable,boolean useTexture,
 AliRtcVideoTrack streamType,AliRtcRenderMode renderMode);

Paramètres

Paramètre	Type	Description
enable	boolean	Active une source d'entrée vidéo externe. Valeurs valides : true : Activer. false (par défaut) : Désactiver.
useTexture	boolean	Indique s'il faut utiliser le mode texture. Valeurs valides : true : Utiliser. false (par défaut) : Ne pas utiliser.
type	AliRtcVideoTrack	Type de flux vidéo.
renderMode	AliRtcRenderMode	Mode de rendu.

pushExternalVideoFrame

Injecte des données vidéo.

public abstract int pushExternalVideoFrame(AliRtcRawDataFrame aliRawDataFrame,AliRtcVideoTrack streameType);

Paramètres

Paramètre

Type

Description

aliRawDataFrame

AliRtcRawDataFrame

Données de trame.

streameType

AliRtcLiveTranscodingParam

Type de flux vidéo.

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

startPublishLiveStream

Démarre la diffusion en direct par relais (bypass).

public abstract int startPublishLiveStream(String streamUrl,AliRtcLiveTranscodingParam transcodingParam);

Paramètres

Paramètre

Type

Description

streamUrl

String

URL d'ingestion.

transcodingParam

Paramètres d'ingestion.

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

updatePublishLiveStream

Met à jour les paramètres de diffusion en direct par relais (bypass).

public abstract int updatePublishLiveStream(String streamUrl,AliRtcLiveTranscodingParam transcodingParam);

Paramètres

Paramètre

Type

Description

streamUrl

String

URL d'ingestion.

transcodingParam

AliRtcLiveTranscodingParam

Paramètres d'ingestion.

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

stopPublishLiveStream

Arrête la diffusion en direct par relais (bypass).

public abstract int stopPublishLiveStream(String streamUrl);

Paramètres

Paramètre

Type

Description

streamUrl

String

URL d'ingestion.

Valeur de retour

La valeur 0 indique que l'appel de méthode a réussi. Toute autre valeur indique un échec.

getPublishLiveStreamState

Récupère l'état de la diffusion en direct par relais (bypass).

public abstract AliRtcEngine.AliRtcLiveTranscodingState getPublishLiveStreamState(String streamUrl);

Paramètres

Paramètre

Type

Description

streamUrl

String

URL d'ingestion du flux de diffusion en direct par relais.

Valeur de retour

Renvoie l'état de la diffusion en direct par relais.

startNetworkQualityProbeTest

Démarre une sonde de qualité réseau.

public abstract int startNetworkQualityProbeTest(AlirtcNetworkQualityProbeConfig config);

Paramètres

Paramètre

Type

Description

config

AlirtcNetworkQualityProbeConfig

Paramètres de configuration de la sonde.

Valeur de retour

0 : Succès. Autre : Échec.

stopNetworkQualityProbeTest

Arrête une sonde de qualité réseau.

public abstract int stopNetworkQualityProbeTest();

Valeur de retour

0 : Succès. Autre : Échec.

sendMediaExtensionMsg

Envoie un message d'extension multimédia.

public abstract int sendMediaExtensionMsg(byte[]message, int repeatCount, int delay, boolean isKeyFrame);

Le SDK offre la fonctionnalité d'envoi et de réception de messages d'extension multimédia. Cette méthode envoie des messages d'extension multimédia via le protocole d'extension SEI. Les récepteurs peuvent obtenir les messages en écoutant le rappel onMediaExtensionMsgReceived.

Les scénarios courants incluent les cas suivants :

Utilisation des messages d'extension multimédia pour transmettre des horodatages afin de calculer la latence réseau de bout en bout ou pour synchroniser les données avec d'autres services métier.
Utilisation des messages d'extension multimédia pour transmettre des informations descriptives. Actuellement, jusqu'à 4 Ko de données peuvent être transmis, ce qui permet de transférer de petites quantités de données. Nous recommandons d'utiliser JSON ou des chaînes de caractères simples.

Quand appeler

Appelez cette méthode après avoir commencé à publier un flux.

Limites

Lors de l'utilisation des messages d'extension multimédia, les canaux de données audio et vidéo sont réutilisés. Par conséquent, vous devez contrôler la fréquence d'envoi et la longueur des données du message. Les limites sont les suivantes :

Vous pouvez envoyer un maximum de messages par seconde égal au nombre d'images par seconde (fps), tel que défini dans le profil. Les informations SEI sont transmises dans le flux H.264/H.265, et les informations d'extension ne peuvent être jointes que lors de l'encodage des trames vidéo.
Pour éviter d'affecter la qualité de la transmission des données multimédias, le corps du message personnalisé est limité à 4 Ko. Il peut être utilisé pour transmettre de petites quantités d'informations.
Le paramètre repeatCount de la fonction sendMediaExtensionMsg représente la redondance du message personnalisé. S'il est supérieur à 1, le message sera envoyé plusieurs fois.
Pour prévenir la perte de messages due à la perte de paquets réseau, les autres participants du canal recevront également le même message plusieurs fois et devront supprimer les doublons.
Lorsque des messages personnalisés sont envoyés, les abonnés du canal les recevront également pendant la diffusion en direct par relais.
Un seul MediaExtensionMsg peut être transmis à la fois. Si vous appelez sendMediaExtensionMsg plusieurs fois, les nouvelles données écraseront les données précédentes.

Rappels associés

Après que l'émetteur a envoyé un message d'extension multimédia, le récepteur peut obtenir le message en écoutant le rappel onMediaExtensionMsgReceived.

Paramètres

Paramètre

Type

Description

message

byte[]

Message d'extension multimédia. La longueur maximale est de 4 Ko.

repeatCount

int

Nombre de répétitions. Cela représente la redondance du message pour prévenir la perte de messages due à la perte de paquets réseau. -1 signifie une transmission infinie.

delay

int

Délai en millisecondes. Temps minimum en millisecondes pour envoyer le message d'extension après l'appel de l'API.

isKeyFrame

boolean

Indique si le message d'extension doit être utilisé uniquement pour les images clés. true signifie que le message d'extension est joint uniquement aux images clés.

Valeur de retour

0 : Succès.
<0 : Échec. Un code d'erreur est renvoyé.
- ERR_INNER(-1) : Erreur interne du SDK. Le SDK n'a peut-être pas été initialisé ou a été appelé après sa destruction.

sendMediaExtensionMsgEx

Envoie un message d'extension multimédia.

public abstract int sendMediaExtensionMsgEx(byte[]message, int repeatCount, int delay, boolean isKeyFrame, int payloadType);

Le SDK offre des fonctionnalités pour envoyer et recevoir des messages d'extension multimédia. Cette méthode envoie un message d'extension multimédia via le protocole d'extension SEI. Le récepteur peut obtenir le message en écoutant le rappel onMediaExtensionMsgReceived. Lorsque payloadType est égal à 5, cela équivaut à utiliser la méthode sendMediaExtensionMsg.

Les scénarios courants incluent les cas suivants :

Utilisation des messages d'extension multimédia pour transmettre des horodatages afin de calculer la latence réseau de bout en bout ou pour synchroniser les données avec d'autres services métier.
Utilisation des messages d'extension multimédia pour transmettre des informations descriptives. Actuellement, jusqu'à 4 Ko de données peuvent être transmis, ce qui permet de transférer de petites quantités de données. Nous recommandons d'utiliser JSON ou des chaînes de caractères simples.

Quand appeler

Appelez cette méthode après avoir commencé à publier un flux.

Limites

Vous pouvez envoyer un maximum de messages par seconde égal au nombre d'images par seconde (fps), tel que défini dans le profil. Les informations SEI sont transmises dans le flux H.264/H.265, et les informations d'extension ne peuvent être jointes que lors de l'encodage des trames vidéo.
Pour éviter d'affecter la qualité de la transmission des données multimédias, le corps du message personnalisé est limité à 4 Ko. Il peut être utilisé pour transmettre de petites quantités d'informations.
Le paramètre repeatCount de la fonction sendMediaExtensionMsg représente la redondance du message personnalisé. S'il est supérieur à 1, le message sera envoyé plusieurs fois.
Pour prévenir la perte de messages due à la perte de paquets réseau, les autres participants du canal recevront également le même message plusieurs fois et devront supprimer les doublons.
Lorsque des messages personnalisés sont envoyés, les abonnés du canal les recevront également pendant la diffusion en direct par relais.
Un seul MediaExtensionMsg peut être transmis à la fois. Si vous appelez sendMediaExtensionMsg plusieurs fois, les nouvelles données écraseront les données précédentes.

Paramètres

Paramètre

Type

Description

message

byte[]

Message d'extension multimédia. La longueur maximale est de 4 Ko.

repeatCount

int

Nombre de répétitions. Cela représente la redondance du message pour prévenir la perte de messages due à la perte de paquets réseau. -1 signifie une transmission infinie.

delay

int

Délai en millisecondes. Temps minimum en millisecondes pour envoyer le message d'extension après l'appel de l'API.

isKeyFrame

boolean

Indique si le message d'extension doit être utilisé uniquement pour les images clés. true signifie que le message d'extension est joint uniquement aux images clés.

payloadType

int

La plage est [5, 100..254]. payloadType=5 équivaut à utiliser la méthode sendMediaExtensionMsg.

Valeur de retour

0 : Succès.
<0 : Échec. Un code d'erreur est renvoyé.
- ERR_INNER(-1) : Erreur interne du SDK. Le SDK n'a peut-être pas été initialisé ou a été appelé après sa destruction.

onConnectionStatusChange

Rappel pour les changements d'état de la connexion réseau. Vous devez gérer ce rappel.

public void onConnectionStatusChange(AliRtcEngine.AliRtcConnectionStatus status,
 AliRtcEngine.AliRtcConnectionStatusChangeReason reason);

Paramètres

Paramètre

Type

Description

status

AliRtcConnectionStatus

État actuel de la connexion réseau.

reason

AliRtcConnectionStatusChangeReason

Raison du changement d'état de la connexion réseau.

OnLocalDeviceException

Rappel pour les exceptions de périphérique local. Vous devez gérer ce rappel.

public void OnLocalDeviceException(AliRtcEngine.AliRtcEngineLocalDeviceType deviceType, AliRtcEngine.AliRtcEngineLocalDeviceExceptionType exceptionType, String msg)

Paramètres

Paramètre

Type

Description

deviceType

AliRtcEngineLocalDeviceType

Type de périphérique

exceptionType

AliRtcEngineLocalDeviceExceptionType

Type d'exception de périphérique

msg

String

Informations associées à l'exception.

onAuthInfoWillExpire

public void onAuthInfoWillExpire();

Ce rappel indique que les informations d'authentification de l'utilisateur sont sur le point d'expirer. L'authentification expire 30 secondes après la réception de ce rappel. Vous devez obtenir un nouveau jeton, puis mettre à jour les informations d'authentification de l'une des manières suivantes :

Appelez <a baseurl="t2309760_v6_4_1.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#975b9af9ecq1a" id="8099ac5a509hn">refreshAuthInfo</a> pour mettre à jour les informations d'authentification.
Appelez <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="fe88be037dy4g">leaveChannel</a> pour quitter le canal actuel, puis appelez joinChannel pour rejoindre à nouveau le canal.

Quand déclenché

Le SDK déclenche ce rappel 30 secondes avant l'expiration des informations d'authentification de l'utilisateur. Vous devez mettre à jour les informations d'authentification rapidement après avoir reçu ce rappel.

onAuthInfoExpired

Le serveur renvoie que les informations ont expiré lorsque l'utilisateur appelle une interface nécessitant une authentification.

public void onAuthInfoExpired();

Ce rappel indique que les informations d'authentification de l'utilisateur ont expiré. Si vous souhaitez poursuivre la session, vous devez générer un nouveau jeton sur le serveur, puis mettre à jour les informations d'authentification en :

Appelant <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="c3b0cf2f19dgm">leaveChannel</a> pour quitter le canal actuel, puis en appelant joinChannel pour rejoindre à nouveau le canal.

Quand déclenché

Ce rappel est déclenché lorsque les informations d'authentification de l'utilisateur expirent.

onJoinChannelResult

Rappel pour le résultat de la jonction à un canal.

public void onJoinChannelResult(int result, String channel, String userId, int elapsed);

Paramètres

Paramètre	Type	Description
result	int	Résultat de la jonction au canal. Une valeur de retour de 0 indique un succès. Un code d'erreur est renvoyé en cas d'échec. Pour plus d'informations, consultez la liste des codes d'erreur. Voici quelques codes d'erreur courants : ERR_JOIN_BAD_APPID : L'AppId n'existe pas. ERR_JOIN_INVALID_APPID : L'AppId a expiré. ERR_JOIN_BAD_CHANNEL : Le canal n'existe pas. ERR_JOIN_INVALID_CHANNEL : Le canal a expiré. ERR_JOIN_BAD_TOKEN : Le jeton n'existe pas. ERR_JOIN_TIMEOUT : Délai dépassé lors de la jonction au canal. ERR_JOIN_BAD_PARAM : Paramètre incorrect pour la jonction au canal. ERR_JOIN_FAILED : Échec de la jonction au canal. ERR_JOIN_CONFIG_INVALID : Paramètre de jonction invalide, tel qu'un jeton vide.
channel	String	ID du canal.
userId	String	ID utilisateur.
elapsed	int	Temps pris pour rejoindre le canal, en millisecondes.

onLeaveChannelResult

Rappel pour le résultat de la sortie d'un canal.

public void onLeaveChannelResult(int result, AliRtcEngine.AliRtcStats stats);

Condition de déclenchement

Lorsque l'application appelle avec succès <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="7f3d2133c81tx">leaveChannel</a> pour quitter le canal, ce rappel est déclenché et renvoie le résultat de la sortie du canal ainsi que les statistiques de cette session de canal.

Remarque

Si vous appelez <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="fdccda828dzqt">leaveChannel</a> puis appelez immédiatement destroy pour détruire le moteur, ce rappel n'est pas déclenché.

Paramètres

Paramètre

Type

Description

result

int

Résultat de la sortie du canal. La valeur 0 indique une réussite. Un code d'erreur est renvoyé en cas d'échec.

stats

AliRtcStats

Résumé des statistiques de données pour la session dans ce canal.

onRemoteUserOffLineNotify

Rappel lorsqu'un utilisateur distant se déconnecte.

public void onRemoteUserOffLineNotify(String uid, AliRtcUserOfflineReason reason);

Ce rappel informe l'utilisateur local qu'un utilisateur distant a quitté le canal pour diverses raisons. Cette méthode est déclenchée lorsqu'un utilisateur distant se déconnecte.

Condition de déclenchement

Le rappel est déclenché lorsqu'un utilisateur distant quitte activement le canal.
Lorsqu'un diffuseur distant appelle <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#84f350f904s98" id="4c0adbe948tif">setClientRole</a> pour passer au rôle de spectateur (en appelant AliRtcEngine#setClientRole pour définir le rôle sur AliRTCSdkLive), un rappel est déclenché.
Le rappel est déclenché lorsqu'aucune donnée n'est reçue du diffuseur distant pendant une longue période et que l'utilisateur est considéré comme déconnecté.

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant.

reason

AliRtcUserOfflineReason

Raison de la déconnexion de l'utilisateur.

onRemoteUserOnLineNotify

Rappel lorsqu'un utilisateur distant se connecte.

public void onRemoteUserOnLineNotify(String uid, int elapsed);

Cette méthode informe le client local qu'un utilisateur distant a rejoint le canal.

Condition de déclenchement

Un utilisateur distant rejoint le canal avec succès.
Après que l'utilisateur actuel a rejoint le canal, il reçoit un rappel de connexion pour les utilisateurs déjà présents dans le canal, ce qui permet d'afficher les utilisateurs précédemment connectés.

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant.

elapsed

int

Temps nécessaire à l'utilisateur pour rejoindre le canal, en millisecondes.

onRemoteTrackAvailableNotify

Rappel lorsque le flux audio ou vidéo d'un utilisateur distant change.

public void onRemoteTrackAvailableNotify(String uid, AliRtcAudioTrack audioTrack,
 AliRtcVideoTrack videoTrack);

Ce rappel est déclenché lorsque l'état de publication d'un utilisateur distant change. Grâce à ce rappel, vous pouvez savoir en temps réel si un utilisateur distant publie des flux audio et vidéo, et afficher ou masquer les informations audio et vidéo de l'utilisateur distant sur l'interface en conséquence.

Remarque

Ce rappel renvoie l'état de publication de l'utilisateur distant. Pour savoir quel flux s'est déconnecté lors de ce changement, enregistrez les modifications d'état avant et après le rappel.

Condition de déclenchement

Ce rappel est déclenché dans les scénarios suivants :

Lorsqu'un utilisateur distant passe de l'état non publié à l'état publié (y compris l'audio et la vidéo).
Lorsqu'un utilisateur distant passe de l'état publié à l'état non publié (y compris l'audio et la vidéo).
En mode interactif, lorsqu'un utilisateur distant appelle setClientRole pour passer du rôle de spectateur à celui de diffuseur et active également la publication, ce rappel est déclenché.

Prenons la vidéo comme exemple. Supposons que l'utilisateur distant soit configuré pour ne pas publier. Ce rappel n'est pas déclenché.

Si un utilisateur distant commence à pousser un flux de caméra (État d'ingestion de flux : aucun flux vidéo -> uniquement le flux de caméra), le rappel sur le client local renvoie AliRtcVideoTrackCamera pour indiquer que le flux de caméra de l'utilisateur distant est disponible.
Si l'utilisateur distant pousse également un flux de partage d'écran (État d'ingestion de flux : uniquement le flux de caméra -> flux de caméra et flux de partage d'écran), l'extrémité locale reçoit le rappel AliRtcVideoTrackBoth , indiquant que les flux de caméra et de partage d'écran de l'utilisateur distant sont tous deux disponibles.
Si l'utilisateur distant arrête de pousser le flux de caméra et ne conserve que le flux de partage d'écran (État d'ingestion de flux : flux de caméra et de partage d'écran -> uniquement le flux de partage d'écran), le client local reçoit le rappel AliRtcVideoTrackScreen , indiquant que seul le flux de partage d'écran est actuellement disponible.
Si l'utilisateur distant arrête également de pousser le flux de partage d'écran (État d'ingestion de flux : poussée uniquement du flux de partage d'écran -> aucune poussée de flux vidéo), le client local reçoit le rappel AliRtcVideoTrackNo , qui indique qu'aucun flux vidéo n'est actuellement actif.

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant.

audioTrack

Flux audio après la modification de l'utilisateur distant.

videoTrack

Flux vidéo après la modification de l'utilisateur distant.

onBye

Rappel lorsque l'utilisateur est expulsé du serveur ou que le canal est fermé.

public void onBye(int code);

Lorsqu'un utilisateur est déconnecté pour une raison quelconque ou que la réunion se termine, ce rappel est déclenché, ce qui vous permet d'utiliser le paramètre de rappel code pour déterminer la raison de la déconnexion et prendre les mesures appropriées.

Condition de déclenchement

L'utilisateur actuel est expulsé du serveur.
La session se termine (le serveur supprime activement le canal).
Départ passif. Le client doit essayer de restaurer la session ou de se reconnecter.

Paramètres

Paramètre

Type

Description

code

int

Type onBye. Pour plus d'informations, consultez AliRtcOnByeType.

onAudioPublishStateChanged

Rappel pour les changements d'état de publication audio.

public void onAudioPublishStateChanged(AliRtcEngine.AliRtcPublishState oldState , 
 AliRtcEngine.AliRtcPublishState newState,
 int elapseSinceLastState, String channel);

Ce rappel écoute les changements d'état de publication audio de l'utilisateur local.

Condition de déclenchement

Lorsque l'état de publication audio de l'utilisateur change, par exemple :

La publication est arrêtée.
Appel de <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#84f350f904s98" id="e6c8edfc45xbw">setClientRole</a> pour passer au rôle de spectateur.

Paramètres

Paramètre

Type

Description

oldState

État de publication précédent.

newState

État de publication actuel.

elapseSinceLastState

int

Intervalle de temps depuis le dernier changement d'état, en millisecondes.

channel

String

ID du canal actuel.

onAudioSubscribeStateChanged

Rappel pour les changements d'état d'abonnement audio.

public void onAudioSubscribeStateChanged(String uid,
 AliRtcEngine.AliRtcSubscribeState oldState,
 AliRtcEngine.AliRtcSubscribeState newState,
 int elapseSinceLastState, String channel);

Ce rappel informe l'utilisateur local lorsque l'état d'abonnement au flux audio d'un utilisateur distant change. Grâce à ce rappel, vous pouvez connaître le changement d'état d'abonnement du flux audio d'un utilisateur distant spécifique et l'intervalle de temps entre l'état précédent et l'état actuel.

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant.

oldState

État d'abonnement précédent.

newState

État d'abonnement actuel.

elapseSinceLastState

int

Intervalle de temps depuis le dernier changement d'état, en millisecondes.

channel

String

ID du canal actuel.

onUserAudioMuted

Notification indiquant que l'utilisateur distant a arrêté d'envoyer des données audio.

public void onUserAudioMuted(String uid ,boolean isMute);

Paramètres

Paramètre

Type

Description

uid

String

Utilisateur qui a exécuté muteAudio.

isMute

boolean

Indique si l'utilisateur est en sourdine. Valeurs possibles :

true : en sourdine.
false : pas en sourdine.

onUserAudioInterruptedBegin

Notification indiquant que l'audio d'un utilisateur a été interrompu.

public void onUserAudioInterruptedBegin(String uid);

Paramètres

Paramètre

Type

Description

uid

String

Utilisateur dont l'audio a été interrompu.

onUserAudioInterruptedEnded

Notification indiquant que l'interruption audio d'un utilisateur est terminée.

public void onUserAudioInterruptedEnded(String uid);

Paramètres

Paramètre

Type

Description

uid

String

Utilisateur dont l'audio a été interrompu.

onVideoPublishStateChanged

Rappel pour les changements d'état de publication vidéo.

public void onVideoPublishStateChanged(AliRtcEngine.AliRtcPublishState oldState , 
 AliRtcEngine.AliRtcPublishState newState, 
 int elapseSinceLastState, String channel);

Ce rappel écoute les changements d'état de publication vidéo de l'utilisateur local.

Paramètres

Paramètre

Type

Description

oldState

État de publication précédent.

newState

État de publication actuel.

elapseSinceLastState

int

Intervalle de temps depuis le dernier changement d'état, en millisecondes.

channel

String

ID du canal actuel.

onVideoSubscribeStateChanged

Rappel pour les changements d'état d'abonnement au flux de caméra.

public void onVideoSubscribeStateChanged(String uid,
 AliRtcEngine.AliRtcSubscribeState oldState,
 AliRtcEngine.AliRtcSubscribeState newState,
 int elapseSinceLastState, String channel);

Ce rappel informe l'utilisateur local lorsque l'état d'abonnement au flux de caméra d'un utilisateur distant change. Grâce à ce rappel, vous pouvez connaître le changement d'état d'abonnement du flux de caméra d'un utilisateur distant spécifique et l'intervalle de temps entre l'état précédent et l'état actuel.

Rappels associés

Les flux vidéo se composent principalement de flux de caméra et de flux de partage d'écran. Cette interface concerne les changements d'état d'abonnement d'un flux de caméra. L'interface de rappel associée pour un flux de partage d'écran est onScreenShareSubscribeStateChanged.

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant.

oldState

État d'abonnement précédent.

newState

État d'abonnement actuel.

elapseSinceLastState

int

Intervalle de temps depuis le dernier changement d'état.

channel

String

ID du canal actuel.

onUserVideoMuted

Notification indiquant que l'utilisateur distant envoie des trames vidéo noires.

public void onUserVideoMuted(String uid, boolean isMute);

Paramètres

Paramètre

Type

Description

uid

String

Utilisateur qui a exécuté enableLocalVideo.

isMute

boolean

Indique s'il faut envoyer des trames noires. Valeurs possibles :

true : publier des trames noires.
false : publier normalement.

onUserVideoEnabled

Notification indiquant que l'utilisateur distant a désactivé la collecte du flux de caméra.

public void onUserVideoEnabled(String uid, boolean isMute);

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant.

isMute

boolean

Indique s'il faut activer la collecte du flux de la caméra. Valeurs possibles :

true : active la collecte du flux de la caméra.
false : désactive la collecte du flux de la caméra.

onUserWillResignActive

L'application de l'utilisateur distant est passée en arrière-plan.

public void onUserWillResignActive(String uid);

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur.

onUserWillBecomeActive

L'application de l'utilisateur distant est revenue au premier plan.

public void onUserWillBecomeActive(String uid);

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur.

onAliRtcStats

Rappel pour les statistiques de la session en cours. Le SDK déclenche ce rappel toutes les deux secondes.

public void onAliRtcStats(AliRtcEngine.AliRtcStats stats);

Paramètres

Paramètre

Type

Description

stats

AliRtcStats

Statistiques de la session.

onAudioEffectFinished

Rappel indiquant la fin de la lecture d'un effet sonore local.

void OnAudioEffectFinished(int soundId);

Paramètres

Paramètre

Type

Description

soundId

int

ID attribué par l'utilisateur au fichier d'effet sonore.

onAudioFileInfo

Rappel contenant les informations sur le fichier audio.

public void  onAudioFileInfo(AliRtcEngine.AliRtcAudioFileInfo info, AliRtcEngine.AliRtcAudioAccompanyErrorCode errorCode);

Lorsque vous appelez getAudioFileInfo pour obtenir les informations sur un fichier audio, ce rappel est déclenché pour afficher la durée du fichier audio et d'autres informations ou messages d'erreur.

Paramètres

Paramètre

Type

Description

info

AliRtcEngine.AliRtcAudioFileInfo

Informations sur le fichier audio, y compris le chemin d'accès au fichier et sa durée.

errorCode

AliRtcEngine.AliRtcAudioAccompanyErrorCode

<!--@p {"id":"81871cb71cbbg"}--br>Code d'erreur d'accompagnement audio, principalement pour les erreurs d'ouverture et de décodage de fichier.

onMediaExtensionMsgReceived

Rappel pour la réception d'un message d'extension multimédia.

public void onMediaExtensionMsgReceived(String uid, int payloadType, byte[]message);

Lorsqu'une extrémité envoie un message via sendMediaExtensionMsg, les autres extrémités reçoivent les données via ce rappel.

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur qui a envoyé le message multimédia.

payloadType

int

Type de charge utile. sendMediaExtensionMsg renvoie 5. sendMediaExtensionMsgEx renvoie le type spécifique.

message

byte[]

Message d'extension multimédia.

onFirstRemoteVideoFrameDrawn

Ce message est déclenché lorsque la première image vidéo d'un utilisateur distant est affichée.

public void onFirstRemoteVideoFrameDrawn(String uid,AliRtcVideoTrack videoTrack, int width, int height, int elapsed);

Il s'agit du rappel pour la première image rendue d'une vidéo distante. Il est déclenché lorsque l'utilisateur local reçoit et rend avec succès la première image vidéo d'un utilisateur distant. Ce rappel vous aide à surveiller le temps de configuration du lien vidéo distant, à évaluer les performances du réseau et de l'appareil, et à optimiser l'expérience utilisateur.

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant.

videoTrack

Type de flux vidéo reçu.

width

int

Largeur de la vidéo extraite.

height

int

Hauteur de la vidéo extraite.

elapsed

int

Délai total entre le moment où l'utilisateur local rejoint le canal et l'affichage de la première image de la vidéo extraite (en millisecondes).

onFirstLocalVideoFrameDrawn

Ce message est déclenché lorsque la première image vidéo est affichée dans l'aperçu.

public void onFirstLocalVideoFrameDrawn(int width, int height, int elapsed);

Il s'agit du rappel pour la première image affichée dans l'aperçu vidéo local. Il est déclenché lorsque la première image vidéo locale est rendue après que l'utilisateur local a activé la caméra. Ce rappel vous aide à surveiller la vitesse de configuration de l'aperçu vidéo local, à évaluer les performances de l'appareil et à optimiser l'expérience utilisateur (par exemple, en affichant un message « Caméra prête » ou en ajustant la disposition de l'aperçu).

Paramètres

Paramètre

Type

Description

width

int

Largeur de la vidéo d'aperçu local.

height

int

Hauteur de la vidéo d'aperçu local.

elapsed

int

Délai total entre le moment où l'utilisateur local rejoint le canal et l'affichage de la première image de l'aperçu local (en millisecondes).

onFirstVideoFrameReceived

Rappel pour la réception de la première image vidéo d'un utilisateur distant.

public void onFirstVideoFrameReceived(String uid, AliRtcVideoTrack videoTrack, int timeCost);

Il s'agit du rappel pour la réception de la première image d'une vidéo distante. Il est déclenché lorsque l'utilisateur local reçoit avec succès la première image vidéo d'un utilisateur distant. Ce rappel vous aide à surveiller le temps de configuration du lien vidéo, à évaluer la qualité du réseau et à optimiser l'expérience utilisateur (par exemple, en affichant un message « Vidéo prête » ou en ajustant la logique de lecture).

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant.

videoTrack

Type de flux vidéo reçu.

timeCost

int

Coût temporel de l'envoi. Temps écoulé entre la connexion au canal et l'envoi du premier paquet vidéo (en millisecondes).

onFirstVideoPacketSent

Rappel pour le premier paquet vidéo envoyé.

public void onFirstVideoPacketSent(String uid, AliRtcVideoTrack videoTrack, int timeCost);

Il s'agit du rappel pour le premier paquet vidéo local envoyé. Il est déclenché lorsque l'utilisateur local envoie avec succès le premier paquet de données vidéo. Ce rappel vous aide à surveiller la vitesse de configuration du lien d'envoi vidéo, à évaluer les performances de l'appareil local et à optimiser l'expérience utilisateur (par exemple, en affichant un message « Vidéo envoyée » ou en ajustant la politique de collecte).

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant.

videoTrack

Type de flux vidéo reçu.

timeCost

int

Coût temporel de l'envoi. Temps écoulé entre la connexion au canal et l'envoi du premier paquet vidéo (en millisecondes).

onFirstAudioPacketSent

Rappel pour le premier paquet audio envoyé.

public void onFirstAudioPacketSent(String uid, AliRtcAudioTrack track, int timeCost);

Il s'agit du rappel pour le premier paquet audio local envoyé. Il est déclenché lorsque l'utilisateur local envoie avec succès le premier paquet de données audio. Ce rappel vous aide à surveiller la vitesse de configuration du lien d'envoi audio, à évaluer les performances de l'appareil local et du système, et à optimiser l'expérience utilisateur.

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant.

track

Type de flux audio reçu.

timeCost

int

Coût temporel de l'envoi. Temps écoulé entre la connexion au canal et l'envoi du premier paquet audio (en millisecondes).

onFirstVideoPacketReceived

Rappel pour le premier paquet vidéo reçu.

public void onFirstVideoPacketReceived(String uid, AliRtcVideoTrack videoTrack, int timeCost)

Il s'agit du rappel pour le premier paquet vidéo distant reçu. Il est déclenché lorsque l'utilisateur local reçoit le premier paquet de données vidéo d'un utilisateur distant. Vous pouvez utiliser ce rappel pour surveiller la vitesse de configuration du lien vidéo ou mettre à jour les composants d'interface utilisateur du flux de lecture.

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant.

videoTrack

Type de flux vidéo reçu.

timeCost

int

Temps écoulé entre le moment où l'utilisateur local rejoint le canal et la réception du premier paquet vidéo (en millisecondes).

onFirstAudioPacketReceived

Rappel pour le premier paquet audio reçu.

public void onFirstAudioPacketReceived(String uid, AliRtcAudioTrack track, int timeCost)

Il s'agit du rappel pour le premier paquet audio distant reçu. Il est déclenché lorsque l'utilisateur local reçoit le premier paquet de données audio d'un utilisateur distant. Ce rappel vous aide à surveiller la vitesse de configuration du lien audio, à évaluer la qualité du réseau et à optimiser l'expérience utilisateur (par exemple, en affichant un message « Audio connecté » ou en ajustant la politique de lecture).

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant.

track

Type de flux audio reçu.

timeCost

int

Temps écoulé entre le moment où l'utilisateur local rejoint le canal et la réception du premier paquet audio (en millisecondes).

onFirstRemoteAudioDecoded

Rappel pour la première image audio distante décodée.

public void onFirstRemoteAudioDecoded(String uid, AliRtcAudioTrack track, int elapsed)

Il s'agit du rappel pour la première image décodée d'un flux audio distant extrait. Il vous informe que le flux audio de l'utilisateur distant a été décodé avec succès et peut être lu normalement. Vous pouvez utiliser ce rappel pour mesurer le temps de la première image ou mettre à jour les composants d'interface utilisateur du flux de lecture.

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant.

track

Type de flux audio reçu.

elapsed

int

Délai entre le moment où l'utilisateur local rejoint le canal et le décodage de la première image audio (en millisecondes).

onAudioAccompanyStateChanged

Rappel pour l'état de lecture de l'accompagnement local.

public void onAudioAccompanyStateChanged(AliRtcEngine.AliRtcAudioAccompanyStateCode playState, AliRtcEngine.AliRtcAudioAccompanyErrorCode errorCode);

Il s'agit du rappel pour les changements d'état de lecture de l'accompagnement local. Il vous informe en temps réel de l'état de lecture actuel de l'accompagnement (par exemple, démarrage, pause, fin) et des éventuels codes d'erreur. Vous pouvez utiliser ce rappel pour surveiller la progression de la lecture, gérer les exceptions et mettre à jour l'interface utilisateur.

Paramètres

Paramètre

Type

Description

playState

AliRtcEngine.AliRtcAudioAccompanyStateCode

État de lecture de l'accompagnement.

errorCode

AliRtcEngine.AliRtcAudioAccompanyErrorCode

Code d'erreur de lecture, principalement pour les erreurs d'ouverture et de décodage de fichier.

onRemoteAudioAccompanyStarted

Rappel indiquant le début de la lecture de l'accompagnement d'un utilisateur distant.

public void onRemoteAudioAccompanyStarted(String uid);

Il s'agit du rappel indiquant le début de la lecture de l'accompagnement audio d'un utilisateur distant (par exemple, musique de fond). Il en informe l'application locale. Vous pouvez utiliser ce rappel pour exécuter une logique d'initialisation (par exemple, mettre à jour l'interface utilisateur, ajuster le volume ou notifier d'autres utilisateurs).

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant dont l'accompagnement a commencé à être lu.

onRemoteAudioAccompanyFinished

Rappel indiquant la fin de la lecture de l'accompagnement d'un utilisateur distant.

public void onRemoteAudioAccompanyFinished(String uid);

Ce rappel est déclenché lorsque la lecture de l'accompagnement audio d'un utilisateur distant (par exemple, musique de fond ou effets sonores) est terminée. Il en informe l'application locale. Utilisez ce rappel pour exécuter la logique suivante (comme notifier les utilisateurs ou mettre à jour le statut).

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant dont l'accompagnement a terminé sa lecture.

onVideoResolutionChanged

Modification de la résolution vidéo distante.

public void onVideoResolutionChanged(String uid,AliRtcVideoTrack videoTrack, int width, int height);

Ce rappel de notification signale les modifications de la résolution vidéo distante. Il se déclenche lorsque la résolution du flux vidéo d'un utilisateur distant change (par exemple, lors du changement de caméra, de l'ajustement de la définition ou d'une baisse de résolution due à des fluctuations réseau). Utilisez ce rappel pour ajuster dynamiquement la logique de rendu vidéo local (comme la disposition de l'interface utilisateur, la mise à l'échelle du canevas ou l'optimisation des performances).

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant dont la résolution a changé.

videoTrack

Type de flux vidéo, tel que le flux de la caméra ou le flux d'écran.

width

int

Nouvelle largeur de la résolution vidéo.

height

int

Nouvelle hauteur de la résolution vidéo.

onRtcLocalVideoStats

Statistiques de données pour le flux vidéo local publié.

public void onRtcLocalVideoStats(AliRtcEngine.AliRtcLocalVideoStats aliRtcStats);

Ce rappel fournit les statistiques de données du flux vidéo local. Il permet d'obtenir le statut d'encodage et de transmission en temps réel de la vidéo locale (tel que le débit binaire et la fréquence d'images). Utilisez ce rappel pour surveiller la qualité vidéo, diagnostiquer les problèmes de performance ou ajuster dynamiquement les paramètres d'encodage.

Paramètres

Paramètre

Type

Description

aliRtcStats

AliRtcEngine.AliRtcLocalVideoStats

Statistiques de la vidéo publiée localement, incluant le débit binaire de publication, la fréquence d'images et d'autres informations. Pour plus de détails, consultez AliRtcLocalVideoStats.

onRtcRemoteVideoStats

Statistiques de données pour le flux vidéo distant abonné.

public void onRtcRemoteVideoStats(AliRtcEngine.AliRtcRemoteVideoStats aliRtcStats);

Ce rappel fournit les statistiques de données du flux vidéo distant récupéré. Il permet d'obtenir le statut d'encodage et de transmission en temps réel de la vidéo distante (tel que le débit binaire, la fréquence d'images, la résolution, la latence et les saccades). Utilisez ce rappel pour surveiller la qualité vidéo, diagnostiquer les problèmes de performance ou ajuster dynamiquement les paramètres de décodage.

Paramètres

Paramètre

Type

Description

aliRtcStats

AliRtcEngine.AliRtcRemoteVideoStats

Statistiques de la vidéo distante récupérée, incluant l'ID de l'utilisateur distant, la résolution vidéo, la fréquence d'images, le nombre de saccades et d'autres informations. Pour plus de détails, consultez AliRtcRemoteVideoStats.

onRtcRemoteAudioStats

Statistiques de données pour le flux audio distant abonné.

public void onRtcRemoteAudioStats(AliRtcEngine.AliRtcRemoteAudioStats aliRtcStats);

Ce rappel fournit les statistiques de données du flux audio distant abonné. Il permet d'obtenir le statut de la qualité audio en temps réel des utilisateurs distants (tel que la qualité audio, le taux de perte de paquets et la latence). Utilisez ce rappel pour surveiller la stabilité du lien audio distant, diagnostiquer les problèmes réseau et ajuster dynamiquement les politiques de lecture (comme l'activation de la réduction du bruit ou l'invitation des utilisateurs à optimiser leur réseau).

Paramètres

Paramètre

Type

Description

aliRtcStats

AliRtcEngine.AliRtcRemoteAudioStats

Statistiques de l'audio distant récupéré, incluant l'ID de l'utilisateur distant, la qualité audio, le taux de perte de paquets, le nombre de saccades, la latence et d'autres informations. Pour plus de détails, consultez AliRtcRemoteAudioStats.

onRtcLocalAudioStats

Statistiques de données pour le flux audio local publié.

public void onRtcLocalAudioStats(AliRtcEngine.AliRtcLocalAudioStats aliRtcStats);

Ce rappel fournit les statistiques de données de publication audio locale. Il permet d'obtenir le statut d'encodage et de transmission en temps réel de l'audio local (tel que le débit binaire, la fréquence d'échantillonnage, le nombre de canaux et le taux de perte de paquets). Utilisez ce rappel pour surveiller la stabilité du lien audio local, diagnostiquer les problèmes de performance et ajuster dynamiquement les politiques d'encodage (comme la réduction du débit binaire).

Paramètres

Paramètre

Type

Description

aliRtcStats

AliRtcEngine.AliRtcLocalAudioStats

Statistiques de l'audio publié localement, incluant le type de flux audio, le débit binaire d'envoi, la fréquence d'échantillonnage d'envoi et le nombre de canaux. Pour plus de détails, consultez AliRtcLocalAudioStats.

onAudioFocusChange

Rappel pour les changements de focus audio (Android uniquement).

public void onAudioFocusChange(int focusChange);

Notification des résultats de changement de focus audio. Par défaut, le SDK demande automatiquement le focus audio. Si le focus audio est utilisé à nouveau par une autre application, vous devez le redemander dans le rappel reçu du SDK.

Moment de la notification

Déclenché lorsque le statut du périphérique de sortie audio change (par exemple, branchement/débranchement d'écouteurs, changement de périphérique Bluetooth ou basculement entre écouteur/haut-parleur).

Paramètres

Paramètre

Type

Description

focusChange

int

Type de statut de focus. La valeur correspond à la définition du type de focus dans android.media.AudioManager.

onAudioRouteChanged

Rappel pour les changements de route audio (Android et iOS uniquement).

public void onAudioRouteChanged(AliRtcEngine.AliRtcAudioRouteType routing);

Ce rappel de notification signale les changements de route audio. Il permet de détecter les modifications du chemin de sortie audio du périphérique (comme l'insertion d'écouteurs ou le changement de haut-parleur). Ce rappel est disponible uniquement pour Android et iOS. Utilisez-le pour ajuster dynamiquement les politiques de sortie audio (comme le changement de mode microphone ou l'ajustement du volume).

Paramètres

Paramètre

Type

Description

routing

AliRtcEngine.AliRtcAudioRouteType

Route audio actuellement utilisée.

onRemoteUserSubscribedDataChannel

Rappel indiquant que vous pouvez commencer à envoyer des messages via le canal de données.

public void onRemoteUserSubscribedDataChannel(String uid);

Ce rappel est déclenché lorsqu'un utilisateur distant s'abonne au canal de données. Il informe l'utilisateur local que l'utilisateur distant spécifié est prêt à recevoir des messages personnalisés. Vous pouvez alors appeler sendDataChannelMsg pour leur envoyer des données en toute sécurité. Ce mécanisme garantit une livraison fiable des messages et évite la perte ou l'échec des envois vers un utilisateur qui n'est pas encore abonné au canal de données.

Remarque

Ce rappel est déclenché uniquement dans les scénarios d'IA conversationnelle en temps réel.

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant.

onDataChannelMessage

Rappel pour la réception d'un message personnalisé via le canal de données.

public void onDataChannelMessage(String uid, AliRtcEngine.AliRtcDataChannelMsg msg);

Le SDK ARTC permet d'envoyer et de recevoir des messages personnalisés, ce qui vous offre la possibilité de transmettre des données de message en temps réel tout en diffusant des données audio et vidéo. Ce rappel sert à recevoir des messages personnalisés depuis le canal de données. Pour plus de détails, consultez Envoyer et recevoir des messages personnalisés.

Remarque

Dans les scénarios interactifs, les streamers peuvent envoyer et recevoir des messages, tandis que les spectateurs peuvent uniquement recevoir des messages.
Cette fonctionnalité est désactivée par défaut. Pour l'activer, appelez setParameter avec {\"data\":{\"enablePubDataChannel\":true" + ",\"enableSubDataChannel\":true}} après avoir créé le moteur.

Condition de déclenchement

Après que l'expéditeur a appelé sendDataChannelMsg pour envoyer un message personnalisé, ce rappel est déclenché côté récepteur si la fonctionnalité de canal de données est activée.

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur expéditeur.

msg

AliRtcEngine.AliRtcDataChannelMsg

Message personnalisé reçu.

onAudioVolume

Volume audio, statut vocal et UID des utilisateurs abonnés.

public void onAudioVolume(List<AliRtcEngine.AliRtcAudioVolume> speakers, int totalVolume);

Ce rappel est désactivé par défaut. Vous pouvez l'activer en appelant l'API <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#dbc70a301dtjz" id="d1cae8ec5dc2w">enableAudioVolumeIndication</a>. Une fois activé, le SDK le déclenche à l'intervalle défini dans <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#dbc70a301dtjz" id="e5e0d330423ax">enableAudioVolumeIndication</a> après votre connexion à un canal contenant des utilisateurs diffusant des flux, fournissant ainsi les informations de volume des interlocuteurs locaux et distants.

Paramètres

Paramètre

Type

Description

speakers

List<AliRtcEngine.AliRtcAudioVolume>

Un tableau d'informations sur le volume des utilisateurs, incluant l'uid de l'utilisateur, le statut vocal et le volume.

Lorsque uid est 0, cela indique l'interlocuteur local.
Lorsque uid est 1, cela indique le volume mixé de tous les utilisateurs distants.
Les autres valeurs indiquent les informations de volume de l'uid de l'utilisateur distant spécifié.

totalVolume

int

Le volume total après mixage. La plage est [0, 255].

Dans le rappel de l'utilisateur local, totalVolume correspond au volume après mixage pour l'utilisateur local. Dans le rappel de l'utilisateur distant, totalVolume correspond au volume total après mixage pour tous les interlocuteurs.

onActiveSpeaker

Rappel pour l'interlocuteur actuel.

public void OnActiveSpeaker(String uid);

Après un appel réussi à <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#dbc70a301dtjz" id="699faf2d18k2x">enableAudioVolumeIndication</a>, le SDK surveille en continu l'utilisateur distant ayant le volume le plus élevé et compte le nombre de fois où cet utilisateur est identifié comme l'interlocuteur le plus fort. Sur la période actuelle, l'utilisateur distant ayant le cumul le plus élevé est considéré comme l'utilisateur le plus actif.

Condition de déclenchement

Lorsque le nombre d'utilisateurs dans le canal est supérieur ou égal à 2 et qu'il y a un utilisateur distant actif, le SDK déclenche ce rappel et rapporte l'uid de l'utilisateur distant le plus actif.

Si l'utilisateur distant le plus actif reste le même, le SDK ne déclenchera pas à nouveau le rappel onActiveSpeaker.
Si l'utilisateur distant le plus actif change, le SDK déclenche à nouveau ce rappel et rapporte l'uid du nouvel utilisateur distant le plus actif.

Paramètres

Paramètre

Type

Description

uid

String

Uid de l'interlocuteur. Lorsque uid est 0, cela indique l'interlocuteur local. Cette méthode renvoie l'ID de l'utilisateur ayant le son le plus fort sur la période actuelle, et non l'utilisateur ayant le son instantané le plus fort.

OnTestAudioVolume

Test pré-appel. Rappel pour les informations de volume.

public void OnTestAudioVolume(int volume);

Ce rappel fournit les informations de volume du périphérique de capture audio local lors d'un test pré-appel, ce qui vous permet de vérifier que le périphérique fonctionne correctement. Il est déclenché lorsque vous appelez startAudioCaptureTest pour effectuer un test du périphérique audio avant l'appel.

Paramètres

Paramètre

Type

Description

volume

int

Valeur du volume.

onCapturedAudioFrame

Rappel pour les données audio brutes capturées.

boolean onCapturedAudioFrame(AliRtcAudioFrame frame);

Ce rappel permet d'obtenir les données audio brutes collectées par le périphérique actuel. Il est désactivé par défaut. Pour obtenir ces données audio :

Activez ce rappel en utilisant le paramètre audioSource dans enableAudioFrameObserver(true,audioSource,config). Le paramètre config permet également de définir la fréquence d'échantillonnage, le nombre de canaux audio et le mode de lecture/écriture pour les données audio.
Appelez registerAudioFrameObserver pour enregistrer l'objet de réception des données audio.

Remarque

Cette interface prend en charge la configuration de la fréquence d'échantillonnage, du nombre de canaux et du mode de lecture/écriture.

Limites

N'effectuez aucune opération longue dans cette fonction de rappel. Sinon, des anomalies sonores peuvent survenir.

Paramètres

Paramètre

Type

Description

frame

Données audio.

Valeur de retour

true : Succès.
false : Échec.

onProcessCapturedAudioFrame

Rappel pour les données audio après traitement 3A.

boolean onProcessCapturedAudioFrame(AliRtcAudioFrame frame);

Ce rappel permet d'obtenir les données audio après traitement 3A. Il est désactivé par défaut. Pour obtenir ces données audio :

Activez ce rappel via audioSource dans enableAudioFrameObserver(true,audioSource,config). Le paramètre config permet également de définir la fréquence d'échantillonnage, le nombre de canaux audio et le mode de lecture/écriture pour les données audio.
Appelez registerAudioFrameObserver pour enregistrer l'objet de réception des données audio.

Remarque

Cette interface prend en charge la configuration de la fréquence d'échantillonnage, du nombre de canaux et du mode de lecture/écriture.

Limites

N'effectuez aucune opération longue dans cette fonction de rappel. Sinon, des anomalies sonores peuvent survenir.

Paramètres

Paramètre

Type

Description

frame

Données audio.

Valeur de retour

true : Succès.
false : Échec.

onPublishAudioFrame

Rappel pour les données audio d'ingestion.

boolean onPublishAudioFrame(AliRtcAudioFrame frame);

Ce rappel permet de récupérer les données audio publiées. Il est désactivé par défaut. Pour obtenir ces données audio :

Activez ce rappel à l'aide du paramètre audioSource dans enableAudioFrameObserver(true,audioSource,config). Le paramètre config vous permet également de définir la fréquence d'échantillonnage, le nombre de canaux audio et le mode de lecture/écriture des données audio récupérées.
Appelez registerAudioFrameObserver pour enregistrer l'objet de réception des données audio.

Remarque

Cette interface prend en charge la configuration de la fréquence d'échantillonnage et du nombre de canaux, mais elle ne peut être définie qu'en mode lecture seule.

Limites

N'effectuez aucune opération longue dans cette fonction de rappel. Cela pourrait entraîner des anomalies sonores.

Paramètres

Paramètre

Type

Description

frame

Données audio.

Valeur de retour

true : Succès.
false : Échec.

onPlaybackAudioFrame

Rappel pour les données de lecture.

boolean onPlaybackAudioFrame(AliRtcAudioFrame frame);

Ce rappel permet de récupérer les données audio de lecture. Il est désactivé par défaut. Pour obtenir ces données audio :

Activez ce rappel via le paramètre audioSource dans enableAudioFrameObserver(true,audioSource,config). Le paramètre config permet également de définir la fréquence d'échantillonnage, le nombre de canaux audio et le mode de lecture/écriture des données audio.
Appelez registerAudioFrameObserver pour enregistrer l'objet de réception des données audio.

Remarque

Cette interface prend en charge la configuration de la fréquence d'échantillonnage, du nombre de canaux et du mode de lecture/écriture.

Limites

N'effectuez aucune opération longue dans cette fonction de rappel. Cela pourrait entraîner des anomalies sonores.

Paramètres

Paramètre

Type

Description

frame

AliRtcAudioFrame

Données audio.

Valeur de retour

true : Succès.
false : Échec.

onRemoteUserAudioFrame

Rappel pour les données de tirage de flux distant.

boolean onRemoteUserAudioFrame(String uid, AliRtcAudioFrame frame);

Ce rappel permet de récupérer les données audio distantes tirées d'un utilisateur spécifique. Il est désactivé par défaut. Pour obtenir ces données audio :

Activez ce rappel via le paramètre audioSource dans enableAudioFrameObserver(true,audioSource,config). Le paramètre config permet également de définir la fréquence d'échantillonnage, le nombre de canaux et le mode de lecture/écriture des données audio.
Appelez registerAudioFrameObserver pour enregistrer l'objet de réception des données audio.

Remarque

Cette interface ne prend pas en charge la configuration de la fréquence d'échantillonnage ou du nombre de canaux, mais vous pouvez définir le mode de lecture/écriture.

Limites

N'effectuez aucune opération longue dans cette fonction de rappel. Cela pourrait entraîner des anomalies sonores.

Paramètres

Paramètre

Type

Description

uid

String

ID utilisateur.

frame

Données audio.

Valeur de retour

true : Succès.
false : Échec.

OnDestroyCompletion

Rappel indiquant la fin de la destruction du moteur.

void OnDestroyCompletion();

Ce rappel indique que l'instance du moteur SDK a été détruite et qu'une nouvelle instance peut être créée.

Déclenchement

Lorsque vous appelez destroy[2/2], ce rappel est déclenché après la destruction du moteur.

onTextureCreate

Rappel pour la création du contexte OpenGL.

void onTextureCreate(long context);

Remarque

Ce rappel est déclenché lors de la création du contexte OpenGL interne du SDK.

Condition de déclenchement

Ce rappel est déclenché lors de la création du contexte OpenGL interne du SDK. Vous pouvez initialiser les ressources associées.

Paramètres

Paramètre

Type

Description

context

long

Contexte OpenGL.

onTextureUpdate

Rappel pour les mises à jour des textures OpenGL.

int onTextureUpdate(int textureId, int width, int height, AliRtcVideoSample videoSample);

Condition de déclenchement

Ce rappel est déclenché après le chargement de chaque image vidéo dans la texture OpenGL. Lorsqu'un observateur externe des données de texture OpenGL est enregistré, vous pouvez traiter la texture dans ce rappel et renvoyer l'ID de la texture traitée.

Paramètres

Paramètre

Type

Description

textureId

int

Contexte OpenGL.

width

int

Largeur de la vidéo.

height

int

Hauteur de la vidéo.

videoSample

Données de l'image vidéo.

Valeur de retour

Renvoie un nouvel ID de texture ou l'ancien ID de texture. Si une valeur inférieure à 0 est renvoyée, l'ID de texture est considéré comme non mis à jour.

onTextureDestroy

void onTextureDestroy();

Condition de déclenchement

Ce rappel est déclenché lors de la destruction du contexte OpenGL interne du SDK. Vous pouvez nettoyer les ressources associées.

onLocalVideoSample

Rappel pour les données vidéo locales capturées et souscrites.

public boolean onLocalVideoSample(AliRtcVideoSourceType sourceType, AliRtcVideoSample videoSample);

Ce rappel permet de récupérer les données de capture vidéo locale. Il sert à obtenir les images vidéo brutes (telles que les données YUV) collectées par la caméra locale. Vous pouvez utiliser ce rappel pour implémenter une logique de traitement vidéo personnalisée (comme l'ajout de filtres, de filigranes ou la transcodage) et décider si les données traitées doivent être renvoyées au SDK pour l'encodage ou le rendu ultérieur. Pour envoyer la vidéo traitée au SDK, renvoyez true.

Déclenchement

Après avoir appelé avec succès <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#927fcde6fenlk" id="22a5a6bd53c77">registerVideoSampleObserver</a> pour enregistrer un observateur de données vidéo, un rappel est déclenché lorsque le SDK capture l'image vidéo correspondante.

Paramètres

Paramètre

Type

Description

sourceType

AliRtcVideoSourceType

Type de source vidéo.

videoSample

Données vidéo.

Valeur de retour

true : Doit être réécrit dans le SDK (la réécriture est activée par défaut ; elle est obligatoire lors de la manipulation de AliRtcVideoSample.data).
false : Ne doit pas être réécrit dans le SDK (utilisé lors de la manipulation directe de AliRtcVideoSample.dataFrameY, AliRtcVideoSample.dataFrameU et AliRtcVideoSample.dataFrameV).

onPreEncodeVideoSample

Rappel pour les données vidéo locales pré-encodées souscrites.

public boolean onPreEncodeVideoSample(AliRtcVideoSourceType sourceType, AliRtcVideoSample videoRawData);

Ce rappel permet de récupérer les données vidéo locales avant encodage. Il sert à obtenir les données vidéo brutes (au format YUV, par exemple) avant que le SDK n'encode l'image vidéo. Vous pouvez utiliser ce rappel pour implémenter une logique de traitement personnalisée (comme l'ajout de filigranes, l'ajustement des couleurs ou la transcodage) et décider si les données traitées doivent être renvoyées au SDK pour l'encodage ultérieur.

Paramètres

Paramètre

Type

Description

sourceType

AliRtcVideoSourceType

Type de flux vidéo.

videoRawData

Données vidéo brutes.

Valeur de retour

true : Doit être réécrit dans le SDK (la réécriture est activée par défaut ; elle est obligatoire lors de la manipulation de AliRtcVideoSample.data).
false : Ne doit pas être réécrit dans le SDK (utilisé lors de la manipulation directe de AliRtcVideoSample.dataFrameY, AliRtcVideoSample.dataFrameU et AliRtcVideoSample.dataFrameV).

onRemoteVideoSample

Rappel pour les données vidéo distantes souscrites.

public boolean onRemoteVideoSample(String callId,AliRtcVideoSourceType sourceType, AliRtcVideoSample videoSample);

Ce rappel permet de récupérer les données vidéo distantes souscrites. Il sert à obtenir les données d'image vidéo brutes (au format YUV, par exemple) d'un utilisateur distant. Vous pouvez utiliser ce rappel pour implémenter une logique de traitement personnalisée (comme l'ajout de filtres, de filigranes ou la transcodage) et décider si les données traitées doivent être renvoyées au SDK pour le rendu ultérieur.

Paramètres

Paramètre

Type

Description

callId

String

ID utilisateur.

sourceType

AliRtcVideoSourceType

Type de flux vidéo.

videoSample

AliRtcLiveTranscodingState

Données vidéo brutes.

Valeur de retour

true : Doit être réécrit dans le SDK (la réécriture est activée par défaut ; elle est obligatoire lors de la manipulation de AliRtcVideoSample.data).
false : Ne doit pas être réécrit dans le SDK (utilisé lors de la manipulation directe de AliRtcVideoSample.dataFrameY, AliRtcVideoSample.dataFrameU et AliRtcVideoSample.dataFrameV).

onGetVideoFormatPreference

Format de sortie des données vidéo.

public AliRtcVideoFormat onGetVideoFormatPreference();

Valeur de retour

Le format de sortie vidéo souhaité.

onGetObservedFramePosition

Contenu de sortie des données vidéo.

public int onGetObservedFramePosition();

Ce rappel permet de récupérer le contenu ou le type de sortie des données vidéo. Vous pouvez l'utiliser pour connaître l'étape de traitement de l'image vidéo de sortie du SDK (par exemple, après la collecte, avant l'encodage ou après le tirage).

Valeur de retour

Le contenu de sortie vidéo souhaité. Le type est une valeur d'énumération de AliRtcVideoObserPosition, représentant les données collectées, les données tirées ou les données pré-encodées.

onPublishLiveStreamStateChanged

Rappel pour les changements d'état de publication du flux de contournement.

public void onPublishLiveStreamStateChanged(String streamUrl, AliRtcLiveTranscodingState state, AliEngineLiveTranscodingErrorCode errorCode);

Paramètres

Paramètre

Type

Description

streamUrl

String

URL d'ingestion.

state

État de la diffusion en direct de contournement.

errorCode

AliEngineLiveTranscodingErrorCode

Code d'erreur.

onPublishTaskStateChanged

Rappel pour les changements d'état de la tâche de contournement.

public void onPublishTaskStateChanged(String streamUrl, AliRtcTrascodingPublishTaskStatus state);

Paramètres

Paramètre

Type

Description

streamUrl

String

URL d'ingestion.

state

AliRtcTrascodingPublishTaskStatus

État de la tâche de publication de diffusion en direct de contournement.

onNetworkQualityChanged

Rappel pour les changements de qualité du réseau.

public void onNetworkQualityChanged(String uid, AliRtcNetworkQuality upQuality, AliRtcNetworkQuality downQuality);

Paramètres

Paramètre

Type

Description

uid

String

ID utilisateur. Lorsqu'il est vide, il indique l'état du réseau montant et descendant de l'utilisateur local.

upQuality

AliRtcNetworkQuality

État du réseau montant.

downQuality

AliRtcNetworkQuality

État du réseau descendant.

onNetworkQualityProbeTest

Rappel pour une sonde de qualité réseau. Ce rappel est fourni environ 3 secondes après le début de la sonde.

public void onNetworkQualityProbeTest(AliRtcNetworkQuality quality){}

Paramètres

Paramètre

Type

Description

quality

AliRtcNetworkQuality

Qualité du réseau.

onNetworkQualityProbeTestResult

Rappel pour le résultat d'une sonde de qualité réseau. Ce rappel est fourni environ 30 secondes après le début de la sonde.

public void onNetworkQualityProbeTestResult(int code, AliRtcEngine.AlirtcNetworkQualityProbeResult result){}

Paramètres

Paramètre

Type

Description

code

int

Valeur de retour. 0 indique que la sonde a réussi. -1 indique que la sonde a échoué et que la connexion a été perdue en raison de mauvaises conditions réseau.

result

AlirtcNetworkQualityProbeResult

Qualité du réseau.

onSnapshotComplete

Interface de rappel pour les résultats de capture d'écran.

public void onSnapshotComplete(String userId, AliRtcVideoTrack trackType, Bitmap bitmap, boolean success)

Cette interface vous informe du résultat et des détails de la capture d'écran.

Paramètres

Paramètre

Type

Description

userId

String

ID utilisateur. Si userId est null ou « », cela signifie qu'il s'agit d'une capture d'écran de l'utilisateur local.

trackType

AliRtcAudioVolumeObserver

Type de flux vidéo de la capture d'écran.

bitmap

Bitmap

Données de la capture d'écran.

success

boolean

Indique si la capture d'écran a réussi.

onScreenSharePublishStateChanged

Rappel pour les changements d'état de publication du partage d'écran.

public void onScreenSharePublishStateChanged(AliRtcEngine.AliRtcPublishState oldState , AliRtcEngine.AliRtcPublishState newState, int elapseSinceLastState, String channel)

Ce rappel notifie les changements d'état de publication du partage d'écran. Il est déclenché lorsque l'état de publication du partage d'écran change.

Paramètres

Paramètre

Type

Description

oldState

AliRtcEngine.AliRtcPublishState

Ancien état avant le changement d'état de publication.

newState

AliRtcEngine.AliRtcPublishState

Nouvel état après le changement d'état de publication.

elapseSinceLastState

int

Intervalle de temps écoulé depuis le dernier changement d'état (en millisecondes).

channel

String

Nom du canal actuel.

onScreenShareSubscribeStateChanged

Rappel pour les changements d'état d'abonnement au flux de partage d'écran.

public void onScreenShareSubscribeStateChanged(String uid,
                                                    AliRtcEngine.AliRtcSubscribeState oldState,
                                                    AliRtcEngine.AliRtcSubscribeState newState,
                                                    int elapseSinceLastState, String channel);

Ce rappel notifie les changements d'état d'abonnement au flux de partage d'écran. Il est déclenché lorsque le statut d'abonnement de l'utilisateur actuel au flux de partage d'écran d'un utilisateur distant change.

Paramètres

Paramètre

Type

Description

uid

String

ID de l'utilisateur distant.

oldState

AliRtcEngine.AliRtcSubscribeState

Statut d'abonnement précédent.

newState

AliRtcEngine.AliRtcSubscribeState

Statut d'abonnement actuel.

elapseSinceLastState

int

Intervalle de temps écoulé depuis le dernier changement d'état (en millisecondes).

channel

String

Canal actuel.

onOccurError

Notification d'erreur.

public void onOccurError(int error, String message);

Il s'agit du rappel global de notification d'erreur pour le SDK ARTC. Il avertit la couche application lorsqu'une erreur grave se produit dans le moteur interne du SDK. Utilisez ce rappel pour obtenir le code d'erreur et le message d'erreur afin de gérer les exceptions, journaliser les événements ou afficher des invites à l'utilisateur.

Paramètres

Paramètre

Type

Description

error

int

Type d'erreur. Consultez la liste des codes d'erreur.

message

String

Message d'erreur.

OnLocalAudioStateChanged

Rappel pour l'état du dispositif audio local.

public void OnLocalAudioStateChanged(int state);

Ce rappel est déclenché lorsque l'état du dispositif de capture audio local change. Par exemple, lorsque vous appelez startAudioCapture pour démarrer la capture audio ou stopAudioCapture pour l'arrêter.

Paramètres

Paramètre	Type	Description
state	int	0 : Non créé. 1 : En cours de capture. 2 : Fermeture de la capture. 3 : Capture fermée.

setParameter

Définit des paramètres personnalisés.

public abstract int setParameter(String param);

Paramètres

Paramètre

Type

Description

param

String

Paramètres personnalisés.

getParameter

Récupère des paramètres personnalisés.

public abstract String getParameter(String param);

Paramètres

Paramètre

Type

Description

param

String

Paramètres personnalisés.

registerAudioVolumeObserver

Enregistre un objet de sortie des données de volume.

public abstract void registerAudioVolumeObserver(AliRtcAudioVolumeObserver observer);

Cette interface enregistre un objet utilisé pour exporter les données de volume. Pour annuler l'enregistrement, appelez unRegisterAudioVolumeObserver.

Quand appeler

Lorsque vous devez obtenir des informations sur le volume, appelez <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#dbc70a301dtjz" id="85a734d2596vf">enableAudioVolumeIndication</a> pour définir la fréquence de rappel et le coefficient de lissage, puis appelez cette méthode pour enregistrer l'objet qui reçoit les données pertinentes.
Si vous appelez <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#ae07dc986abf3" id="29e92857a5iv8">startAudioCaptureTest</a> pour tester votre dispositif audio avant de rejoindre une réunion, vous pouvez appeler cette API et implémenter le rappel <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e375c31bdez6j" id="e5cb797b7cg5p">OnTestAudioVolume</a>.

Paramètres

Paramètre

Type

Description

observer

Objet de réception des données de volume.

unRegisterAudioVolumeObserver

Annule l'enregistrement d'un objet de sortie des données de volume.

public abstract void unRegisterAudioVolumeObserver();

Cette méthode correspond à registerAudioVolumeObserver et sert à annuler l'enregistrement de l'objet de sortie des données de volume audio.

Quand appeler

Si vous avez enregistré un objet pour recevoir les données audio en appelant registerAudioVolumeObserver, appelez cette méthode pour annuler l'enregistrement de l'objet.

enableAudioFrameObserver

Définit les paramètres de rappel audio.

public abstract int  enableAudioFrameObserver(boolean enable, AliRtcAudioSource audioSource, AliRtcAudioFrameObserverConfig config);

Cette méthode active ou désactive le rappel des données audio pour un type spécifié, ce qui vous permet d'obtenir diverses données audio brutes et encodées. Elle est désactivée par défaut. Pour l'activer, appelez cette méthode.

Remarque

Lorsque vous appelez cette API pour activer le rappel des données audio pour la source AliRtcAudioSource correspondante, vous devez utiliser la méthode registerAudioFrameObserver pour transmettre un objet chargé de recevoir les données audio.

Quand appeler

Appelez cette méthode pour l'activer lorsque vous devez obtenir des données audio.

Paramètres

Paramètre	Type	Description
enable	boolean	Indique s'il faut autoriser les rappels de données audio.
audioSource	AliRtcAudioSource	Type de source de données de rappel, y compris après la capture (0), après le traitement 3A (1), la publication (2), la lecture (3), le mixage après publication et lecture (4) et les données audio extraites (5). Remarque Les données audio ingérées et les données audio mixées issues de l'ingestion et de la lecture ne prennent en charge que le mode lecture seule (ReadOnly). Les données audio extraites ne permettent pas de modifier les paramètres audio tels que la fréquence d'échantillonnage et le nombre de canaux.
config	AliRtcAudioFrameObserverConfig	Paramètres de rappel audio, y compris la fréquence d'échantillonnage, le nombre de canaux et le mode de lecture/écriture du rappel (lecture seule, écriture seule, lecture-écriture). Si le paramètre est null, la valeur par défaut est (48000, 1, ReadOnly).

Valeur de retour

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

registerAudioFrameObserver

Enregistre un rappel de données audio.

public abstract void registerAudioFrameObserver(AliRtcAudioFrameObserver observer);

Cette méthode enregistre l'objet récepteur des données de rappel audio.

Quand appeler

Lorsque vous avez besoin que le SDK déclenche les rappels onCapturedAudioFrame, onProcessCapturedAudioFrame, onPublishAudioFrame, onPlaybackAudioFrame ou onRemoteUserAudioFrame pour obtenir divers types de données audio, vous devez appeler cette méthode pour fournir un objet de réception des données audio. Pour annuler l'enregistrement, rappelez cette méthode en transmettant la valeur null.

Limites

Vous devez appeler enableAudioFrameObserver pour activer le rappel pour la source AliRtcAudioSource spécifique. Sinon, l'observateur transmis ne pourra pas obtenir de données.

Paramètres

Paramètre

Type

Description

observer

AliRtcAudioFrameObserver

Instance d'objet de réception du rappel de données audio. La transmission de la valeur null signifie l'annulation de l'enregistrement.

registerVideoSampleObserver

Enregistre un objet de sortie des données vidéo.

public abstract void registerVideoSampleObserver(AliVideoObserver observer);

Utilisez cette API pour enregistrer l'objet de sortie des données vidéo. Pour annuler l'enregistrement, appelez l'API unRegisterVideoSampleObserver.

Quand appeler

Pour obtenir des données audio brutes (au format YUV ou RGBA, par exemple), vous pouvez appeler cette méthode pour enregistrer un observateur de données vidéo afin d'obtenir des données vidéo à différentes étapes. AliRtcVideoObserver est la classe d'observateur de données vidéo.

Rappels associés

Après avoir enregistré avec succès un observateur de sortie de données vidéo, le SDK déclenche les rappels que vous avez implémentés dans l'interface AliRtcVideoObserver lors de la capture de chaque image vidéo. Implémentez les rappels correspondants en fonction de vos besoins métier :

onLocalVideoSample : Rappel des données de capture vidéo locale.
onRemoteVideoSample : Rappel des données vidéo distantes.
onPreEncodeVideoSample : Rappel des données vidéo locales avant encodage.

Paramètres

Paramètre

Type

Description

observer

AliRtcVideoObserver

Objet de sortie des données vidéo.

Valeur de retour

Les données de sortie sont renvoyées via le rappel AliVideoObserver.

unRegisterVideoSampleObserver

Annule l'enregistrement d'un objet de sortie des données vidéo.

public abstract void unRegisterVideoSampleObserver();

Cette API correspond à l'API <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#927fcde6fenlk" id="dcf635790da7v">registerVideoSampleObserver</a> et annule l'enregistrement de l'objet de sortie des données vidéo.

registerLocalVideoTextureObserver

Enregistre un observateur de données de texture OpenGL pour le flux vidéo de la caméra locale.

public abstract void registerLocalVideoTextureObserver(AliTextureObserver observer);

Si vous souhaitez obtenir des données vidéo brutes, appelez l'interface <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#927fcde6fenlk" id="4f1f5a423ch4j">registerVideoSampleObserver</a> pour enregistrer le rappel correspondant. Si vous souhaitez obtenir des données de texture internes, appelez cette interface. Pour annuler l'enregistrement, appelez l'interface unRegisterLocalVideoTextureObserver.

Remarque

Cette méthode n'est valable que pour le flux vidéo de la caméra locale.

Rappels associés

Après avoir enregistré avec succès un observateur de données de texture OpenGL pour le flux vidéo de la caméra locale, le SDK déclenche les rappels que vous avez implémentés dans l'interface AliRtcTextureObserver lors de la capture de chaque image vidéo. Implémentez les rappels correspondants en fonction de vos besoins métier :

onTextureCreate : Ce rappel est déclenché lors de la création du contexte OpenGL interne du SDK.
onTextureUpdate : Ce rappel est déclenché après le chargement de chaque image vidéo dans la texture OpenGL. Lorsqu'un observateur externe de données de texture OpenGL est enregistré, vous pouvez traiter la texture dans ce rappel et renvoyer l'ID de texture traité. Notez que la valeur de retour de ce rappel doit être un ID de texture valide. Si vous n'effectuez aucun traitement, vous devez renvoyer le paramètre textureId.
onTextureDestroy : Ce rappel est déclenché lors de la destruction du contexte OpenGL interne du SDK.

Paramètres

Paramètre

Type

Description

observer

AliRtcTextureObserver

Observateur de données de texture OpenGL.

Valeur de retour

Les données de sortie sont renvoyées via le rappel AliVideoObserver.

unRegisterLocalVideoTextureObserver

Annule l'enregistrement de l'observateur de données de texture OpenGL pour le flux vidéo de la caméra locale.

public abstract void unRegisterLocalVideoTextureObserver();

Cette méthode correspond à registerLocalVideoTextureObserver et annule l'enregistrement de l'observateur.

snapshotVideo

Fonctionnalité de capture d'écran vidéo.

public abstract int snapshotVideo(String userId, AliRtcVideoTrack trackType);

Appelez cette méthode pour capturer une image d'un flux vidéo spécifique d'un utilisateur donné.

Limites

Il s'agit d'une opération asynchrone. Lorsque la méthode renvoie 0, cela signifie que l'appel a réussi, mais que le SDK n'a pas encore effectué la capture.

Rappels associés

Après avoir appelé cette méthode avec succès, écoutez le rappel onSnapshotComplete pour obtenir le résultat et les détails de la capture d'écran.

Paramètres

Paramètre

Type

Description

userId

String

ID utilisateur. Si userId est null ou "", cela signifie qu'une capture de l'utilisateur local est effectuée.

trackType