CXAPOBase::Initialize Method

Performs any effect-specific initialization.

Syntax

public:
HRESULT Initialize(
         const void *,
         UINT32 DataByteSize
)

Parameters

Type: void

[in, optional] Effect-specific initialization parameters, may be NULL if DataByteSize is 0.

DataByteSize
Type: UINT32

Size of pData in bytes, may be 0 if pData is NULL.

Return value

Type: HRESULT

Returns S_OK if successful, an error code otherwise.

Remarks

The contents of pData are defined by a given XAPO. Immutable parameters (constant for the lifetime of the XAPO) should be set in this method. Once initialized, an XAPO cannot be initialized again. An XAPO should be initialized before passing it to XAudio2 as part of an effect chain. Note XAudio2 does not call this method, it should be called by the client before passing the XAPO to XAudio2.

Requirements

Header: Declared in xapobase.h.