XApuConnectInputParameters
Parameters passed to XApuConnect to allocated resources.Syntax
Members
processTypeType: XApuProcessType Process type that will be performed for all the streams processed by the XAPU client. A single client cannot perform more than one process type. maxStreamCount
Type: uint32_t Maximum number of streams that is expected to be activated for the XAPU client simultaneously. Min value is 1, max is 500 maxQueuedCommandsPerStream
Type: uint32_t Command queue size for one stream. Min value is 1, max is 16. Total command queue size for the XAPU client is maxStreamCount * maxQueuedCommandsPerStream baseDataLength
Type: uint32_t The required memory allocation in bytes to process maxStreamCount streams which includes the input, output, and processing buffers. For example, baseDataLength for DecodeOpus case of one stereo Opus stream with 20 milliseconds packets (960 frames) can be maximum expected input packet length in bytes plus output frame count times number of channels times size of float variable. For XApuProcessType::DecodeOpus the general formula is: baseDataLength = maxStreamCount x maxQueuedCommandsPerStream x (MaxOpusPacketInBytes + (MaxFrameCountPerPacket x ChannelCount x sizeof(float)) where MaxFrameCountPerPacket should be multiple of 16 For XApuProcessType::DecodeConvertOpus the general formula is: baseDataLength = (maxStreamCount x maxQueuedCommandsPerStream x (MaxOpusPacketInBytes + (MaxFrameCountPerPacket x ChannelCount x sizeof(float)))
- (maxStreamCount x XApuDecodeConvertActivateCommand::processingBufferLength) where MaxFrameCountPerPacket should be multiple of 16
Type: uint32_t This parameter defines the output duration in frame count when XAPU is running in XApuProcessType::ConvertPCM or XApuProcessType::DecodeConvertOpus types. For XApuProcessType::ConvertPCM or XApuProcessType::DecodeConvertOpus, this parameter must be set to one of the following values: 256, 480, 512, 960, 1024. This parameter must be set to zero for XApuProcessType::DecodeOpus options
Type: XApuConnectOptions Connect options.
Remarks
Used byXApuConnectInputParameters to pass parameters to XApuConnect. XApuConnect allocates the necessary resources for an Audio Processing Unit (XAPU). XApuCommandId defines the base command parameter to be sent and received from the XAPU.
Requirements
Header: xapu.h Supported platforms: XBOX Series X|SSee also
XApuCommandIdXApuConnect
XApuDecodeConvertCommand
XAPU