Steinberg::Vst::IInterAppAudioHost Class Reference

Inter-App Audio host Interface. More...

#include "ivstinterappaudio.h"

Inheritance diagram for Steinberg::Vst::IInterAppAudioHost:

Public Member Functions
virtual tresult PLUGIN_API	getScreenSize (ViewRect *size, float *scale)=0
	get the size of the screen
virtual tresult PLUGIN_API	connectedToHost ()=0
	get status of connection
virtual tresult PLUGIN_API	switchToHost ()=0
	switch to the host.
virtual tresult PLUGIN_API	sendRemoteControlEvent (uint32 event)=0
	send a remote control event to the host
virtual tresult PLUGIN_API	getHostIcon (void **icon)=0
	ask for the host icon.
virtual tresult PLUGIN_API	scheduleEventFromUI (Event &event)=0
	schedule an event from the user interface thread
virtual IInterAppAudioPresetManager *PLUGIN_API	createPresetManager (const TUID &cid)=0
	get the preset manager
virtual tresult PLUGIN_API	showSettingsView ()=0
	show the settings view currently includes MIDI settings and Tempo setting
Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj)=0
	Query for a pointer to the specified interface.
virtual uint32 PLUGIN_API	addRef ()=0
	Adds a reference and returns the new reference count.
virtual uint32 PLUGIN_API	release ()=0
	Releases a reference and returns the new reference count.

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

Detailed Description

Inter-App Audio host Interface.

• [host imp]
• [passed as 'context' to IPluginBase::initialize () ]
• [released: 3.6.0]
• [optional]

Implemented by the InterAppAudio Wrapper.

Definition at line 38 of file ivstinterappaudio.h.

Member Function Documentation

connectedToHost()

virtual tresult PLUGIN_API Steinberg::Vst::IInterAppAudioHost::connectedToHost ( )

pure virtual

get status of connection

Returns

kResultTrue if an Inter-App Audio connection is established

createPresetManager()

virtual IInterAppAudioPresetManager *PLUGIN_API Steinberg::Vst::IInterAppAudioHost::createPresetManager ( const TUID &  cid )

pure virtual

get the preset manager

Parameters

cid	class ID to use by the preset manager

Returns

the preset manager. Needs to be released by called.

getHostIcon()

virtual tresult PLUGIN_API Steinberg::Vst::IInterAppAudioHost::getHostIcon ( void **  icon )

pure virtual

ask for the host icon.

Parameters

icon	pointer to a CGImageRef

Returns

kResultTrue on success

getScreenSize()

virtual tresult PLUGIN_API Steinberg::Vst::IInterAppAudioHost::getScreenSize ( ViewRect *  size, float *  scale  )

pure virtual

get the size of the screen

Parameters

size	size of the screen
scale	scale of the screen

Returns

kResultTrue on success

scheduleEventFromUI()

virtual tresult PLUGIN_API Steinberg::Vst::IInterAppAudioHost::scheduleEventFromUI ( Event &  event )

pure virtual

schedule an event from the user interface thread

Parameters

event

the event to schedule

Returns

kResultTrue on success

sendRemoteControlEvent()

virtual tresult PLUGIN_API Steinberg::Vst::IInterAppAudioHost::sendRemoteControlEvent ( uint32  event )

pure virtual

send a remote control event to the host

Parameters

event

event type, see AudioUnitRemoteControlEvent in the iOS SDK documentation for possible types

Returns

kResultTrue on success

showSettingsView()

virtual tresult PLUGIN_API Steinberg::Vst::IInterAppAudioHost::showSettingsView ( )

pure virtual

show the settings view currently includes MIDI settings and Tempo setting

Returns

kResultTrue on success

switchToHost()

virtual tresult PLUGIN_API Steinberg::Vst::IInterAppAudioHost::switchToHost ( )

pure virtual

switch to the host.

Returns

kResultTrue on success

Member Data Documentation

iid

const FUID Steinberg::Vst::IInterAppAudioHost::iid

static

Definition at line 89 of file ivstinterappaudio.h.

---

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

• juce_audio_processors/format_types/VST3_SDK/pluginterfaces/vst/ivstinterappaudio.h