XDspActivate

Activate XDSP stream by acquiring a free processing resource from the pool. Each XDSP client is limited to 256 stream activations.

Syntax

HRESULT XDspActivate(  
         XDspClientHandle clientHandle,  
         XDspActivationParameters* params,  
         XDspStatus** status,  
         XDspStreamHandle* streamHandle  
)  

Parameters

clientHandle   _In_
Type: XDspClientHandle A valid XDSP client handle obtained from the call to XDspConnect. params   _In_
Type: XDspActivationParameters* Pointer to an XDspActivationParameters structure. status   _Outptr_
Type: XDspStatus** Pointer to an XDspStatus structure. See the Remarks section for additional details. streamHandle   _Outptr_
Type: XDspStreamHandle* Valid XDspStreamHandle, if the call succeeds. 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 one of the following codes (partial list):

Return code	Description
E_POINTER	Pointer that is not valid.
E_INVALIDARG	One or more of the arguments are invalid.
XDSP_E_NO_DEVICE_RESOURCES	No XDSP device resources are available to service your request.
XDSP_E_INVALID_IMPULSE_RESPONSE_LENGTH	The impulse response length provided is invalid. This error may occur if an impulseResponseLengthInFloats of less than (`9 * blockSize * 2`) or more than 16 seconds (`16 * 48000 * 2`) is provided.

Remarks

This call is quick as it acquires resources from the pool instead of allocating them. The caller must specify an XDspProcessType for the XDSP stream to perform. An instance of XDSP stream can work with one processing type only during its lifetime. To perform two or more different processing types, two or more XDSP stream instances must be instantiated. Inside the XDspActivationParameters structure, the caller must specify the following:

Activation options.
Number of frames that will be processed in each command, i.e. the input and output number of frames.
Number of channels of the stream. Only mono and stereo input streams are supported.
For XDspProcessType::Convolution processing type, the length of the impulse response in floats.
For XDspProcessType::Convolution processing type, the impulse response as frequency domain values.

If the call succeeds, a valid XDspStreamHandle will be returned to be used with other calls (XDspSubmitCommand, XDspSubmitCommandWithEnvelope, XDspDeactivate) for this stream. Also, if this call succeeds it will return a pointer to XDspStatus that can be used to check the status of the submitted commands. This should be used to determine the latest command that has been processed and whether the results from the submitted commands are ready to be consumed. XDspStatus also has the sequence number of the last command that was submitted to the hardware and the sequence number of the first failed command for the XDSP stream that it represents. In case of convolution processing, the caller may free the impulse response memory after this call returns.

Requirements

Header: XDspAudio.h Library: Chad.lib Supported platforms: XBOX Series X|S

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

XDspActivate

XDspActivate

Syntax

Parameters

Return value

Remarks

Requirements

Conceptual documentation

See also

​XDspActivate

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​Conceptual documentation

​See also

XDspActivate

Syntax

Parameters

Return value

Remarks

Requirements

Conceptual documentation

See also