LMMS
Loading...
Searching...
No Matches
Steinberg::Vst::IPrefetchableSupport Class Referenceabstract

#include <ivstprefetchablesupport.h>

Inheritance diagram for Steinberg::Vst::IPrefetchableSupport:
Steinberg::FUnknown

Public Member Functions

virtual tresult PLUGIN_API getPrefetchableSupport (PrefetchableSupport &prefetchable)=0
Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API queryInterface (const TUID _iid, void **obj)=0
virtual uint32 PLUGIN_API addRef ()=0
virtual uint32 PLUGIN_API release ()=0

Static Public Attributes

static const FUID iid
Static Public Attributes inherited from Steinberg::FUnknown
static const FUID iid

Detailed Description

Indicates that the plug-in could or not support Prefetch (dynamically): Vst::IPrefetchableSupport

  • [plug imp]
  • [extends IComponent]
  • [released: 3.6.5]
  • [optional]

The plug-in should implement this interface if it needs to dynamically change between prefetchable or not. By default (without implementing this interface) the host decides in which mode the plug-in is processed. For more info about the prefetch processing mode check the ProcessModes::kPrefetch documentation.

Example

//------------------------------------------------------------------------
tresult PLUGIN_API myPlug::getPrefetchableSupport (PrefetchableSupport& prefetchable)
{
prefetchable = kIsNeverPrefetchable;
switch (myPrefetchableMode)
{
case 0: prefetchable = kIsNeverPrefetchable; break;
case 1: prefetchable = kIsYetPrefetchable; break;
case 2: prefetchable = kIsNotYetPrefetchable; break;
}
return kResultOk;
}
@ kIsNotYetPrefetchable
in the current state the plug does not support prefetch processing
Definition ivstprefetchablesupport.h:43
@ kIsNeverPrefetchable
every instance of the plug does not support prefetch processing
Definition ivstprefetchablesupport.h:41
@ kIsYetPrefetchable
in the current state the plug support prefetch processing
Definition ivstprefetchablesupport.h:42
uint32 PrefetchableSupport
Definition ivstprefetchablesupport.h:35
@ kResultOk
Definition funknown.h:193
int32 tresult
Definition ftypes.h:76

Member Function Documentation

◆ getPrefetchableSupport()

virtual tresult PLUGIN_API Steinberg::Vst::IPrefetchableSupport::getPrefetchableSupport ( PrefetchableSupport & prefetchable)
pure virtual

retrieve the current prefetch support. Use IComponentHandler::restartComponent (kPrefetchableSupportChanged) to inform the host that this support has changed.

Member Data Documentation

◆ iid

const FUID Steinberg::Vst::IPrefetchableSupport::iid
static

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