Skip to main content

IAcpHal::Connect

Connects to the ACP.

Syntax

Parameters

numCommands   
Type: UINT32
Specifies the number of commands to be allocated in the ACP command queue. This value must be greater than zero and large enough to handle as many commands as were issued for each 2.67-ms audio frame. numMessages   
Type: UINT32
Specifies the number of messages to be allocated in the ACP message queue. This value can be zero if the title does not process received messages. If command completed messages (see ACP_MESSAGE_TYPE) have been registered for, there will be at least as many messages as there are commands. Typically, this message queue is processed less frequently than once per audio frame, so plan for several frame’s worth of messages.

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 before you call any other method in this interface. However, after calling Disconnect, you may call this method again. See also SubmitCommand. If the method fails from an error other than E_INVALIDARG or ACP_E_ALREADY_CONNECTED, it is advised for all existing ACP client objects to be destroyed and for allocated SHAPE contexts to be freed using AcpHalReleaseShapeContexts. New SHAPE contexts and ACP client objects should be allocated/created again as needed using AcpHalAllocateShapeContexts and AcpHalCreate respectively.

Requirements

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

See also

Disconnect
AcpHal
Last modified on August 20, 2026