Host to Plug-in support checks. More...

#include <vst.h>

Data Fields
const char *	bypass
	Effect supports alternative bypass.

const char *	sendVstEvents
	Plug-in can send events to host.

const char *	receiveVstEvents
	Plug-in can receive events from host.

const char *	sendVstMidiEvent
	Host can send MIDI events to plug-in.

const char *	receiveVstMidiEvent
	Plug-in can receive MIDI events from host.

const char *	conformsToWindowRules
	Plug-in wants to use VST_HOST_OPCODE_EDITOR_RESIZE.

const char *	midiProgramNames

const char *	receiveVstTimeInfo

const char *	offline

const char *	plugAsChannelInsert

const char *	plugAsSend

const char *	mixDryWet

const char *	noRealTime

const char *	multipass

const char *	metapass

const char *	_1in1out

const char *	_1in2out

const char *	_2in1out

const char *	_2in2out

const char *	_2in4out

const char *	_4in2out

const char *	_4in4out

const char *	_4in8out

const char *	_8in4out

const char *	_8in8out

Detailed Description

Host to Plug-in support checks.

Provided as char* p_ptr in the VST_EFFECT_OPCODE_SUPPORTS op code.

Harvested via strings command and just checking what plug-ins actually responded to.

@important These are only available with a C99 or a C++20 or newer compiler.

Definition at line 2782 of file vst.h.

Field Documentation

◆ _1in1out

const char* vst_effect_supports_t::_1in1out

Definition at line 2849 of file vst.h.

◆ _1in2out

const char* vst_effect_supports_t::_1in2out

Definition at line 2850 of file vst.h.

◆ _2in1out

const char* vst_effect_supports_t::_2in1out

Definition at line 2851 of file vst.h.

◆ _2in2out

const char* vst_effect_supports_t::_2in2out

Definition at line 2852 of file vst.h.

◆ _2in4out

const char* vst_effect_supports_t::_2in4out

Definition at line 2853 of file vst.h.

◆ _4in2out

const char* vst_effect_supports_t::_4in2out

Definition at line 2854 of file vst.h.

◆ _4in4out

const char* vst_effect_supports_t::_4in4out

Definition at line 2855 of file vst.h.

◆ _4in8out

const char* vst_effect_supports_t::_4in8out

Definition at line 2856 of file vst.h.

◆ _8in4out

const char* vst_effect_supports_t::_8in4out

Definition at line 2857 of file vst.h.

◆ _8in8out

const char* vst_effect_supports_t::_8in8out

Definition at line 2858 of file vst.h.

◆ bypass

const char* vst_effect_supports_t::bypass

Effect supports alternative bypass.

The alternative bypass still has the host call process/process_float/process_double and expects us to compensate for our delay/latency, copy inputs to outputs, and do minimal work. If we don't support it the host will not call process/process_float/process_double at all while bypass is enabled.

Note: VST 2.3 or later only.

Returns: VST_STATUS_TRUE if we support this, otherwise VST_STATUS_FALSE.

Definition at line 2791 of file vst.h.

◆ conformsToWindowRules

const char* vst_effect_supports_t::conformsToWindowRules

Plug-in wants to use VST_HOST_OPCODE_EDITOR_RESIZE.

Only necessary for legacy host compatibility.

See also: vst_host_supports_t.sizeWindow

Note: (VST 2.1+) Available from VST 2.1 onwards.

Deprecated:: (VST 2.4+) Deprecated from VST 2.4 onwards as the same check already exists on the host side.

Returns: VST_STATUS_TRUE if you want to use VST_HOST_OPCODE_EDITOR_RESIZE, otherwise VST_STATUS_FALSE.

Definition at line 2837 of file vst.h.

◆ metapass

const char* vst_effect_supports_t::metapass

Definition at line 2848 of file vst.h.

◆ midiProgramNames

const char* vst_effect_supports_t::midiProgramNames

Definition at line 2839 of file vst.h.

◆ mixDryWet

const char* vst_effect_supports_t::mixDryWet

Definition at line 2845 of file vst.h.

◆ multipass

const char* vst_effect_supports_t::multipass

Definition at line 2847 of file vst.h.

◆ noRealTime

const char* vst_effect_supports_t::noRealTime

Definition at line 2846 of file vst.h.

◆ offline

const char* vst_effect_supports_t::offline

Definition at line 2841 of file vst.h.

◆ plugAsChannelInsert

const char* vst_effect_supports_t::plugAsChannelInsert

Definition at line 2843 of file vst.h.

◆ plugAsSend

const char* vst_effect_supports_t::plugAsSend

Definition at line 2844 of file vst.h.

◆ receiveVstEvents

const char* vst_effect_supports_t::receiveVstEvents

Plug-in can receive events from host.

See also: vst_host_supports_t.sendVstEvents; VST_EFFECT_OPCODE_EVENT

Note: (VST 2.0+) Available from VST 2.0 onwards.

Definition at line 2807 of file vst.h.

◆ receiveVstMidiEvent

const char* vst_effect_supports_t::receiveVstMidiEvent

Plug-in can receive MIDI events from host.

See also: vst_host_supports_t.sendVstMidiEvents; VST_HOST_OPCODE_EVENT; vst_effect_midi_t; vst_effect_midi_sysex_t

Note: (VST 2.0+) Available from VST 2.0 onwards.

Definition at line 2827 of file vst.h.

◆ receiveVstTimeInfo

const char* vst_effect_supports_t::receiveVstTimeInfo

Definition at line 2840 of file vst.h.

◆ sendVstEvents

const char* vst_effect_supports_t::sendVstEvents

Plug-in can send events to host.

See also: vst_host_supports_t.receiveVstEvents; VST_HOST_OPCODE_EVENT

Note: (VST 2.0+) Available from VST 2.0 onwards.

Definition at line 2799 of file vst.h.

◆ sendVstMidiEvent

const char* vst_effect_supports_t::sendVstMidiEvent

Host can send MIDI events to plug-in.

See also: vst_effect_supports_t.receiveVstMidiEvents; VST_EFFECT_OPCODE_EVENT; vst_effect_midi_t; vst_effect_midi_sysex_t

Note: (VST 2.0+) Available from VST 2.0 onwards.

Definition at line 2817 of file vst.h.

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

include/vst.h

Data Fields