XApuCommandOptions

Define options for different command types.

Syntax

enum class XApuCommandOptions  : uint32_t  
{  
    None = 0,  
    SignalOnCompletion = 1,  
    Flush = 2,  
    Decoder = 4,  
}  

Constants

Constant	Description
None	No options are set.
SignalOnCompletion	This flag can be applied to all command types and when set, XApuConnectOutputParameters::resultReadyEvent is signaled when the result of the command is ready. To use this flag, the caller must set XApuConnectOptions::EnableResultReadyEvent in XApuConnect. Please refer to the XApuConnectOutputParameters::resultReadyEvent description.
Flush	Release output data if available without waiting for more input data. This flag works with XApuProcessType::Process only, otherwise it will be ignored. This flag can be used with XApuProcessType::DecodeConvertOpus and XApuProcessType::ConvertPCM only.
Decoder	When set it will reset the decoder in XApuProcessType::DecodeConvertOpus processing mode only. This flag works with XApuCommandType::Reset only, otherwise it will be ignored. This flag can be used to reset the decoder only in a decode-convert case during seeking. It is up to the caller to use XApuCommandType::Reset with the XApuCommandOptions::Decoder flag 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 uses the XApuConnectOutputParameters::resultReadyEvent method to signal when the result of the command is ready. The decoder command uses the XApuProcessType::DecodeConvertOpus method only. Otherwise, the Opus decoder will be reset using the XApuCommandType::Reset method. When the Decoder flag is used with the Reset command, it will not erase the data that has already been decoded but is still waiting to be processed into the HSRC.

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

XApuCommandOptions

XApuCommandOptions

Syntax

Constants

Remarks

Requirements

See also

​XApuCommandOptions

​Syntax

​Constants

​Remarks

​Requirements

​See also

XApuCommandOptions

Syntax

Constants

Remarks

Requirements

See also