VST 3 Interfaces  VST 3.6.14
SDK for developing VST Plug-in
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages

Extended IAudioProcessor interface for a component. More...

#include <ivstaudioprocessor.h>

+ Inheritance diagram for IAudioPresentationLatency:

Public Member Functions

virtual tresult setAudioPresentationLatencySamples (BusDirection dir, int32 busIndex, uint32 latencyInSamples)=0
 Informs the Plug-in about the Audio Presentation Latency in samples for a given direction (kInput/kOutput) and bus index. More...
 
- Public Member Functions inherited from FUnknown
virtual tresult queryInterface (const TUID _iid, void **obj)=0
 
virtual uint32 addRef ()=0
 
virtual uint32 release ()=0
 

Static Public Attributes

static const FUID iid
 
- Static Public Attributes inherited from FUnknown
static const FUID iid
 

Detailed Description

Extended IAudioProcessor interface for a component.

Inform the Plug-in about how long from the moment of generation/acquiring (from file or from Input) it will take for its input to arrive, and how long it will take for its output to be presented (to output or to Speaker).

Note for Input Presentation Latency: when reading from file, the first Plug-in will have an input presentation latency set to zero. When monitoring audio input from a Audio Device, then this initial input latency will be the input latency of the Audio Device itself.

Note for Output Presentation Latency: when writing to a file, the last Plug-in will have an output presentation latency set to zero. When the output of this Plug-in is connected to a Audio Device then this initial output latency will be the output latency of the Audio Device itself.

A value of zero means either no latency or an unknown latency.

Each Plug-in adding a latency (returning a none zero value for IAudioProcessor::getLatencySamples) will modify the input presentation latency of the next Plug-ins in the mixer routing graph and will modify the output presentation latency of the previous Plug-ins.


iaudiopresentationlatency_usage.png


See also
IAudioProcessor
IComponent

Member Function Documentation

virtual tresult setAudioPresentationLatencySamples ( BusDirection  dir,
int32  busIndex,
uint32  latencyInSamples 
)
pure virtual

Informs the Plug-in about the Audio Presentation Latency in samples for a given direction (kInput/kOutput) and bus index.

Member Data Documentation

const FUID iid
static
Empty

Copyright ©2019 Steinberg Media Technologies GmbH. All Rights Reserved. This documentation is under this license.