Audacity 3.2.0
Public Member Functions | List of all members
cloud::CloudExporterPlugin Class Referenceabstract

Helper interface, that allows to setup the desired export format on the ExportPlugin. More...

#include <CloudExporterPlugin.h>

Public Member Functions

virtual ~CloudExporterPlugin () noexcept
 
virtual wxString GetExporterID () const =0
 Identifier of the ExportPlugin to be used. More...
 
virtual FileExtension GetFileExtension () const =0
 File extension that is expected with this plugin. More...
 
virtual void OnBeforeExport ()=0
 Setup the preferred format for the export. More...
 
virtual void OnAfterExport ()
 Cleanup after the exporting is done, if needed. More...
 

Detailed Description

Helper interface, that allows to setup the desired export format on the ExportPlugin.

Audacity exporting framework relies heavily on using the global state. This interface attempts to overcome this problem by allowing to setup the desired export format on the ExportPlugin before exporting.

It is expected, that exporting happens inside a SettingScope, however a plugin may perform additional clean ups after exporting.

Definition at line 28 of file CloudExporterPlugin.h.

Constructor & Destructor Documentation

◆ ~CloudExporterPlugin()

cloud::CloudExporterPlugin::~CloudExporterPlugin ( )
virtualnoexcept

Definition at line 18 of file CloudExporterPlugin.cpp.

19{
20}

Member Function Documentation

◆ GetExporterID()

virtual wxString cloud::CloudExporterPlugin::GetExporterID ( ) const
pure virtual

Identifier of the ExportPlugin to be used.

◆ GetFileExtension()

virtual FileExtension cloud::CloudExporterPlugin::GetFileExtension ( ) const
pure virtual

File extension that is expected with this plugin.

◆ OnAfterExport()

void cloud::CloudExporterPlugin::OnAfterExport ( )
virtual

Cleanup after the exporting is done, if needed.

Definition at line 21 of file CloudExporterPlugin.cpp.

22{
23}

◆ OnBeforeExport()

virtual void cloud::CloudExporterPlugin::OnBeforeExport ( )
pure virtual

Setup the preferred format for the export.


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