構文
パラメーター
localUser PartyLocalUser*
新しいローカル チャット コントロールのローカル ユーザー。
languageCode PartyStringオプション 使用するオプションの言語。
asyncIdentifier void*オプション 完了状態の変化をこの呼び出しに関連付けるために使用できる、オプションでアプリ定義のポインター サイズのコンテキスト値。
localChatControl PartyLocalChatControl**オプション、ライブラリ割り当ての出力 オプションの出力ローカル チャット コントロール。
戻り値
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関連項目
PartyLocalDevicePartyCreateChatControlCompletedStateChange
PartyChatControlCreatedStateChange
PartyChatControlDestroyedStateChange
PartyManager::GetChatControls
PartyDevice::GetChatControls
PartyNetwork::ConnectChatControl
PartyLocalChatControl::GetLanguage
PartyLocalChatControl::SetTranscriptionOptions
PartyLocalChatControl::SetTranscriptionOptions
