OpenShot Audio Library | OpenShotAudio
0.3.1
|
#include <juce_FileOutputStream.h>
Public Member Functions | |
FileOutputStream (const File &fileToWriteTo, size_t bufferSizeToUse=16384) | |
~FileOutputStream () override | |
const File & | getFile () const |
const Result & | getStatus () const noexcept |
bool | failedToOpen () const noexcept |
bool | openedOk () const noexcept |
Result | truncate () |
void | flush () override |
int64 | getPosition () override |
bool | setPosition (int64) override |
bool | write (const void *, size_t) override |
bool | writeRepeatedByte (uint8 byte, size_t numTimesToRepeat) override |
![]() | |
virtual | ~OutputStream () |
virtual bool | writeByte (char byte) |
virtual bool | writeBool (bool boolValue) |
virtual bool | writeShort (short value) |
virtual bool | writeShortBigEndian (short value) |
virtual bool | writeInt (int value) |
virtual bool | writeIntBigEndian (int value) |
virtual bool | writeInt64 (int64 value) |
virtual bool | writeInt64BigEndian (int64 value) |
virtual bool | writeFloat (float value) |
virtual bool | writeFloatBigEndian (float value) |
virtual bool | writeDouble (double value) |
virtual bool | writeDoubleBigEndian (double value) |
virtual bool | writeCompressedInt (int value) |
virtual bool | writeString (const String &text) |
virtual bool | writeText (const String &text, bool asUTF16, bool writeUTF16ByteOrderMark, const char *lineEndings) |
virtual int64 | writeFromInputStream (InputStream &source, int64 maxNumBytesToWrite) |
void | setNewLineString (const String &newLineString) |
const String & | getNewLineString () const noexcept |
An output stream that writes into a local file.
Definition at line 34 of file juce_FileOutputStream.h.
juce::FileOutputStream::FileOutputStream | ( | const File & | fileToWriteTo, |
size_t | bufferSizeToUse = 16384 |
||
) |
Creates a FileOutputStream.
If the file doesn't exist, it will first be created. If the file can't be created or opened (for example, because the parent directory of the file does not exist), the failedToOpen() method will return true.
If the file already exists when opened, the stream's write-position will be set to the end of the file. To overwrite an existing file, you can truncate it like this:
Destroying a FileOutputStream object does not force the operating system to write the buffered data to disk immediately. If this is required you should call flush() before triggering the destructor.
Definition at line 29 of file juce_FileOutputStream.cpp.
|
override |
Destructor.
Definition at line 37 of file juce_FileOutputStream.cpp.
|
inlinenoexcept |
Returns true if the stream couldn't be opened for some reason.
Definition at line 86 of file juce_FileOutputStream.h.
Referenced by juce::File::appendText(), and juce::ZipFile::uncompressEntry().
|
overridevirtual |
If the stream is using a buffer, this will ensure it gets written out to the destination.
Implements juce::OutputStream.
Definition at line 72 of file juce_FileOutputStream.cpp.
Referenced by juce::XmlElement::writeTo().
|
inline |
Returns the file that this stream is writing to.
Definition at line 75 of file juce_FileOutputStream.h.
|
overridevirtual |
Returns the stream's current position.
Implements juce::OutputStream.
Definition at line 43 of file juce_FileOutputStream.cpp.
|
inlinenoexcept |
Returns the status of the file stream. The result will be ok if the file opened successfully. If an error occurs while opening or writing to the file, this will contain an error message.
Definition at line 81 of file juce_FileOutputStream.h.
Referenced by juce::File::create(), and juce::XmlElement::writeTo().
|
inlinenoexcept |
Returns true if the stream opened without problems.
Definition at line 91 of file juce_FileOutputStream.h.
Referenced by juce::File::appendData(), juce::WavAudioFormat::replaceMetadataInFile(), juce::FileLogger::trimFileSize(), write(), and juce::XmlElement::writeTo().
|
overridevirtual |
Tries to move the stream's output position.
Not all streams will be able to seek to a new position - this will return false if it fails to work.
Implements juce::OutputStream.
Definition at line 48 of file juce_FileOutputStream.cpp.
Referenced by juce::WavAudioFormat::replaceMetadataInFile().
Result juce::FileOutputStream::truncate | ( | ) |
Attempts to truncate the file to the current write position. To truncate a file to a specific size, first use setPosition() to seek to the appropriate location, and then call this method.
|
overridevirtual |
Writes a block of data to the stream.
When creating a subclass of OutputStream, this is the only write method that needs to be overloaded - the base class has methods for writing other types of data which use this to do the work.
dataToWrite | the target buffer to receive the data. This must not be null. |
numberOfBytes | the number of bytes to write. |
Implements juce::OutputStream.
Definition at line 78 of file juce_FileOutputStream.cpp.
Referenced by juce::File::appendData().
|
overridevirtual |
Writes a byte to the output stream a given number of times.
Reimplemented from juce::OutputStream.
Definition at line 117 of file juce_FileOutputStream.cpp.