XApuConnectOutputParameters
Parameters returned by XApuConnect.Syntax
Members
baseDataType: void* Base virtual address of allocated system memory that can be mapped to the device space if XApuConnect succeeded, otherwise a nullptr. The caller should use this memory to pass input data and retrieve output data. Also, the caller must use this memory to set the processing buffer. This buffer is 16-byte aligned and it is up to the caller how to break this memory into input, output, and processing buffers. resultReadyEvent
Type: HANDLE A valid Win32 event handle if the XApuConnectOptions::EnableResultReadyEvent flag is set and XApuConnect succeeded, otherwise a nullptr. This Win32 Event handle will be signaled when the results are ready for the commands that have the XApuCommandOptions::SignalOnCompletion flag set. This signal is running on a timer that fires every three milliseconds. It will signal once if one or more XApuResult are ready. That is, the event will be signaled once when multiple results are ready within the three milliseconds period and all those results have the XApuCommandOptions::SignalOnCompletion flag set. XApuGetResultCount should be called after the event being signaled to find out how many XApuResult(s) are ready. It is not recommended to set XApuCommandOptions::SignalOnCompletion when multiple streams are activated on the XAPU client as it might degrade the overall performance, instead the caller should set the SignalOnCompletion flag once for a group of commands. For example, set SignalOnCompletion for all commands for a specific stream only and don’t set it for the other activated streams.
Remarks
Used byXApuConnectOutputParameter to pass parameters returned by XApuConnect. XApuConnect allocates the necessary resources for an Audio Processing Unit (XAPU). For more information about disconnecting from the processing engine and releasing all resource allocated during XApuConnect, see XApuDisconnect. For more information about the command options, see XApuCommandOptions.
Requirements
Header: xapu.h Supported platforms: XBOX Series X|SSee also
XApuDecodeConvertCommandXAPU