XDspSubmitCommand
Submit one command to the hardware queue for a given XDSP stream.Syntax
Parameters
handle _In_Type: XDspStreamHandle A valid XDSP stream handle. command _In_
Type: XDspCommand* Pointer to a XDspCommand structure. commandSequence _Out_
Type: uint32_t* Pointer to
uint32_t to return a command sequence value. See the Remarks section for additional details.
Return value
Type: HRESULT If the method succeeds, it returns S_OK. If the method fails, it returns the following code (partial list):Remarks
This call will be fast as it will not allocate resources or process data and just sends the command to the hardware server. This call will also take a pointer touint32_t to return a command sequence value, commandSequence, to track when the command result is ready later. This number represents the total number of commands that have been submitted successfully since the session started and after XDspActivate was called. This number will be one for the first command and is incremented by one for each successful XDspSubmitCommand call after that.
If the hardware server is in a bad state, XDspSubmitCommand will return XDSP_E_DEVICE_FATAL_ERROR error code. At this point, no more commands can be submitted for the XDSP stream that is in a failed state. XDspStatus for the stream will also indicate the same error. The affected XDSP stream should wait for all submitted commands to be processed by the hardware by checking the XDspStatus and it should be deactivated using XDspDeactivate once all the commands are processed. Other XDSP streams will not be affected and hardware will continue to process their commands.
Requirements
Header: XDspAudio.h Library: Chad.lib Supported platforms: XBOX Series X|SConceptual documentation
- Overview of XDSP Enveloping
- Overview of a single stream Convolution with Envelope using the XDSP API
- Overview of a single stream Convolution using the XDSP API
- XDSP overview
See also
XDSPXDspSubmitCommandWithEnvelope
XDSP Errors
Overview of a single stream Convolution using the XDSP API
Overview of a single stream FFT/IFFT using the XDSP API
Overview of a single stream Convolution with Envelope using the XDSP API