Passer au contenu principal
Met en file d’attente une opération asynchrone pour créer un contrôle de clavardage local pour l’utilisateur spécifié.

Syntaxe

Paramètres

localUser   PartyLocalUser* L’utilisateur local du nouveau contrôle de clavardage local. languageCode   PartyString
optional
La langue facultative à utiliser. asyncIdentifier   void*
optional
Une valeur de contexte facultative de la taille d’un pointeur, définie par l’application, qui peut être utilisée pour associer le changement d’état de fin à cet appel. localChatControl   PartyLocalChatControl**
optional, library-allocated output
Le contrôle de clavardage local de sortie facultatif.

Valeur de retour

PartyError c_partyErrorSuccess si l’opération asynchrone de création d’un contrôle de clavardage a commencé; sinon, un code d’erreur. Si cette méthode échoue, aucun changement d’état associé n’est généré. La forme lisible du code d’erreur peut être obtenue au moyen de PartyManager::GetErrorMessage().

Remarques

Si cette méthode retourne une réussite, un PartyCreateChatControlCompletedStateChange est généré pour fournir le résultat de l’opération asynchrone. Si l’opération asynchrone réussit, un PartyChatControlCreatedStateChange est généré. Si l’opération échoue, un PartyChatControlDestroyedStateChange est généré. Cette méthode elle-même ne rend pas le contrôle de clavardage visible pour les appareils distants. Pour annoncer ce contrôle de clavardage aux appareils distants, le titre doit appeler PartyNetwork::ConnectChatControl().

En cas de retour réussi, cette méthode invalide la mémoire de tout tableau précédemment retourné par PartyManager::GetChatControls() ou PartyDevice::GetChatControls() pour l’appareil local, car elle ajoute de façon synchrone le nouveau contrôle de clavardage aux tableaux. PartyManager::StartProcessingStateChanges() invalide également la mémoire de ces tableaux. L’objet localChatControl retourné reste valide jusqu’à ce qu’un PartyChatControlDestroyedStateChange ait été généré et que tous les changements d’état faisant référence à l’objet aient été retournés à PartyManager::FinishProcessingStateChanges().

La langue associée à ce contrôle de clavardage peut éventuellement être spécifiée au moyen du paramètre languageCode. Si aucune langue n’est spécifiée, la langue par défaut de l’utilisateur, déterminée par la plateforme, est utilisée. La langue est utilisée comme langue parlée associée à ce contrôle de clavardage pour la transcription, et comme langue cible pour les traductions entrantes. Si le code de langue spécifié est en-US, par exemple, l’audio d’entrée de ce contrôle de clavardage est traité comme de l’anglais (États-Unis) et transcrit comme tel. Si la traduction est activée au moyen de PartyLocalChatControl::SetTranscriptionOptions() ou PartyLocalChatControl::SetTextChatOptions(), les transcriptions du clavardage vocal et/ou le clavardage textuel entrants sont traduits en anglais (États-Unis).

Le code de langue doit être au format BCP 47; les codes de langue pris en charge sont répertoriés dans Prise en charge des langues. La spécification d’un code de langue non pris en charge ou non valide ne fait pas échouer cette méthode, mais entraîne l’échec de la génération des transcriptions associées à ce contrôle de clavardage. Le code de langue utilisé avec cette méthode peut être interrogé au moyen de PartyLocalChatControl::GetLanguage().

Configuration requise

En-tête : Party.h

Voir aussi

PartyLocalDevice
PartyCreateChatControlCompletedStateChange
PartyChatControlCreatedStateChange
PartyChatControlDestroyedStateChange
PartyManager::GetChatControls
PartyDevice::GetChatControls
PartyNetwork::ConnectChatControl
PartyLocalChatControl::GetLanguage
PartyLocalChatControl::SetTranscriptionOptions
PartyLocalChatControl::SetTranscriptionOptions
Dernière modification le 20 octobre 2026