Interface for the AAX host's view of a single instance of an effect. Used by both clients of the AAXHost and by effect components.
|
virtual AAX_Result | GetEffectID (AAX_IString *outEffectID) const =0 |
|
virtual AAX_Result | GetSampleRate (AAX_CSampleRate *outSampleRate) const =0 |
| CALL: Returns the current literal sample rate. More...
|
|
virtual AAX_Result | GetInputStemFormat (AAX_EStemFormat *outStemFormat) const =0 |
| CALL: Returns the plug-in's input stem format. More...
|
|
virtual AAX_Result | GetOutputStemFormat (AAX_EStemFormat *outStemFormat) const =0 |
| CALL: Returns the plug-in's output stem format. More...
|
|
virtual AAX_Result | GetSignalLatency (int32_t *outSamples) const =0 |
| CALL: Returns the most recent signal (algorithmic) latency that has been published by the plug-in. More...
|
|
virtual AAX_Result | GetCycleCount (AAX_EProperty inWhichCycleCount, AAX_CPropertyValue *outNumCycles) const =0 |
| CALL: returns the plug-in's current real-time DSP cycle count. More...
|
|
virtual AAX_Result | GetTODLocation (AAX_CTimeOfDay *outTODLocation) const =0 |
| CALL: Returns the current Time Of Day (TOD) of the system. More...
|
|
virtual AAX_Result | SetSignalLatency (int32_t inNumSamples)=0 |
| CALL: Submits a request to change the delay compensation value that the host uses to account for the plug-in's signal (algorithmic) latency. More...
|
|
virtual AAX_Result | SetCycleCount (AAX_EProperty *inWhichCycleCounts, AAX_CPropertyValue *iValues, int32_t numValues)=0 |
| CALL: Indicates a change in the plug-in's real-time DSP cycle count. More...
|
|
virtual AAX_Result | PostPacket (AAX_CFieldIndex inFieldIndex, const void *inPayloadP, uint32_t inPayloadSize)=0 |
| CALL: Posts a data packet to the host for routing between plug-in components. More...
|
|
virtual AAX_Result | GetCurrentMeterValue (AAX_CTypeID inMeterID, float *outMeterValue) const =0 |
| CALL: Retrieves the current value of a host-managed plug-in meter. More...
|
|
virtual AAX_Result | GetMeterPeakValue (AAX_CTypeID inMeterID, float *outMeterPeakValue) const =0 |
| CALL: Retrieves the currently held peak value of a host-managed plug-in meter. More...
|
|
virtual AAX_Result | ClearMeterPeakValue (AAX_CTypeID inMeterID) const =0 |
| CALL: Clears the peak value from a host-managed plug-in meter. More...
|
|
virtual AAX_Result | GetMeterClipped (AAX_CTypeID inMeterID, AAX_CBoolean *outClipped) const =0 |
| CALL: Retrieves the clipped flag from a host-managed plug-in meter. More...
|
|
virtual AAX_Result | ClearMeterClipped (AAX_CTypeID inMeterID) const =0 |
| CALL: Clears the clipped flag from a host-managed plug-in meter. More...
|
|
virtual AAX_Result | GetMeterCount (uint32_t *outMeterCount) const =0 |
| CALL: Retrieves the number of host-managed meters registered by a plug-in. More...
|
|
virtual AAX_Result | GetNextMIDIPacket (AAX_CFieldIndex *outPort, AAX_CMidiPacket *outPacket)=0 |
| CALL: Retrieves MIDI packets for described MIDI nodes. More...
|
|
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...
|
|
virtual AAX_Result AAX_IACFController::SetSignalLatency |
( |
int32_t |
inNumSamples | ) |
|
|
pure virtual |
CALL: Submits a request to change the delay compensation value that the host uses to account for the plug-in's signal (algorithmic) latency.
This method is used to request a change in the number of samples that the AAX host expects the plug-in to delay a signal.
The host is not guaranteed to immediately apply the new latency value. A plug-in should avoid incurring an actual algorithmic latency that is different than the latency accounted for by the host.
To set a new latency value, a plug-in must call AAX_IController::SetSignalLatency(), then wait for an AAX_eNotificationEvent_SignalLatencyChanged notification. Once this notification has been received, AAX_IController::GetSignalLatency() will reflect the updated latency value and the plug-in should immediately apply any relevant algorithmic changes that alter its latency to this new value.
- Warning
- Parameters which affect the latency of a plug-in should not be made available for control through automation. This will result in audible glitches when delay compensation is adjusted while playing back automation for these parameters.
- Parameters
-
[in] | inNumSamples | The number of samples of signal delay that the plug-in requests to incur |