TracktionEngine
Classes | Public Types | Public Member Functions | List of all members
tracktion::engine::TracktionArchiveFile Class Reference

Classes

struct  IndexEntry
 

Public Types

enum class  CompressionType {
  none = 0 , zip = 1 , lossless = 2 , lossyGoodQuality = 3 ,
  lossyMediumQuality = 4 , lossyLowQuality = 5
}
 

Public Member Functions

 TracktionArchiveFile (Engine &, const juce::File &file)
 
 ~TracktionArchiveFile ()
 
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::InputStream > createStoredInputStream (int index) const
 Create a stream to read one of the archived objects. More...
 
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 ()
 

Member Enumeration Documentation

◆ CompressionType

Enumerator
none 
zip 
lossless 
lossyGoodQuality 
lossyMediumQuality 
lossyLowQuality 

Constructor & Destructor Documentation

◆ TracktionArchiveFile()

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

◆ ~TracktionArchiveFile()

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

Member Function Documentation

◆ isValidArchive()

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

◆ getFile()

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

◆ getNumFiles()

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

◆ getOriginalFileName()

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

◆ indexOfFile()

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

◆ createStoredInputStream()

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

Create a stream to read one of the archived objects.

◆ extractFile()

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

◆ extractAll()

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

◆ extractAllAsTask()

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

◆ addFile() [1/2]

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

◆ addFile() [2/2]

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

◆ addFileInfo()

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

◆ flush()

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

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