PartyLocalChatControl::GetAudioManipulationCaptureStream

Retrieves the audio manipulation capture stream associated with this chat control.

Syntax

PartyError GetAudioManipulationCaptureStream(  
    PartyAudioManipulationSinkStream** stream  
)  

Parameters

stream   PartyAudioManipulationSinkStream**
library-allocated output

The output stream.

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

This stream represents acts as the associated chat control's audio input, i.e. the audio that will be treated as the local chat control's voice and sent to other chat controls. Typically, the app will retrieve audio from the voice manipulation stream stream via PartyAudioManipulationSourceStream::GetNextBuffer(), process the audio using app logic, and then submit the audio back to the library via this stream.

Audio that is submitted to this stream via PartyAudioManipulationSinkStream::SubmitBuffer() will be transcribed via speech-to-text, if transcription options configured via PartyLocalChatControl::SetTranscriptionOptions indicates that audio associated the sink's chat control should be.

Requirements

Header: Party.h

See also

PartyLocalChatControl