構文
パラメーター
audioDeviceSelectionType PartyAudioDeviceSelectionType
PartyAudioDeviceSelectionType::None が指定されている場合、音声出力がクリアされます。PartyAudioDeviceSelectionType::SystemDefault が指定されている場合、Party ライブラリはシステムの既定の通信デバイスを使用しようとします。PartyAudioDeviceSelectionType::PlatformUserDefault が指定されている場合、Party ライブラリは audioDeviceSelectionContext に関連付けられた既定の通信デバイスを使用しようとします。PartyAudioDeviceSelectionType::Manual が指定されている場合、Party ライブラリはデバイス識別子が audioDeviceSelectionContext と一致する通信デバイスを使用しようとします。
audioDeviceSelectionContext PartyStringオプション PartyAudioDeviceSelectionType::None または PartyAudioDeviceSelectionType::SystemDefault を使用する場合、
audioDeviceSelectionContext は無視されます。PartyAudioDeviceSelectionType::PlatformUserDefault を使用する場合、audioDeviceSelectionContext は、チャット コントロールが音声デバイスを選択するときに使用する必要のある、非 null で空でないプラットフォーム固有のユーザー コンテキストである必要があります。PartyAudioDeviceSelectionType::Manual を使用する場合、audioDeviceSelectionContext は、チャット コントロールが使用する必要のある音声デバイスの、非 null で空でない識別子である必要があります。
asyncIdentifier void*オプション 完了状態の変化をこの呼び出しに関連付けるために使用できる、オプションでアプリ定義のポインター サイズのコンテキスト値。
戻り値
PartyError 音声出力を設定する非同期操作が開始された場合はc_partyErrorSuccess、それ以外の場合はエラー コード。このメソッドが失敗した場合、関連する状態変化は生成されません。エラー コードの人間が読める形式は、PartyManager::GetErrorMessage() で取得できます。
解説
このメソッドは、このローカル チャット コントロールに関連付けられた優先スピーカーまたはヘッドセット デバイスを構成する非同期操作をキューに追加します。メソッドが成功した場合、出力デバイスのステータスに関する詳細を含む PartyLocalChatAudioOutputChangedStateChange が PartyManager::StartProcessingStateChanges() によって提供され、操作の完了時には成功または失敗を示す PartySetChatAudioOutputCompletedStateChange が提供されます。完了後、デバイスの削除など、音声デバイスのステータスが変わるたびに追加の PartyLocalChatAudioOutputChangedStateChange が提供されます。指定されたデバイスが存在しない場合、チャット コントロールは音声デバイスの変更をサブスクライブし、デバイスが現れたときにそれを使用します。
XBOX プラットフォームで
PlatformUserDefault オプションを使用する場合、XBOX User Identifier (XUID) を audioDeviceSelectionContext の値として渡す必要があります。
要件
ヘッダー: Party.h関連項目
PartyLocalChatControlPartyLocalChatControl::GetAudioOutput
PartyLocalChatControl::SetAudioInput