IXAPOParameters::SetParameters Method

Sets effect-specific parameters.

Syntax

public:
void SetParameters(
         const void *pParameters,
         UINT32 ParameterByteSize
)

Parameters

pParameters
Type: void *

[in] 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::SetParameters function. The data passed to SetParameters can be used to set the state of the XAPO and control the behavior of the IXAPO::Process function.

SetParameters can only be called on the real-time audio processing thread; no synchronization between SetParameters and the IXAPO::Process method is necessary. However, the IXAudio2Voice::SetEffectParameters method may be called from any thread as it adds in the required synchronization to deliver a copy (asynchronously) of the parameters to SetParameters on the real-time thread; no synchronization between IXAudio2Voice::SetEffectParameters and the IXAPO::Process method is necessary.

Requirements

Header: Declared in xapo.h.