juce::ARAHostModel::PlugInExtensionInstance Class Reference

Wrapper class for ARA::ARAPlugInExtensionInstance*. More...

Collaboration diagram for juce::ARAHostModel::PlugInExtensionInstance:

Public Member Functions
	PlugInExtensionInstance ()=default
	Creates an empty PlugInExtensionInstance object.
	PlugInExtensionInstance (const ARA::ARAPlugInExtensionInstance *instanceIn)
	Creates a PlugInExtensionInstance object that wraps a const ARA::ARAPlugInExtensionInstance*.
EditorRendererInterface	getEditorRendererInterface () const
	Returns the EditorRendererInterface for the extension instance.
PlaybackRendererInterface	getPlaybackRendererInterface () const
	Returns the PlaybackRendererInterface for the extension instance.
bool	isValid () const noexcept
	Returns false if the PlugInExtensionInstance was default constructed and represents no binding to an ARAHostDocumentController.

Private Attributes
const ARA::ARAPlugInExtensionInstance *	instance = nullptr

Detailed Description

Wrapper class for ARA::ARAPlugInExtensionInstance*.

Returned by ARAHostDocumentController::bindDocumentToPluginInstance(). The corresponding ARAHostDocumentController must remain valid as long as the plugin extension is in use.

@tags{ARA}

Constructor & Destructor Documentation

PlugInExtensionInstance() [1/2]

juce::ARAHostModel::PlugInExtensionInstance::PlugInExtensionInstance ( )

default

Creates an empty PlugInExtensionInstance object.

Calling isValid() on such an object will return false.

PlugInExtensionInstance() [2/2]

juce::ARAHostModel::PlugInExtensionInstance::PlugInExtensionInstance ( const ARA::ARAPlugInExtensionInstance *  instanceIn )

inlineexplicit

Creates a PlugInExtensionInstance object that wraps a const ARA::ARAPlugInExtensionInstance*.

The intended way to obtain a PlugInExtensionInstance object is to call ARAHostDocumentController::bindDocumentToPluginInstance(), which is using this constructor.

Member Function Documentation

getEditorRendererInterface()

EditorRendererInterface juce::ARAHostModel::PlugInExtensionInstance::getEditorRendererInterface

(

)

const

Returns the EditorRendererInterface for the extension instance.

Depending on what roles were passed into ARAHostDocumentController::bindDocumentToPluginInstance() one particular instance may not fulfill a given role. You can use EditorRendererInterface::isValid() to see if this interface was provided by the instance.

getPlaybackRendererInterface()

PlaybackRendererInterface juce::ARAHostModel::PlugInExtensionInstance::getPlaybackRendererInterface

(

)

const

Returns the PlaybackRendererInterface for the extension instance.

Depending on what roles were passed into ARAHostDocumentController::bindDocumentToPluginInstance() one particular instance may not fulfill a given role. You can use PlaybackRendererInterface::isValid() to see if this interface was provided by the instance.

isValid()

bool juce::ARAHostModel::PlugInExtensionInstance::isValid ( ) const

inlinenoexcept

Returns false if the PlugInExtensionInstance was default constructed and represents no binding to an ARAHostDocumentController.

Member Data Documentation

instance

const ARA::ARAPlugInExtensionInstance* juce::ARAHostModel::PlugInExtensionInstance::instance = nullptr

private

---

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

• juce_ARAHosting.h