AAX_IHostProcessorDelegate Class Reference

#include <AAX_IHostProcessorDelegate.h>

Inheritance diagram for AAX_IHostProcessorDelegate:

Description

Delegate for retrieving offline processing information from the host.

:Implemented by the AAX Host:

The host provides a host processor delegate to a plug-in's host processor object at initialization. The host processor object may make calls to this object to get information about the current render pass or to affect the plug-in's offline processing behavior.

Public Member Functions
virtual	~AAX_IHostProcessorDelegate ()
virtual AAX_Result	GetAudio (const float *const iAudioIns[], int32_t iAudioInCount, int64_t iLocation, int32_t *ioNumSamples)=0
	CALL: Randomly access audio from the timeline. More...
virtual int32_t	GetSideChainInputNum ()=0
	CALL: Returns the index of the side chain input buffer. More...
virtual AAX_Result	ForceAnalyze ()=0
	CALL: Trigger an analysis pass. More...

Constructor & Destructor Documentation

virtual AAX_IHostProcessorDelegate::~AAX_IHostProcessorDelegate ( )

inlinevirtual

Member Function Documentation

virtual AAX_Result AAX_IHostProcessorDelegate::GetAudio ( const float *const  iAudioIns[], int32_t  iAudioInCount, int64_t  iLocation, int32_t *  ioNumSamples  )

pure virtual

CALL: Randomly access audio from the timeline.

Called from within AAX_IHostProcessor::RenderAudio(), this method fills a buffer of samples with randomly-accessed data from the current input processing region on the timeline, including any extra samples such as processing "handles".

Note

Plug-ins that use this feature must set AAX_eProperty_UsesRandomAccess to true

It is not possible to retrieve samples from outside of the current input processing region

Always check the return value of this method before using the randomly-accessed samples

Parameters

[in]

iAudioIns

Timeline audio buffer(s). This must be set to iAudioIns from AAX_IHostProcessor::RenderAudio()

Parameters

[in]

iAudioInCount

Number of buffers in iAudioIns. This must be set to iAudioInCount from AAX_IHostProcessor::RenderAudio()

Parameters

[in]	iLocation	A sample location relative to the beginning of the currently processed region, e.g. a value of 0 corresponds to the timeline location returned by AAX_CHostProcessor::GetSrcStart()
[in,out]	ioNumSamples	Input: The maximum number of samples to read. Output: The actual number of samples that were read from the timeline

Implemented in AAX_VHostProcessorDelegate.

virtual int32_t AAX_IHostProcessorDelegate::GetSideChainInputNum ( )

pure virtual

CALL: Returns the index of the side chain input buffer.

Called from within AAX_IHostProcessor::RenderAudio(), this method returns the index of the side chain input sample buffer within iAudioIns.

Implemented in AAX_VHostProcessorDelegate.

virtual AAX_Result AAX_IHostProcessorDelegate::ForceAnalyze ( )

pure virtual

CALL: Trigger an analysis pass.

Call this method to trigger an analysis pass from within the plug-in. Most plug-ins should rely on the host to trigger analysis passes when appropriate. However, plug-ins that require an analysis pass a) outside of the context of host-driven render or analysis, or b) when internal plug-in data changes may need to call ForceAnalyze().

Implemented in AAX_VHostProcessorDelegate.

---

The documentation for this class was generated from the following file:

• AAX_IHostProcessorDelegate.h