Audacity 3.2.0
Public Types | Public Member Functions | List of all members
ImportFileHandle Class Referenceabstract

Base class for FlacImportFileHandle, LOFImportFileHandle, MP3ImportFileHandle, OggImportFileHandle and PCMImportFileHandle. Gives API for sound file import. More...

#include <ImportPlugin.h>

Inheritance diagram for ImportFileHandle:
[legend]

Public Types

using ByteCount = unsigned long long
 

Public Member Functions

virtual ~ImportFileHandle ()
 
virtual FilePath GetFilename () const =0
 
virtual TranslatableString GetErrorMessage () const
 
virtual TranslatableString GetFileDescription ()=0
 
virtual ByteCount GetFileUncompressedBytes ()=0
 
virtual wxInt32 GetStreamCount ()=0
 
virtual const TranslatableStringsGetStreamInfo ()=0
 
virtual void SetStreamUsage (wxInt32 StreamID, bool Use)=0
 
virtual void Import (ImportProgressListener &progressListener, WaveTrackFactory *trackFactory, TrackHolders &outTracks, Tags *tags, std::optional< LibFileFormats::AcidizerTags > &acidTags)=0
 
virtual void Cancel ()=0
 
virtual void Stop ()=0
 

Detailed Description

Base class for FlacImportFileHandle, LOFImportFileHandle, MP3ImportFileHandle, OggImportFileHandle and PCMImportFileHandle. Gives API for sound file import.

An ImportFileHandle for data.

The Ogg format supports multiple logical bitstreams that can be chained within the physical bitstream. The sampling rate and number of channels can vary between these logical bitstreams. For the moment, we'll ignore all but the first logical bitstream.

Ogg also allows for an arbitrary number of channels. Luckily, so does Audacity. We'll call the first channel LeftChannel, the second RightChannel, and all others after it MonoChannel.

Definition at line 110 of file ImportPlugin.h.

Member Typedef Documentation

◆ ByteCount

using ImportFileHandle::ByteCount = unsigned long long

Definition at line 114 of file ImportPlugin.h.

Constructor & Destructor Documentation

◆ ~ImportFileHandle()

ImportFileHandle::~ImportFileHandle ( )
virtualdefault

Member Function Documentation

◆ Cancel()

virtual void ImportFileHandle::Cancel ( )
pure virtual

◆ GetErrorMessage()

TranslatableString ImportFileHandle::GetErrorMessage ( ) const
virtual

Reimplemented in AUPImportFileHandle.

Definition at line 79 of file ImportPlugin.cpp.

80{
81 return {};
82}

◆ GetFileDescription()

virtual TranslatableString ImportFileHandle::GetFileDescription ( )
pure virtual

◆ GetFilename()

virtual FilePath ImportFileHandle::GetFilename ( ) const
pure virtual

◆ GetFileUncompressedBytes()

virtual ByteCount ImportFileHandle::GetFileUncompressedBytes ( )
pure virtual

◆ GetStreamCount()

virtual wxInt32 ImportFileHandle::GetStreamCount ( )
pure virtual

◆ GetStreamInfo()

virtual const TranslatableStrings & ImportFileHandle::GetStreamInfo ( )
pure virtual

◆ Import()

virtual void ImportFileHandle::Import ( ImportProgressListener progressListener,
WaveTrackFactory trackFactory,
TrackHolders outTracks,
Tags tags,
std::optional< LibFileFormats::AcidizerTags > &  acidTags 
)
pure virtual

◆ SetStreamUsage()

virtual void ImportFileHandle::SetStreamUsage ( wxInt32  StreamID,
bool  Use 
)
pure virtual

◆ Stop()

virtual void ImportFileHandle::Stop ( )
pure virtual

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