Edit

Share via

PartyLocalChatControl::GetLanguage

  • Article

Gets the language associated with this chat control.

Syntax

PartyError GetLanguage(  
    PartyString* languageCode  
)

Parameters

languageCode   PartyString*
library-allocated output

The output BCP 47 language code used by the chat control future communication. The memory for the string remains valid until the chat control is destroyed.

Return value

PartyError

c_partyErrorSuccess if the call succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via PartyManager::GetErrorMessage().

Remarks

The language is used as the spoken language associated with this chat control for transcription and the target language for incoming translations. If the language code specified is en-US, for instance, the input audio to this chat control will be treated as the English (United States) language and transcribed as such. If translation is enabled via either SetTranscriptionOptions() or SetTextChatOptions(), the incoming voice chat transcriptions and/or text chat will be translated to English (United States).

The language code should be in BCP 47 format; supported language codes are enumerated in Language support. Specifying an unsupported or invalid language code will not cause this method to fail, but will result in failure to generate transcriptions associated with this chat control. The language code can be queried via GetLanguage().

Requirements

Header: Party.h

See also

PartyLocalChatControl
PartyLocalDevice::CreateChatControl
PartyLocalChatControl::SetTranscriptionOptions