XApuCommandId
Defines the base command parameters to be sent and received from XAPU. All other commands are expanded from this type.Syntax
Members
typeType: XApuCommandType Command type to instruct the hardware how to process the associated data in this command. streamIndex
Type: uint32_t Index of the stream. The value should be between 0 and XApuConnectInputParameters::maxStreamCount - 1. Every stream should have a unique index value and the caller is responsible for assigning this value. sequence
Type: uint32_t This value is untouched by XAPU and it up to the caller how to use it. It can be used as a command sequence number that shall increase with time to track packets as they come out from the result queue. XAPU will not rearrange the packets’ order according to this sequence number, nor will it return an error if this number goes backwards or if there is a gap from a previous value. options
Type: XApuCommandOptions Command options. Some options can be applied to all command types like XApuCommandOptions::SignalOnCompletion, others work for a specific command type like XApuCommandOptions::Flush and XApuCommandOptions::Decoder. context
Type: void* An optional place holder for user data that XAPU will pass around internally, as is, from the enqueue command stage all the way to the dequeue result stage. The caller is free to pass any data that will fit within the 64-bit unsigned value such as timestamps.
Remarks
Used by XApuCommandId to define the base command parameters sent and received from the XAPU. All other commands are expanded from this type. For more information about decode and convert activate processing parameters, see XApuDecodeConvertActivateCommand and XApuDecodeConvertCommand. For information about submitting a command to the XAPU input queue, see XApuEnqueueCommand.Requirements
Header: xapu.h Supported platforms: XBOX Series X|SSee also
XApuDequeueResultXApuResult
XAPU