IXAPOParameters::GetParameters Method

Gets the current values for any effect-specific parameters.

Syntax

public:
void GetParameters(
         void *pParameters,
         UINT32 ParameterByteSize
)

Parameters

pParameters
Type: void *

[out] Receives an effect-specific parameter block.

ParameterByteSize
Type: UINT32

Size of pParameters, in bytes.

Return value

None.

Remarks

The data in pParameters is completely effect-specific and determined by the implementation of the IXAPOParameters::GetParameters function. The data returned in pParameters can be used to provide information about the current state of the XAPO.

Unlike SetParameters, XAudio2 does not call this method on the realtime audio processing thread. Thus, the XAPO must protect variables shared with IXAPOParameters::SetParameters or IXAPO::Process using appropriate synchronization. The CXAPOParametersBase class is an implementation of IXAPOParameters and its implementation of GetParameters efficiently handles this synchronization for the user.

XAudio2 calls this method from the GetEffectParameters method.

This method may block and should never be called from the realtime audio processing thread instead get the current parameters from CXAPOParametersBase::BeginProcess.

Requirements

Header: Declared in xapo.h.