Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Provides the preferred speakers or headset device that the chat control has been configured to use for audio output.
Syntax
PartyError GetAudioOutput(
PartyAudioDeviceSelectionType* audioDeviceSelectionType,
PartyString* audioDeviceSelectionContext,
PartyString* deviceId
)
Parameters
audioDeviceSelectionType PartyAudioDeviceSelectionType*
output
An output value indicating the selection type that was used to select the provided deviceId.
audioDeviceSelectionContext PartyString*
library-allocated output
When using PartyAudioDeviceSelectionType::None or PartyAudioDeviceSelectionType::SystemDefault, audioDeviceSelectionContext will be empty. When using PartyAudioDeviceSelectionType::PlatformUserDefault or PartyAudioDeviceSelectionType::Manual, audioDeviceSelectionContext will be the value provided in a previous call to SetAudioOutput(). The memory for the string remains valid until the next PartyLocalChatAudioOutputChangedStateChange is provided via PartyManager::StartProcessingStateChanges() or the chat control is destroyed.
deviceId PartyString*
library-allocated output
An output value indicating the selected audio output device's identifier. The memory for the string remains valid until the next PartyLocalChatAudioOutputChangedStateChange is provided via PartyManager::StartProcessingStateChanges() or the chat control is destroyed.
Return value
PartyError
c_partyErrorSuccess if the call succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via PartyManager::GetErrorMessage().
Remarks
An empty device identifier string indicates that no output has been selected.
Requirements
Header: Party.h
See also
PartyLocalChatControl
PartyLocalChatControl::SetAudioOutput
PartyLocalChatControl::GetAudioInput