PartyLocalChatControl::SetAudioOutput

  • [アーティクル]

チャット コントロールがオーディオ出力に使用する優先スピーカーまたはヘッドセット デバイスを構成します。

構文

PartyError SetAudioOutput(  
    PartyAudioDeviceSelectionType audioDeviceSelectionType,  
    PartyString audioDeviceSelectionContext,  
    void* asyncIdentifier  
)

パラメーター

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() を介して取得できます。

解説

このメソッドは、非同期操作をキューに入れて、このローカル チャット コントロールに関連付けられている優先スピーカーまたはヘッドセット デバイスを構成します。 メソッドが成功すると、PartyManager::StartProcessingStateChanges() によって PartyLocalChatAudioOutputChangedStateChange が出力デバイスの状態の詳細とともに提供され、操作の完了時に PartySetChatAudioOutputCompletedStateChange が提供され、成功または失敗が示されます。 完了後、デバイスの取り外しなどによりオーディオ デバイスの状態が変更されるたびに、追加の PartyLocalChatAudioOutputChangedStateChange が提供されます。

指定されたデバイスが存在しない場合、チャット コントロールはオーディオ デバイスの変更をサブスクライブし、表示されたときにデバイスを使用します。

Xbox プラットフォームで PlatformUserDefault オプションを使用する場合は、Xbox ユーザー識別子 (XUID) を audioDeviceSelectionContext 値として渡す必要があります。

要件

ヘッダー: Party.h

関連項目

PartyLocalChatControl
PartyLocalChatControl::GetAudioOutput
PartyLocalChatControl::SetAudioInput