PartyLocalChatControl::SetAudioOutput

Artikel
07/11/2023

Konfiguriert die bevorzugten Lautsprecher oder headset-Geräte, die das Chat-Steuerelement für die Audioausgabe verwendet.

Syntax

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

Parameter

audioDeviceSelectionType PartyAudioDeviceSelectionType

Wenn PartyAudioDeviceSelectionType::None angegeben ist, wird die Audioausgabe gelöscht. Wenn PartyAudioDeviceSelectionType::SystemDefault angegeben ist, versucht die Parteibibliothek, das Standardkommunikationsgerät des Systems zu verwenden. Wenn PartyAudioDeviceSelectionType::P latformUserDefault angegeben ist, versucht die Parteibibliothek, das Standardkommunikationsgerät zu verwenden, das zugeordnet audioDeviceSelectionContextist. Wenn PartyAudioDeviceSelectionType::Manual angegeben ist, versucht die Parteibibliothek, das Kommunikationsgerät zu verwenden, dessen Gerätebezeichner mit übereinstimmt audioDeviceSelectionContext.

audioDeviceSelectionContext PartyString
Optional

Bei Verwendung von PartyAudioDeviceSelectionType::None oder PartyAudioDeviceSelectionType::SystemDefaultaudioDeviceSelectionContext wird ignoriert. Bei Verwendung von PartyAudioDeviceSelectionType::P latformUserDefaultaudioDeviceSelectionContext muss der nicht NULL-, nicht leere plattformspezifische Benutzerkontext sein, den das Chat-Steuerelement bei der Auswahl des Audiogeräts verwenden sollte. Bei Verwendung von PartyAudioDeviceSelectionType::ManualaudioDeviceSelectionContext muss der Nicht-NULL-Bezeichner des Audiogeräts sein, das vom Chatsteuerelement verwendet werden soll.

asyncIdentifier Leere*
Optional

Ein optionaler, app-definierter Kontextwert in Zeigergröße, der verwendet werden kann, um die Änderung des Abschlusszustands diesem Aufruf zuzuordnen.

Rückgabewert

PartyError

c_partyErrorSuccess , wenn der asynchrone Vorgang zum Festlegen der Audioausgabe gestartet wurde, andernfalls ein Fehlercode. Wenn bei dieser Methode ein Fehler auftritt, werden keine zugehörigen Zustandsänderungen generiert. Die lesbare Form des Fehlercodes kann über PartyManager::GetErrorMessage() abgerufen werden.

Hinweise

Mit dieser Methode wird ein asynchroner Vorgang in die Warteschlange gestellt, um die bevorzugten Lautsprecher oder headset-Geräte zu konfigurieren, die diesem lokalen Chat-Steuerelement zugeordnet sind. Wenn die Methode erfolgreich ist, wird ein PartyLocalChatAudioOutputChangedStateChange von PartyManager::StartProcessingStateChanges() mit Details zum Ausgabegerät status bereitgestellt, und nach Abschluss des Vorgangs wird ein PartySetChatAudioOutputCompletedStateChange bereitgestellt, der auf Erfolg oder Fehler hinweist. Nach Abschluss des Vorgangs wird jedes Mal ein zusätzlicher PartyLocalChatAudioOutputChangedStateChange bereitgestellt, wenn sich das Audiogerät status, z. B. aufgrund von Geräteentfernungen.

Wenn das angegebene Gerät nicht vorhanden ist, abonniert das Chat-Steuerelement Audiogeräteänderungen und verwendet das Gerät, wenn es angezeigt wird.

Wenn Sie die PlatformUserDefault Option auf der Xbox-Plattform verwenden, muss die Xbox-Benutzer-ID (XUID) als audioDeviceSelectionContext Wert übergeben werden.

Voraussetzungen

Header: Party.h

Weitere Informationen

PartyLocalChatControl
PartyLocalChatControl::GetAudioOutput
PartyLocalChatControl::SetAudioInput

Freigeben über