Edit

PartyAudioManipulationSourceStreamConfiguration

  • Article

The configuration information needed to set up an audio source stream.

Syntax

struct PartyAudioManipulationSourceStreamConfiguration {  
    PartyAudioFormat* format;  
    uint32_t maxTotalAudioBufferSizeInMilliseconds;  
}

Members

format   PartyAudioFormat*
may be nullptr

Optionally specifies the format of the audio that should be produced by the source stream.

If this value is nullptr, the source stream will produce audio in the format most efficient for the library. The format can be queried via PartyAudioManipulationSourceStream::GetFormat().

maxTotalAudioBufferSizeInMilliseconds   uint32_t

The maximum total size of audio buffers that can concurrently exist for this queue, in milliseconds.

This defines the limit for the total amount of audio internally queued by the source stream, but not yet retrieved via PartyAudioManipulationSourceStream::GetNextBuffer, plus the total amount of audio retrieved by the app, but not yet returned to the library via PartyAudioManipulationSourceStream::ReturnBuffer. When this total is reached, the source stream will stop producing additional buffers.

Because the library processes audio in 40 millisecond intervals, the effective maximum is the nearest multiple of 40 less than the specified maximum. The minimum is 40 milliseconds.

Requirements

Header: Party.h

See also

Party members
PartyChatControl::ConfigureAudioManipulationVoiceStream