tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications

« « « Anklang Documentation
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | List of all members
tracktion::engine::TracktionArchiveFile Class Reference

Classes

struct  IndexEntry
 

Public Types

enum class  CompressionType {
  none , zip , lossless , lossyGoodQuality ,
  lossyMediumQuality , lossyLowQuality
}
 

Public Member Functions

 TracktionArchiveFile (Engine &, const juce::File &file)
 
bool isValidArchive () const
 
juce::File getFile () const
 
int getNumFiles () const
 
juce::String getOriginalFileName (int index) const
 
int indexOfFile (const juce::String &name) const
 
std::unique_ptr< juce::InputStreamcreateStoredInputStream (int index) const
 Create a stream to read one of the archived objects.
 
bool extractFile (int index, const juce::File &destDirectory, juce::File &fileCreated, bool askBeforeOverwriting)
 
bool extractAll (const juce::File &destDirectory, juce::Array< juce::File > &filesCreated)
 
bool extractAllAsTask (const juce::File &destDirectory, bool warnAboutOverwrite, juce::Array< juce::File > &filesCreated, bool &wasAborted)
 
bool addFile (const juce::File &, const juce::File &rootDirectory, CompressionType)
 
bool addFile (const juce::File &, const juce::String &filenameToUse, CompressionType)
 
void addFileInfo (const juce::String &filename, const juce::String &itemName, const juce::String &itemValue)
 
void flush ()
 

Detailed Description

Definition at line 17 of file tracktion_ArchiveFile.h.

Member Enumeration Documentation

◆ CompressionType

enum class tracktion::engine::TracktionArchiveFile::CompressionType
strong

Definition at line 26 of file tracktion_ArchiveFile.h.

Constructor & Destructor Documentation

◆ TracktionArchiveFile()

tracktion::engine::TracktionArchiveFile::TracktionArchiveFile ( Engine e,
const juce::File file 
)

Definition at line 66 of file tracktion_ArchiveFile.cpp.

◆ ~TracktionArchiveFile()

tracktion::engine::TracktionArchiveFile::~TracktionArchiveFile ( )

Definition at line 72 of file tracktion_ArchiveFile.cpp.

Member Function Documentation

◆ addFile() [1/2]

bool tracktion::engine::TracktionArchiveFile::addFile ( const juce::File f,
const juce::File rootDirectory,
CompressionType  compression 
)

Definition at line 336 of file tracktion_ArchiveFile.cpp.

◆ addFile() [2/2]

bool tracktion::engine::TracktionArchiveFile::addFile ( const juce::File f,
const juce::String filenameToUse,
CompressionType  compression 
)

Definition at line 350 of file tracktion_ArchiveFile.cpp.

◆ addFileInfo()

void tracktion::engine::TracktionArchiveFile::addFileInfo ( const juce::String filename,
const juce::String itemName,
const juce::String itemValue 
)

Definition at line 514 of file tracktion_ArchiveFile.cpp.

◆ createStoredInputStream()

std::unique_ptr< juce::InputStream > tracktion::engine::TracktionArchiveFile::createStoredInputStream ( int  index) const

Create a stream to read one of the archived objects.

Definition at line 167 of file tracktion_ArchiveFile.cpp.

◆ extractAll()

bool tracktion::engine::TracktionArchiveFile::extractAll ( const juce::File destDirectory,
juce::Array< juce::File > &  filesCreated 
)

Definition at line 240 of file tracktion_ArchiveFile.cpp.

◆ extractAllAsTask()

bool tracktion::engine::TracktionArchiveFile::extractAllAsTask ( const juce::File destDirectory,
bool  warnAboutOverwrite,
juce::Array< juce::File > &  filesCreated,
bool &  wasAborted 
)

Definition at line 326 of file tracktion_ArchiveFile.cpp.

◆ extractFile()

bool tracktion::engine::TracktionArchiveFile::extractFile ( int  index,
const juce::File destDirectory,
juce::File fileCreated,
bool  askBeforeOverwriting 
)

Definition at line 179 of file tracktion_ArchiveFile.cpp.

◆ flush()

void tracktion::engine::TracktionArchiveFile::flush ( )

Definition at line 118 of file tracktion_ArchiveFile.cpp.

◆ getFile()

juce::File tracktion::engine::TracktionArchiveFile::getFile ( ) const

Definition at line 82 of file tracktion_ArchiveFile.cpp.

◆ getNumFiles()

int tracktion::engine::TracktionArchiveFile::getNumFiles ( ) const

Definition at line 145 of file tracktion_ArchiveFile.cpp.

◆ getOriginalFileName()

juce::String tracktion::engine::TracktionArchiveFile::getOriginalFileName ( int  index) const

Definition at line 150 of file tracktion_ArchiveFile.cpp.

◆ indexOfFile()

int tracktion::engine::TracktionArchiveFile::indexOfFile ( const juce::String name) const

Definition at line 158 of file tracktion_ArchiveFile.cpp.

◆ isValidArchive()

bool tracktion::engine::TracktionArchiveFile::isValidArchive ( ) const

Definition at line 140 of file tracktion_ArchiveFile.cpp.


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