pulp::format::AraDocumentController Class Reference

ARA document controller — manages the plugin's view of the DAW's audio content. More...

#include <ara.hpp>

Public Member Functions
virtual	~AraDocumentController ()=default
virtual void	begin_editing ()
	Called when the host creates a new document.
virtual void	end_editing ()
	Called when the host finishes editing the document.
virtual void	notify_audio_source_content_changed (int64_t audio_source_id)
	Called when audio source data is available.
virtual int	supported_roles () const
	Get the supported ARA roles for this plugin.
virtual bool	is_ara_supported () const
	Whether this plugin supports ARA.
virtual std::string	ara_factory_name () const
	ARA factory name (displayed in the DAW).

Detailed Description

ARA document controller — manages the plugin's view of the DAW's audio content.

This is a stub interface. Full implementation requires the ARA SDK.

Constructor & Destructor Documentation

~AraDocumentController()

virtual pulp::format::AraDocumentController::~AraDocumentController ( )

virtualdefault

Member Function Documentation

ara_factory_name()

virtual std::string pulp::format::AraDocumentController::ara_factory_name ( ) const

inlinevirtual

ARA factory name (displayed in the DAW).

begin_editing()

virtual void pulp::format::AraDocumentController::begin_editing ( )

inlinevirtual

Called when the host creates a new document.

end_editing()

virtual void pulp::format::AraDocumentController::end_editing ( )

inlinevirtual

Called when the host finishes editing the document.

is_ara_supported()

virtual bool pulp::format::AraDocumentController::is_ara_supported ( ) const

inlinevirtual

Whether this plugin supports ARA.

notify_audio_source_content_changed()

virtual void pulp::format::AraDocumentController::notify_audio_source_content_changed ( int64_t audio_source_id )

inlinevirtual

Called when audio source data is available.

supported_roles()

virtual int pulp::format::AraDocumentController::supported_roles ( ) const

inlinevirtual

Get the supported ARA roles for this plugin.

---

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

• /home/runner/work/pulp/pulp/core/format/include/pulp/format/ara.hpp