Skip to main content

AcpHalAllocateShapeContexts

Allocates context arrays for the Scalable Hardware Audio Processing Engine (SHAPE) and XBOX Media Audio (XMA).

Syntax

Parameters

contextArrays   _Inout_
Type: SHAPE_CONTEXTS*
On input, the context should contain the requested size of the context arrays. If the function succeeds, the context is populated with the allocated arrays. Refer to the SHAPE_DMA_CONTEXT, SHAPE_EQCOMP_CONTEXT, SHAPE_FILTVOL_CONTEXT, SHAPE_PCM_CONTEXT, SHAPE_SRC_CONTEXT, and SHAPE_XMA_CONTEXT structures.

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):

Remarks

Call this method to allocate contexts for an Audio Control Processor (ACP) client before calling AcpHalCreate. Unless there’s a subsequent call to AcpHalReleaseShapeContexts, this method should be called only once. The number of Sample Rate Convertor (SRC) contexts must equal the sum of the number of pulse-code modulation (PCM) contexts and the number of XMA contexts.

Requirements

Header: acphal.h Library: acphal.lib Supported platforms: XBOX One family consoles and XBOX Series consoles

See also

AcpHalReleaseShapeContexts
AcpHalCreate
AcpHal
Last modified on August 20, 2026