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

#include <AAX_IACFHostProcessor.h>

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

Description

Supplemental interface for an AAX host processing component.

Note
This interface gets exposed to the host application. See AAX_CHostProcessor for method documentation.

Public Member Functions

virtual AAX_Result GetClipNameSuffix (int32_t inMaxLength, AAX_IString *outString) const =0
 Called by host application to retrieve a custom string to be appended to the clip name. More...
 
- Public Member Functions inherited from AAX_IACFHostProcessor
virtual AAX_Result Initialize (IACFUnknown *iController)=0
 Host Processor initialization. More...
 
virtual AAX_Result Uninitialize ()=0
 Host Processor teardown. More...
 
virtual AAX_Result InitOutputBounds (int64_t iSrcStart, int64_t iSrcEnd, int64_t *oDstStart, int64_t *oDstEnd)=0
 Sets the processing region. More...
 
virtual AAX_Result SetLocation (int64_t iSample)=0
 Updates the relative sample location of the current processing frame. More...
 
virtual AAX_Result RenderAudio (const float *const inAudioIns[], int32_t inAudioInCount, float *const iAudioOuts[], int32_t iAudioOutCount, int32_t *ioWindowSize)=0
 Perform the signal processing. More...
 
virtual AAX_Result PreRender (int32_t inAudioInCount, int32_t iAudioOutCount, int32_t iWindowSize)=0
 Invoked right before the start of a Preview or Render pass. More...
 
virtual AAX_Result PostRender ()=0
 Invoked at the end of a Render pass. More...
 
virtual AAX_Result AnalyzeAudio (const float *const inAudioIns[], int32_t inAudioInCount, int32_t *ioWindowSize)=0
 Override this method if the plug-in needs to analyze the audio prior to a Render pass. More...
 
virtual AAX_Result PreAnalyze (int32_t inAudioInCount, int32_t iWindowSize)=0
 Invoked right before the start of an Analysis pass. More...
 
virtual AAX_Result PostAnalyze ()=0
 Invoked at the end of an Analysis pass. More...
 
- Public Member Functions inherited from IACFUnknown
virtual BEGIN_ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE QueryInterface (const acfIID &iid, void **ppOut)=0
 Returns pointers to supported interfaces. More...
 
virtual acfUInt32 ACFMETHODCALLTYPE AddRef (void)=0
 Increments reference count. More...
 
virtual acfUInt32 ACFMETHODCALLTYPE Release (void)=0
 Decrements reference count. More...
 

Member Function Documentation

◆ GetClipNameSuffix()

virtual AAX_Result AAX_IACFHostProcessor_V2::GetClipNameSuffix ( int32_t  inMaxLength,
AAX_IString outString 
) const
pure virtual

Called by host application to retrieve a custom string to be appended to the clip name.

If no string is provided then the host's default will be used.

Parameters
[in]inMaxLengthThe maximum allowed string length, not including the NULL terminating char
[out]outStringAdd a value to this string to provide a custom clip suffix

Implemented in AAX_CHostProcessor.


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