Audacity  3.0.3
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:
[legend]
Collaboration diagram for ImportPlugin:
[legend]

Public Member Functions

virtual wxString GetPluginStringID ()=0
 
virtual TranslatableString GetPluginFormatDescription ()=0
 
virtual FileExtensions GetSupportedExtensions ()
 
bool SupportsExtension (const FileExtension &extension)
 
virtual std::unique_ptr< ImportFileHandleOpen (const FilePath &Filename, AudacityProject *)=0
 
virtual ~ImportPlugin ()
 

Protected Member Functions

 ImportPlugin (FileExtensions supportedExtensions)
 

Protected Attributes

const FileExtensions mExtensions
 

Detailed Description

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

Definition at line 66 of file ImportPlugin.h.

Constructor & Destructor Documentation

◆ ~ImportPlugin()

ImportPlugin::~ImportPlugin ( )
virtualdefault

◆ ImportPlugin()

ImportPlugin::ImportPlugin ( FileExtensions  supportedExtensions)
protected

Definition at line 18 of file ImportPlugin.cpp.

18  :
19  mExtensions( std::move( supportedExtensions ) )
20 {
21 }

Member Function Documentation

◆ GetPluginFormatDescription()

virtual TranslatableString ImportPlugin::GetPluginFormatDescription ( )
pure virtual

◆ GetPluginStringID()

virtual wxString ImportPlugin::GetPluginStringID ( )
pure virtual

◆ GetSupportedExtensions()

FileExtensions ImportPlugin::GetSupportedExtensions ( )
virtual

Reimplemented in GStreamerImportPlugin.

Definition at line 25 of file ImportPlugin.cpp.

26 {
27  return mExtensions;
28 }

References mExtensions.

◆ Open()

virtual std::unique_ptr<ImportFileHandle> ImportPlugin::Open ( const FilePath Filename,
AudacityProject  
)
pure virtual

◆ SupportsExtension()

bool ImportPlugin::SupportsExtension ( const FileExtension extension)

Definition at line 30 of file ImportPlugin.cpp.

31 {
32  // Case-insensitive check if extension is supported
33  return mExtensions.Index(extension, false) != wxNOT_FOUND;
34 }

References mExtensions.

Referenced by FFmpegImportPlugin::Open().

Here is the caller graph for this function:

Member Data Documentation

◆ mExtensions

const FileExtensions ImportPlugin::mExtensions
protected

The documentation for this class was generated from the following files:
ImportPlugin::mExtensions
const FileExtensions mExtensions
Definition: ImportPlugin.h:99