> ## 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.

# PartyAudioManipulationSinkStream::GetFormat

> Retrieves the format of the buffers that will be submitted to.

Retrieves the format of the buffers that will be submitted to [PartyAudioManipulationSinkStream::SubmitBuffer()](/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_submitbuffer).

## Syntax

```cpp theme={null}
PartyError GetFormat(  
    PartyAudioFormat* format  
)  
```

### Parameters

**`format`**   [PartyAudioFormat\*](/services/playfab/multiplayer/networking/reference/structs/partyaudioformat)\
*output*

The format of the buffers that will be submitted to [PartyAudioManipulationSinkStream::SubmitBuffer()](/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_submitbuffer).

### 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

If a format is specified in the configuration provided by [PartyAudioManipulationSinkStream::GetConfiguration()](/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_getconfiguration), this format will match. Otherwise, this format will be the most efficient format automatically selected by the library.

## Requirements

**Header:** Party.h

## See also

[PartyAudioManipulationSinkStream](/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/partyaudiomanipulationsinkstream)\
[PartyLocalChatControl::ConfigureAudioManipulationCaptureStream](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_configureaudiomanipulationcapturestream)\
[PartyLocalChatControl::ConfigureAudioManipulationRenderStream](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_configureaudiomanipulationrenderstream)\
[PartyAudioManipulationSinkStream::SubmitBuffer](/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_submitbuffer)\
[PartyAudioManipulationSinkStream::GetConfiguration](/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_getconfiguration)


## Related topics

- [PartyAudioManipulationSinkStream::SubmitBuffer](/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_submitbuffer.md)
- [PartyAudioManipulationSinkStreamConfiguration](/services/playfab/multiplayer/networking/reference/structs/partyaudiomanipulationsinkstreamconfiguration.md)
- [PartyAudioManipulationSinkStream](/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/partyaudiomanipulationsinkstream.md)
- [PartyAudioManipulationSinkStream::GetConfiguration](/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_getconfiguration.md)
- [PartyAudioManipulationSinkStream::GetCustomContext](/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_getcustomcontext.md)