PartyLocalDevice::CreateChatControl

[アーティクル]
01/22/2024

非同期操作をキューに登録して、指定したユーザーのローカルチャットコントロールを作成します。

構文

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

パラメーター

localUserPartyLocalUser*

新しいローカルチャットコントロールのローカルユーザー。

languageCodePartyString
オプション

使用するオプション言語。

asyncIdentifier void*
オプション

完了状態の変更をこの呼び出しに関連付けるために使用できる、オプションの、アプリによって定義されたポインターサイズのコンテキスト値。

localChatControlPartyLocalChatControl**
オプションで割り当てられたライブラリの出力

オプションの出力ローカルチャットコントロール。

戻り値

PartyError

c_partyErrorSuccessチャットコントロールを作成するための非同期操作が開始された場合。そうでない場合はエラーコードを返します。このメソッドが失敗した場合、関連する状態の変更は発生しません。人間が読める形式のエラーコードは、PartyManager::GetErrorMessage() を介して取得できます。

解説

このメソッドが成功を返す場合、非同期操作の結果を提供するために、PartyCreateChatControlCompletedStateChange が生成されます。非同期操作が成功すると、PartyChatControlCreatedStateChange が生成されます。操作が失敗すると、PartyChatControlDestroyedStateChange が生成されます。このメソッド自体は、チャットコントロールをリモートデバイスに表示しません。このチャットコントロールをリモートデバイスにアナウンスするには、タイトルで PartyNetwork::ConnectChatControl() を呼び出す必要があります。

正常に返されると、このメソッドは、ローカルデバイスの PartyManager::GetChatControls() または PartyDevice::GetChatControls() によって以前に返されたすべての配列のメモリを無効にします。これは、新しいチャットコントロールを配列に同期的に追加するためです。 PartyManager::StartProcessingStateChanges() でも、これらの配列のメモリを無効化します。返された localChatControl オブジェクトは、PartyChatControlDestroyedStateChange が生成され、オブジェクトを参照するすべての状態変化が PartyManager::FinishProcessingStateChanges() に返されるまで有効になります。

このチャットコントロールに関連付けられている言語は、必要に応じて languageCode パラメーターを使用して指定できます。言語が指定されていない場合、プラットフォームによって決定されるユーザーの既定値が使用されます。言語は、文字起こし用のこのチャットコントロールに関連付けられた話し言葉、および着信翻訳用の対象言語として使用されます。たとえば、指定された言語コードが en-US の場合、このチャットコントロールへの入力音声は英語 (米国) 言語として扱われ、そのように転記されます。 PartyLocalChatControl::SetTranscriptionOptions() または PartyLocalChatControl::SetTextChatOptions() のいずれかを介して翻訳が有効になっている場合、着信ボイスチャットの文字起こしやテキストチャットは英語 (米国) に翻訳されます。

言語コードは BCP 47 形式である必要があります。サポートされている言語コードは、言語サポートに列挙されています。サポートされていない、または無効な言語コードを指定しても、このメソッドは失敗しませんが、このチャットコントロールに関連付けられた文字起こしの生成に失敗します。このメソッドで使用される言語コードは、PartyLocalChatControl::GetLanguage() を使用してクエリできます。

要件

ヘッダー: Party.h

次の方法で共有

PartyLocalDevice::CreateChatControl

構文

パラメーター

戻り値

解説

要件

関連項目

その他のリソース