Edit

PartyLocalChatControl::ConfigureAudioManipulationCaptureStream

  • Article

Queues an asynchronous operation to configure the audio manipulation capture stream.

Syntax

PartyError ConfigureAudioManipulationCaptureStream(  
    PartyAudioManipulationSinkStreamConfiguration* configuration,  
    void* asyncIdentifier  
)

Parameters

configuration   PartyAudioManipulationSinkStreamConfiguration*
optional

The stream configuration.

asyncIdentifier   void*
optional

An optional, app-defined, pointer-sized context value that can be used to associate the completion state change with this call.

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 the configuration is non-null, a capture stream will be created for this chat control. Such a stream acts as the voice input for this chat control that is sent to all other chat controls to which this chat control is configured to communicate. If the configuration is null, and a capture stream has previously been configured, the capture will be destroyed.

Upon completion of the asynchronous operation, when a non-null configuration was specified, a capture stream for this chat control can be queried via PartyLocalChatControl::GetAudioManipulationCaptureStream(). Completion is indicated by a PartyConfigureAudioManipulationCaptureStreamCompletedStateChange.

Platform support and supported formats

This function is only supported on Windows, Xbox, and PlayStation® 5. Calls on other platforms will fail.

The following format options are supported for Windows and Xbox.

Format option Supported value
Samples per second 24 kHz
Channel mask 0
Channel count 1
Bits per sample 32
Sample type PartyAudioSampleType::Float
Interleaved false



For a list of supported format options for PlayStation® 5, please refer to the README-RealTimeAudioManipulation.md document distributed with the Party library package.

Requirements

Header: Party.h

See also

PartyLocalChatControl