CXAPOParametersBase::CXAPOParametersBase method (xapobase.h)

Article
10/05/2021

Creates an instance of the CXAPOParametersBase class.

Syntax

void CXAPOParametersBase(
  const XAPO_REGISTRATION_PROPERTIES *pRegistrationProperties,
  BYTE                               *pParameterBlocks,
  UINT32                             uParameterBlockByteSize,
  BOOL                               fProducer
);

Parameters

pRegistrationProperties

Type: const XAPO_REGISTRATION_PROPERTIES*

A pointer to an XAPO_REGISTRATION_PROPERTIES structure that contains the registration properties for the XAPO.

pParameterBlocks

Type: BYTE*

Pointer to three contiguous process parameter blocks used for synchronization.

uParameterBlockByteSize

Type: UINT32

Size of a parameter block in pParameterBlocks.

fProducer

Type: BOOL

If TRUE, indicates IXAPO::Process produces data to be returned by IXAPOParameters::GetParameters and disallows calls to IXAPOParameters::SetParameters.

Return value

None

Remarks

All process parameter blocks in pParameterBlocks must be initialized to the same default value before there is a call to the IXAPO::Process, IXAPOParameters::GetParameters, and IXAPOParameters::SetParameters methods. Usually this initialization should be handled in IXAPO::Initialize or in IXAPO::LockForProcess.

The object created by this CXAPOParametersBase will have a reference count of 1.

Platform Requirements

Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)

Requirements

Requirement	Value
Target Platform	Windows
Header	xapobase.h
Library	XAPOBase.lib

Share via