> ## Documentation Index
> Fetch the complete documentation index at: https://docs.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()](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_submitbuffer.md).

## Syntax

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

### Parameters

**`format`**   [PartyAudioFormat\*](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/structs/partyaudioformat.md)\
*output*

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

### 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()](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_geterrormessage.md).

## Remarks

If a format is specified in the configuration provided by [PartyAudioManipulationSinkStream::GetConfiguration()](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_getconfiguration.md), 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](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/partyaudiomanipulationsinkstream.md)\
[PartyLocalChatControl::ConfigureAudioManipulationCaptureStream](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_configureaudiomanipulationcapturestream.md)\
[PartyLocalChatControl::ConfigureAudioManipulationRenderStream](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_configureaudiomanipulationrenderstream.md)\
[PartyAudioManipulationSinkStream::SubmitBuffer](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_submitbuffer.md)\
[PartyAudioManipulationSinkStream::GetConfiguration](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyAudioManipulationSinkStream/methods/partyaudiomanipulationsinkstream_getconfiguration.md)


## Related topics

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