openshot-audio  0.1.2
Classes | Public Member Functions | Friends | List of all members
juce::ZipFile::Builder Class Reference

#include <juce_core.h>

Classes

class  Item
 

Public Member Functions

 Builder ()
 
 ~Builder ()
 
void addFile (const File &fileToAdd, int compressionLevel, const String &storedPathName=String())
 
void addEntry (InputStream *streamToRead, int compressionLevel, const String &storedPathName, Time fileModificationTime)
 
bool writeToStream (OutputStream &target, double *progress) const
 

Friends

struct ContainerDeletePolicy< Item >
 

Detailed Description

Used to create a new zip file.

Create a ZipFile::Builder object, and call its addFile() method to add some files, then you can write it to a stream with write().

Currently this just stores the files with no compression.. That will be added soon!

Constructor & Destructor Documentation

◆ Builder()

ZipFile::Builder::Builder ( )

◆ ~Builder()

ZipFile::Builder::~Builder ( )

Member Function Documentation

◆ addEntry()

void ZipFile::Builder::addEntry ( InputStream streamToRead,
int  compressionLevel,
const String storedPathName,
Time  fileModificationTime 
)

Adds a file while should be added to the archive.

Parameters
streamToReadthis stream isn't read immediately - a pointer to the stream is stored, then used later when the writeToStream() method is called, and deleted by the Builder object when no longer needed, so be very careful about its lifetime and the lifetime of any objects on which it depends! This must not be null.
compressionLevelthis can be between 0 (no compression), and 9 (maximum compression).
storedPathNamethe partial pathname that will be stored for this file
fileModificationTimethe timestamp that will be stored as the last modification time of this entry

◆ addFile()

void ZipFile::Builder::addFile ( const File fileToAdd,
int  compressionLevel,
const String storedPathName = String() 
)

Adds a file while should be added to the archive. The file isn't read immediately, all the files will be read later when the writeToStream() method is called.

The compressionLevel can be between 0 (no compression), and 9 (maximum compression). If the storedPathName parameter is specified, you can customise the partial pathname that will be stored for this file.

◆ writeToStream()

bool ZipFile::Builder::writeToStream ( OutputStream target,
double *  progress 
) const

Generates the zip file, writing it to the specified stream. If the progress parameter is non-null, it will be updated with an approximate progress status between 0 and 1.0

Friends And Related Function Documentation

◆ ContainerDeletePolicy< Item >

friend struct ContainerDeletePolicy< Item >
friend

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