PartyLocalDevice::CreateChatControl

Artikel
01/22/2024

Stellt einen asynchronen Vorgang in die Warteschlange, um ein lokales Chat-Steuerelement für den angegebenen Benutzer zu erstellen.

Syntax

PartyError CreateChatControl(  
    const PartyLocalUser* localUser,  
    PartyString languageCode,  
    void* asyncIdentifier,  
    PartyLocalChatControl** localChatControl  
)

Parameter

localUser PartyLocalUser*

Der lokale Benutzer für das neue lokale Chat-Steuerelement.

languageCode PartyString
Optional

Die optionale Sprache, die verwendet werden soll.

asyncIdentifier Leere*
Optional

Ein optionaler, app-definierter Kontextwert in Zeigergröße, der verwendet werden kann, um die Änderung des Abschlusszustands diesem Aufruf zuzuordnen.

localChatControl PartyLocalChatControl**
optional, bibliotheksseitig zugeordnete Ausgabe

Das optionale Lokale Chat-Steuerelement.

Rückgabewert

PartyError

c_partyErrorSuccess , wenn der asynchrone Vorgang zum Erstellen eines Chatsteuerelements gestartet wurde, oder andernfalls ein Fehlercode. Wenn bei dieser Methode ein Fehler auftritt, werden keine zugehörigen Zustandsänderungen generiert. Die lesbare Form des Fehlercodes kann über PartyManager::GetErrorMessage() abgerufen werden.

Hinweise

Wenn diese Methode erfolgreich zurückgibt, wird ein PartyCreateChatControlCompletedStateChange generiert, um das Ergebnis des asynchronen Vorgangs bereitzustellen. Wenn der asynchrone Vorgang erfolgreich ist, wird ein PartyChatControlCreatedStateChange generiert. Wenn der Vorgang fehlschlägt, wird ein PartyChatControlDestroyedStateChange generiert. Diese Methode selbst macht das Chat-Steuerelement nicht für Remotegeräte sichtbar. Um diese Chatsteuerung für Remotegeräte anzukündigen, sollte der Titel PartyNetwork::ConnectChatControl() aufrufen.

Bei erfolgreicher Rückgabe wird mit dieser Methode der Arbeitsspeicher für alle Arrays ungültig, die zuvor von PartyManager::GetChatControls() oder PartyDevice::GetChatControls() für das lokale Gerät zurückgegeben wurden, da das neue Chatsteuerelement synchron zu den Arrays hinzugefügt wird. PartyManager::StartProcessingStateChanges() macht auch den Arbeitsspeicher für diese Arrays ungültig. Das zurückgegebene localChatControl Objekt ist gültig, bis ein PartyChatControlDestroyedStateChange generiert wurde und alle Zustandsänderungen, die auf das Objekt verweisen, an PartyManager::FinishProcessingStateChanges() zurückgegeben wurden.

Die diesem Chat-Steuerelement zugeordnete Sprache kann optional über den languageCode -Parameter angegeben werden. Wenn keine Sprache angegeben wird, wird die Standardeinstellung des Benutzers verwendet, die von der Plattform bestimmt wird. Die Sprache wird als gesprochene Sprache verwendet, die diesem Chatsteuerelement für die Transkription zugeordnet ist, und die Zielsprache für eingehende Übersetzungen. Wenn der angegebene Sprachcode en-US ist, wird die Audioeingabe für dieses Chatsteuerelement für instance als die Sprache Englisch (USA) behandelt und als solche transkribiert. Wenn die Übersetzung entweder über PartyLocalChatControl::SetTranscriptionOptions() oder PartyLocalChatControl::SetTextChatOptions() aktiviert ist, werden die eingehenden Sprachchattranskriptionen und/oder Textchats ins Englische (USA) übersetzt.

Der Sprachcode sollte im BCP 47-Format vorliegen. Unterstützte Sprachcodes werden unter Sprachunterstützung aufgelistet. Die Angabe eines nicht unterstützten oder ungültigen Sprachcodes führt nicht dazu, dass diese Methode fehlschlägt, führt jedoch dazu, dass keine Transkriptionen generiert werden, die diesem Chatsteuerelement zugeordnet sind. Der mit dieser Methode verwendete Sprachcode kann über PartyLocalChatControl::GetLanguage() abgefragt werden.

Voraussetzungen

Header: Party.h

Weitere Informationen

PartyLocalDevice
PartyCreateChatControlCompletedStateChange
PartyChatControlCreatedStateChange
PartyChatControlDestroyedStateChange
PartyManager::GetChatControls
PartyDevice::GetChatControls
PartyNetwork::ConnectChatControl
PartyLocalChatControl::GetLanguage
PartyLocalChatControl::SetTranscriptionOptions
PartyLocalChatControl::SetTranscriptionOptions

Freigeben über