XApuCommandType

Defines the command types that will be performed on a single stream.

Syntax

enum class XApuCommandType  : uint32_t  
{  
    None = 0,  
    Activate = 1,  
    Deactivate = 2,  
    Process = 3,  
    Notify = 4,  
    Reset = 5,  
}  

Constants

Constant	Description
None	Invalid command type.
Activate	Activates and initializes a single stream for processing.
Deactivate	Deactivates and releases single stream resources.
Process	Processes single stream input data to generate an output.
Notify	Not used
Reset	Resets a single stream decode and/or convert engines to its original activated state. This command will put the decoder and converter in their original state activation by using the same original activation parameters like channelCount and startPitch. It is up to the caller to use XApuCommandType::Reset or not during seeking, looping or splicing two streams, but when used the caller must submit preroll data to avoid the transient effect in the output.

Remarks

This enumeration determines activate and deactivate processes such as decode, convert, and decode-convert. It releases a process resource during deactivate. It sends a notification of its status of the current active processor. It also resets a process to its original activated state.

Requirements

Header: xapu.h 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

XApuCommandType

XApuCommandType

Syntax

Constants

Remarks

Requirements

See also

​XApuCommandType

​Syntax

​Constants

​Remarks

​Requirements

​See also

XApuCommandType

Syntax

Constants

Remarks

Requirements

See also