Audacity  2.2.2
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ImportPlugin Class Referenceabstract

Base class for FlacImportPlugin, LOFImportPlugin, MP3ImportPlugin, OggImportPlugin and PCMImportPlugin. Gives API for sound file import. More...

#include <ImportPlugin.h>

Inheritance diagram for ImportPlugin:
LOFImportPlugin PCMImportPlugin

Public Member Functions

virtual wxString GetPluginStringID ()=0
 
virtual wxString GetPluginFormatDescription ()=0
 
virtual wxArrayString GetSupportedExtensions ()
 
bool SupportsExtension (const wxString &extension)
 
virtual std::unique_ptr
< ImportFileHandle
Open (const wxString &Filename)=0
 
virtual ~ImportPlugin ()
 

Protected Member Functions

 ImportPlugin (wxArrayString supportedExtensions)
 

Protected Attributes

wxArrayString mExtensions
 

Detailed Description

Base class for FlacImportPlugin, LOFImportPlugin, MP3ImportPlugin, OggImportPlugin and PCMImportPlugin. Gives API for sound file import.

Definition at line 73 of file ImportPlugin.h.

Constructor & Destructor Documentation

virtual ImportPlugin::~ImportPlugin ( )
inlinevirtual

Definition at line 106 of file ImportPlugin.h.

106 { }
ImportPlugin::ImportPlugin ( wxArrayString  supportedExtensions)
inlineprotected

Definition at line 110 of file ImportPlugin.h.

110  :
111  mExtensions(supportedExtensions)
112  {
113  }
wxArrayString mExtensions
Definition: ImportPlugin.h:115

Member Function Documentation

virtual wxString ImportPlugin::GetPluginFormatDescription ( )
pure virtual

Implemented in LOFImportPlugin, and PCMImportPlugin.

virtual wxString ImportPlugin::GetPluginStringID ( )
pure virtual

Implemented in LOFImportPlugin, and PCMImportPlugin.

Referenced by Importer::Import().

virtual wxArrayString ImportPlugin::GetSupportedExtensions ( )
inlinevirtual

Definition at line 90 of file ImportPlugin.h.

References mExtensions.

91  {
92  return mExtensions;
93  }
wxArrayString mExtensions
Definition: ImportPlugin.h:115
virtual std::unique_ptr<ImportFileHandle> ImportPlugin::Open ( const wxString &  Filename)
pure virtual

Implemented in LOFImportPlugin, and PCMImportPlugin.

bool ImportPlugin::SupportsExtension ( const wxString &  extension)
inline

Definition at line 95 of file ImportPlugin.h.

References mExtensions.

96  {
97  // Case-insensitive check if extension is supported
98  return mExtensions.Index(extension, false) != wxNOT_FOUND;
99  }
wxArrayString mExtensions
Definition: ImportPlugin.h:115

Member Data Documentation

wxArrayString ImportPlugin::mExtensions
protected

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