juce::ARAOutputStream Class Reference

#include <juce_ARADocumentController.h>

Inheritance diagram for juce::ARAOutputStream:

Public Member Functions
	ARAOutputStream (ARA::PlugIn::HostArchiveWriter *)
int64	getPosition () override
void	flush () override
bool	write (const void *, size_t) override
bool	setPosition (int64) override
Public Member Functions inherited from juce::OutputStream
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	writeRepeatedByte (uint8 byte, size_t numTimesToRepeat)
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

Private Attributes
ARA::PlugIn::HostArchiveWriter *	archiveWriter
int64	position = 0

Additional Inherited Members
Protected Member Functions inherited from juce::OutputStream
	OutputStream ()

Detailed Description

Used to write persistent ARA archives - see doStoreObjectsToStream() for details.

@tags{ARA}

Constructor & Destructor Documentation

ARAOutputStream()

juce::ARAOutputStream::ARAOutputStream ( ARA::PlugIn::HostArchiveWriter * writer )

explicit

Member Function Documentation

flush()

void juce::ARAOutputStream::flush ( )

inlineoverridevirtual

If the stream is using a buffer, this will ensure it gets written out to the destination.

Implements juce::OutputStream.

getPosition()

int64 juce::ARAOutputStream::getPosition ( )

inlineoverridevirtual

Returns the stream's current position.

See also

setPosition

Implements juce::OutputStream.

setPosition()

bool juce::ARAOutputStream::setPosition ( int64 newPosition )

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.

See also

getPosition

Implements juce::OutputStream.

write()

bool juce::ARAOutputStream::write ( const void * dataToWrite, size_t numberOfBytes )

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.

Parameters

dataToWrite	the target buffer to receive the data. This must not be null.
numberOfBytes	the number of bytes to write.

Returns

false if the write operation fails for some reason

Implements juce::OutputStream.

Member Data Documentation

archiveWriter

ARA::PlugIn::HostArchiveWriter* juce::ARAOutputStream::archiveWriter

private

position

int64 juce::ARAOutputStream::position = 0

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_processors/utilities/ARA/juce_ARADocumentController.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_processors/utilities/ARA/juce_ARADocumentController.cpp