> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PartyLocalChatControl::GetAudioInput

> Provides the preferred microphone or recording device that the chat control has been configured to use for audio input.

Provides the preferred microphone or recording device that the chat control has been configured to use for audio input.

## Syntax

```cpp theme={null}
PartyError GetAudioInput(  
    PartyAudioDeviceSelectionType* audioDeviceSelectionType,  
    PartyString* audioDeviceSelectionContext,  
    PartyString* deviceId  
)  
```

### Parameters

**`audioDeviceSelectionType`**   [PartyAudioDeviceSelectionType\*](/services/playfab/multiplayer/networking/reference/enums/partyaudiodeviceselectiontype)\
*output*

An output value indicating the selection type that was used to select the provided `deviceId`.

**`audioDeviceSelectionContext`**   [PartyString\*](/services/playfab/multiplayer/networking/reference/typedefs)\
*library-allocated output*

When using [PartyAudioDeviceSelectionType::None](/services/playfab/multiplayer/networking/reference/enums/partyaudiodeviceselectiontype) or [PartyAudioDeviceSelectionType::SystemDefault](/services/playfab/multiplayer/networking/reference/enums/partyaudiodeviceselectiontype), `audioDeviceSelectionContext` will be empty. When using [PartyAudioDeviceSelectionType::PlatformUserDefault](/services/playfab/multiplayer/networking/reference/enums/partyaudiodeviceselectiontype) or [PartyAudioDeviceSelectionType::Manual](/services/playfab/multiplayer/networking/reference/enums/partyaudiodeviceselectiontype), `audioDeviceSelectionContext` will be the value provided in a previous call to [SetAudioInput()](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_setaudioinput). The memory for the string remains valid until the next [PartyLocalChatAudioInputChangedStateChange](/services/playfab/multiplayer/networking/reference/structs/partylocalchataudioinputchangedstatechange) is provided via [PartyManager::StartProcessingStateChanges()](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_startprocessingstatechanges) or the chat control is destroyed.

**`deviceId`**   [PartyString\*](/services/playfab/multiplayer/networking/reference/typedefs)\
*library-allocated output*

An output value indicating the selected audio input device's identifier. The memory for the string remains valid until the next [PartyLocalChatAudioInputChangedStateChange](/services/playfab/multiplayer/networking/reference/structs/partylocalchataudioinputchangedstatechange) is provided via [PartyManager::StartProcessingStateChanges()](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/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()](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_geterrormessage).

## Remarks

An empty device identifier string indicates that no input has been selected.

## Requirements

**Header:** Party.h

## See also

[PartyLocalChatControl](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/partylocalchatcontrol)\
[PartyLocalChatControl::SetAudioInput](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_setaudioinput)\
[PartyLocalChatControl::GetAudioOutput](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getaudiooutput)


## Related topics

- [PartyLocalChatControl::SetAudioInput](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_setaudioinput.md)
- [PartyLocalChatControl::GetAudioOutput](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getaudiooutput.md)
- [PartyLocalChatControl::GetAudioInputMuted](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getaudioinputmuted.md)
- [PartyLocalChatControl](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/partylocalchatcontrol.md)
- [PartyLocalChatControl::SetAudioOutput](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_setaudiooutput.md)