XMA Utility Methods

XMA utility methods defined by the shapexmacontext.h file.

In this section

GetShapeXmaCurrentInputBuffer
Gets the current input buffer.

GetShapeXmaErrorSet
Gets a flag indicating whether an error has occured.

GetShapeXmaErrorStatus
Gets the error code.

GetShapeXmaInputBuffer0Size
Gets the left input buffer size.

GetShapeXmaInputBuffer0Valid
Gets the left input buffer valid flag.

GetShapeXmaInputBuffer0
Gets the left input buffer address.

GetShapeXmaInputBuffer1Size
Gets the right input buffer size.

GetShapeXmaInputBuffer1Valid
Gets the right input buffer valid flag.

GetShapeXmaInputBuffer1
Gets the right input buffer address.

GetShapeXmaInputBufferReadOffset
Gets the input buffer read offset.

GetShapeXmaInputBufferValid
Gets the input buffer valid flags.

GetShapeXmaInterruptWhenDone
Gets the interrupt when done flag. For internal use only.

GetShapeXmaLoopEndOffset
Gets the loop end offset.

GetShapeXmaLoopStartOffset
Gets the loop start offset.

GetShapeXmaLoopSubframeEnd
Gets the loop subframe end point.

GetShapeXmaLoopSubframeSkip
Gets the loop subframe skip number.

GetShapeXmaNumChannels
Gets the number of channels.

GetShapeXmaNumLoops
Gets the number of loops.

GetShapeXmaNumSubframesToDecode
Gets the number of subframes to decode per pass.

GetShapeXmaNumSubframesToSkip
Gets the number of subframes to skip.

GetShapeXmaOutputBufferNumBytesAvailable
Gets the number of bytes available for reading in the output buffer.

GetShapeXmaOutputBufferReadOffset
Gets the output buffer read offset,

GetShapeXmaOutputBufferSize
Gets the output buffer size.

GetShapeXmaOutputBufferValid
Gets the output buffer valid flag.

GetShapeXmaOutputBufferWriteOffset
Gets the output buffer write offset

GetShapeXmaOutputBuffer
Gets the output buffer index.

GetShapeXmaOverlapAddBuffer
Gets the working buffer address.

GetShapeXmaPacketMetadata
Gets the packet metadata. For internal use only.

GetShapeXmaParserErrorSet
Gets a flag indicating whether an XMA parser error has occured.

GetShapeXmaParserErrorStatus
Gets an XMA parser error code.

GetShapeXmaSampleRate
Gets the sample rate.

GetShapeXmaStopWhenDone
Gets the stop when done flag. For internal use only.

SetShapeXmaCurrentInputBuffer
Sets the current input buffer.

SetShapeXmaInputBuffer0Size
Sets the left input buffer size.

SetShapeXmaInputBuffer0Valid
Sets the left input buffer valid flag.

SetShapeXmaInputBuffer0
Sets the left input buffer address. This is an overloaded function, one function accepts a virtual pointer, the other the physical address.

SetShapeXmaInputBuffer1Size
Sets the right input buffer size.

SetShapeXmaInputBuffer1Valid
Sets the right input buffer valid flag.

SetShapeXmaInputBuffer1
Sets the right input buffer address. This is an overloaded function, one function accepts a virtual pointer, the other the physical address.

SetShapeXmaInputBufferReadOffset
Sets the input buffer read offset.

SetShapeXmaInputBufferValid
Sets the input buffer valid flags.

SetShapeXmaInterruptWhenDone
Sets the interrupt when done flag. For internal use only.

SetShapeXmaLoopEndOffset
Sets the loop end offset.

SetShapeXmaLoopStartOffset
Sets the start offset.

SetShapeXmaLoopSubframeEnd
Sets the loop subframe end point.

SetShapeXmaLoopSubframeSkip
Sets the number of subframes to skip.

SetShapeXmaNumChannels
Sets the number of channels.

SetShapeXmaNumLoops
Sets the number of loops.

SetShapeXmaNumSubframesToDecode
Sets the number of subframes to decode per pass.

SetShapeXmaNumSubframesToSkip
Sets the number of subframes to skip.

SetShapeXmaOutputBufferReadOffset
Sets the output buffer read offset.

SetShapeXmaOutputBufferSize
Sets the output buffer size.

SetShapeXmaOutputBufferValid
Sets the output buffer valid flag.

SetShapeXmaOutputBuffer
Sets the output buffer address. This is an overloaded function, one function accepts a virtual pointer, the other the physical address.

SetShapeXmaOverlapAddBuffer
Sets the XMA context overlap add buffer. This is an overloaded function, one function accepts a virtual pointer, the other the physical address.

SetShapeXmaPacketMetadata
Sets the packet metadata. For internal use only.

SetShapeXmaSampleRate
Sets the sample rate.

SetShapeXmaStopWhenDone
Sets the stop when done flag. For internal use only.