PackageItemFile¶

Closes the file an releases allocated resources.

virtual void Amplitude::PackageItemFile::Close () override

Implements SparkyStudios::Audio::Amplitude::File::Close

Checks if the read cursor is at the end of the file.

virtual bool Amplitude::PackageItemFile::Eof () override const

Returns:

true if the read cursor is at the end of the file, false otherwise.

Implements SparkyStudios::Audio::Amplitude::File::Eof

Get the base position of this file item in the entire package file.

AmSize Amplitude::PackageItemFile::GetBasePosition () const

Gets the path to the file in the loaded FileSystem .

virtual AmOsString Amplitude::PackageItemFile::GetPath () override const

Returns:

The path to the file.

Implements SparkyStudios::Audio::Amplitude::File::GetPath

Gets the pointer to the internal file handle.

virtual AmVoidPtr Amplitude::PackageItemFile::GetPtr () override const

Returns:

The internal file handle. This depends on the implementation.

Implements SparkyStudios::Audio::Amplitude::File::GetPtr

Checks if the file is valid.

virtual bool Amplitude::PackageItemFile::IsValid () override const

The validity of a file is determined by the underlying implementation. But this should primarily mean that the file exists AND has been opened.

Returns:

true if the file is valid, false otherwise.

Implements SparkyStudios::Audio::Amplitude::File::IsValid

Gets the size of the file in bytes.

virtual AmSize Amplitude::PackageItemFile::Length () override const

Returns:

The size of the file in bytes.

Implements SparkyStudios::Audio::Amplitude::File::Length

Constructs a new PackageItemFile instance.

Amplitude::PackageItemFile::PackageItemFile (
    const PackageFileItemDescription * item,
    std::shared_ptr< File > packageFile,
    AmSize headerSize
) 

Parameters:

• item The description of the package item.
• packageFile The package file containing this item.
• headerSize The size of the package file header.

Gets the current position of the read/write cursor.

virtual AmSize Amplitude::PackageItemFile::Position () override const

Returns:

The actual position of the read/write cursor.

Implements SparkyStudios::Audio::Amplitude::File::Position

Reads data from the file.

virtual AmSize Amplitude::PackageItemFile::Read (
    AmUInt8Buffer dst,
    AmSize bytes
) override const

Parameters:

• dst The destination buffer of the read data.
• bytes The number of bytes to read from the file. The destination buffer must be at least as large as the number of bytes to read.

Returns:

The number of bytes read from the file.

Implements SparkyStudios::Audio::Amplitude::File::Read

Seeks the read/write to the specified offset, starting at the given origin.

virtual void Amplitude::PackageItemFile::Seek (
    AmInt64 offset,
    eFileSeekOrigin origin
) override

Parameters:

• offset The offset in bytes from the beginning of the file.
• origin The origin from which to begin seeking.

Implements SparkyStudios::Audio::Amplitude::File::Seek

virtual AmSize Amplitude::PackageItemFile::Write (
    AmConstUInt8Buffer src,
    AmSize bytes
) override

Note:

Writing is disabled for packages item files.

Implements SparkyStudios::Audio::Amplitude::File::Write

Destroys this instance.

Amplitude::PackageItemFile::~PackageItemFile () override