AAX SDK  2.4.1
Avid Audio Extensions Development Kit
List of all members | Public Member Functions
AAX_VHostProcessorDelegate Class Reference

#include <AAX_VHostProcessorDelegate.h>

Inheritance diagram for AAX_VHostProcessorDelegate:
[legend]
Collaboration diagram for AAX_VHostProcessorDelegate:
[legend]

Description

Version-managed concrete Host Processor delegate class.

Public Member Functions

 AAX_VHostProcessorDelegate (IACFUnknown *pUnknown)
 
AAX_Result GetAudio (const float *const inAudioIns[], int32_t inAudioInCount, int64_t inLocation, int32_t *ioNumSamples) AAX_OVERRIDE
 CALL: Randomly access audio from the timeline. More...
 
int32_t GetSideChainInputNum () AAX_OVERRIDE
 CALL: Returns the index of the side chain input buffer. More...
 
AAX_Result ForceAnalyze () AAX_OVERRIDE
 CALL: Request an analysis pass. More...
 
AAX_Result ForceProcess () AAX_OVERRIDE
 CALL: Request a process pass. More...
 
- Public Member Functions inherited from AAX_IHostProcessorDelegate
virtual ~AAX_IHostProcessorDelegate ()
 

Constructor & Destructor Documentation

◆ AAX_VHostProcessorDelegate()

AAX_VHostProcessorDelegate::AAX_VHostProcessorDelegate ( IACFUnknown pUnknown)

Member Function Documentation

◆ GetAudio()

AAX_Result AAX_VHostProcessorDelegate::GetAudio ( const float *const  inAudioIns[],
int32_t  inAudioInCount,
int64_t  inLocation,
int32_t *  ioNumSamples 
)
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]inAudioInsTimeline audio buffer(s). This must be set to inAudioIns from AAX_IHostProcessor::RenderAudio()
[in]inAudioInCountNumber of buffers in inAudioIns. This must be set to inAudioInCount from AAX_IHostProcessor::RenderAudio()
[in]inLocationA 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

Implements AAX_IHostProcessorDelegate.

◆ GetSideChainInputNum()

int32_t AAX_VHostProcessorDelegate::GetSideChainInputNum ( )
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 inAudioIns.

Implements AAX_IHostProcessorDelegate.

◆ ForceAnalyze()

AAX_Result AAX_VHostProcessorDelegate::ForceAnalyze ( )
virtual

CALL: Request an analysis pass.

Call this method to request 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().

Implements AAX_IHostProcessorDelegate.

◆ ForceProcess()

AAX_Result AAX_VHostProcessorDelegate::ForceProcess ( )
virtual

CALL: Request a process pass.

Call this method to request a process pass from within the plug-in. If AAX_eProperty_RequiresAnalysis is defined, the resulting process pass will be preceded by an analysis pass. This method should only be used in rare circumstances by plug-ins that must launch processing outside of the normal host AudioSuite workflow.

Implements AAX_IHostProcessorDelegate.


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