ImportPlugin Class Reference

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

#include <ImportPlugin.h>

Inheritance diagram for ImportPlugin:

Collaboration diagram for ImportPlugin:

Public Member Functions
virtual wxString	GetPluginStringID ()=0
virtual TranslatableString	GetPluginFormatDescription ()=0
virtual FileExtensions	GetSupportedExtensions ()
virtual TranslatableString	FailureHint () const
	User visible message suggesting what to do when a file type isn't recognized; default empty string. More...
bool	SupportsExtension (const FileExtension &extension)
virtual std::unique_ptr< ImportFileHandle >	Open (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 15 of file ImportPlugin.cpp.

                                                            :
   mExtensions( std::move( supportedExtensions ) )
{
}

Member Function Documentation

FailureHint()

TranslatableString ImportPlugin::FailureHint ( ) const

virtual

User visible message suggesting what to do when a file type isn't recognized; default empty string.

Should end with one newline if not empty

Reimplemented in FFmpegImportPlugin.

Definition at line 33 of file ImportPlugin.cpp.

{
   return {};
}

GetPluginFormatDescription()

virtual TranslatableString ImportPlugin::GetPluginFormatDescription ( )

pure virtual

Implemented in AUPImportPlugin, FFmpegImportPlugin, FLACImportPlugin, LOFImportPlugin, anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportPlugin, OggImportPlugin, OpusImportPlugin, PCMImportPlugin, WavPackImportPlugin, and anonymous_namespace{ImportMIDI.cpp}::MIDIImportPlugin.

GetPluginStringID()

virtual wxString ImportPlugin::GetPluginStringID ( )

pure virtual

Implemented in AUPImportPlugin, FFmpegImportPlugin, FLACImportPlugin, LOFImportPlugin, anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportPlugin, OggImportPlugin, OpusImportPlugin, PCMImportPlugin, WavPackImportPlugin, and anonymous_namespace{ImportMIDI.cpp}::MIDIImportPlugin.

GetSupportedExtensions()

FileExtensions ImportPlugin::GetSupportedExtensions ( )

virtual

Definition at line 22 of file ImportPlugin.cpp.

{
   return mExtensions;
}

References mExtensions.

Open()

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

pure virtual

Implemented in FFmpegImportPlugin, FLACImportPlugin, anonymous_namespace{ImportMP3_MPG123.cpp}::MP3ImportPlugin, OggImportPlugin, OpusImportPlugin, PCMImportPlugin, WavPackImportPlugin, LOFImportPlugin, AUPImportPlugin, and anonymous_namespace{ImportMIDI.cpp}::MIDIImportPlugin.

SupportsExtension()

bool ImportPlugin::SupportsExtension

(

const FileExtension &

extension

)

Definition at line 27 of file ImportPlugin.cpp.

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

References anonymous_namespace{CloudProjectFileIOExtensions.cpp}::extension, and mExtensions.

Referenced by FFmpegImportPlugin::Open().

Here is the caller graph for this function:

Member Data Documentation

mExtensions

const FileExtensions ImportPlugin::mExtensions

protected

Definition at line 103 of file ImportPlugin.h.

Referenced by GetSupportedExtensions(), and SupportsExtension().

---

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

• ImportPlugin.h
• ImportPlugin.cpp