Edit

Share via

PartyAudioManipulationSourceStream::GetFormat

  • Article

Retrieves the format of the buffers that will be provided by PartyAudioManipulationSourceStream::GetNextBuffer().

Syntax

PartyError GetFormat(  
    PartyAudioFormat* format  
)

Parameters

format   PartyAudioFormat*
output

The format of the buffers that will be provided by PartyAudioManipulationSourceStream::GetNextBuffer().

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

If a format is specified in the configuration provided by PartyAudioManipulationSourceStream::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

PartyAudioManipulationSourceStream
PartyChatControl::ConfigureAudioManipulationVoiceStream
PartyAudioManipulationSourceStream::GetNextBuffer
PartyAudioManipulationSourceStream::GetConfiguration