PartyAudioDeviceSelectionType

Options for selecting audio devices

Syntax

enum class PartyAudioDeviceSelectionType    
{  
    None = 0,  
    SystemDefault = 1,  
    PlatformUserDefault = 2,  
    Manual = 3,  
}  

Constants

Constant Description
None Indicate that no audio device should be used.
SystemDefault Select audio device based on the platform settings.

If this selection type is used for PartyLocalChatControl::SetAudioInput() or PartyLocalChatControl::SetAudioOutput(), then the audioDeviceSelectionContext should be nullptr.
PlatformUserDefault Select audio device based on the platform and user settings.

If this selection type is used for PartyLocalChatControl::SetAudioInput() or PartyLocalChatControl::SetAudioOutput(), then the audioDeviceSelectionContext must be a platform specific user context.
Manual Audio device specified by the game.

If this selection type is used for PartyLocalChatControl::SetAudioInput() or PartyLocalChatControl::SetAudioOutput(), then the audioDeviceSelectionContext must be the identifier of the audio device to use.

On Android, iOS, and macOS, setting a manual input device is an illegal operation. Using manual device selection with PartyLocalChatControl::SetAudioInput() on Android, iOS, and macOS will result in an error indicating that the device selection type is not supported.

Requirements

Header: Party.h

See also

Party members
PartyLocalChatControl::SetAudioInput
PartyLocalChatControl::SetAudioOutput