CXAPOParametersBase::OnSetParameters Method

Called by IXAPOParameters::SetParameters to allow for user-defined parameter validation.

Syntax

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

Parameters

pParameters
Type: void *

[in] Effect-specific parameter block.

ParameterByteSize
Type: UINT32

Size, in bytes, of pParameters.

Return value

None.

Remarks

Users are expected to use asserts for parameter validation in OnSetParameters.

The CXAPOParametersBase class’s implementation of IXAPOParameters::SetParameters validates that ParameterByteSize is equal to the m_uParameterBlockByteSize private member before calling OnSetParameters so it may be assumed that ParameterByteSize == m_uParameterBlockByteSize. m_uParameterBlockByteSize will be equal to the uParameterBlockByteSize parameter passed into the CXAPOParametersBase::CXAPOParametersBase constructor.

This method should not block as it is called from the realtime audio processing thread.

Requirements

Header: Declared in xapobase.h.