TagLib 1.11.1 (TagLib::RIFF::File Class Reference)

TagLib::RIFF::File Class Reference

An RIFF file class with some useful methods specific to RIFF. More...

#include <rifffile.h>

Inheritance diagram for TagLib::RIFF::File:
Collaboration diagram for TagLib::RIFF::File:

List of all members.

Public Member Functions

virtual ~File ()

Protected Types

enum  Endianness { BigEndian, LittleEndian }

Protected Member Functions

 File (FileName file, Endianness endianness)
 File (IOStream *stream, Endianness endianness)
unsigned int riffSize () const
unsigned int chunkCount () const
unsigned int chunkOffset (unsigned int i) const
unsigned int chunkDataSize (unsigned int i) const
unsigned int chunkPadding (unsigned int i) const
ByteVector chunkName (unsigned int i) const
ByteVector chunkData (unsigned int i)
void setChunkData (unsigned int i, const ByteVector &data)
void setChunkData (const ByteVector &name, const ByteVector &data)
void setChunkData (const ByteVector &name, const ByteVector &data, bool alwaysCreate)
void removeChunk (unsigned int i)
void removeChunk (const ByteVector &name)

Detailed Description

An RIFF file class with some useful methods specific to RIFF.

This implements the generic TagLib::File API and additionally provides access to properties that are distinct to RIFF files, notably access to the different ID3 tags.


Member Enumeration Documentation

Enumerator:
BigEndian 
LittleEndian 

Constructor & Destructor Documentation

virtual TagLib::RIFF::File::~File ( ) [virtual]

Destroys this instance of the File.

Reimplemented from TagLib::File.

Reimplemented in TagLib::RIFF::WAV::File, and TagLib::RIFF::AIFF::File.

TagLib::RIFF::File::File ( FileName  file,
Endianness  endianness 
) [protected]
TagLib::RIFF::File::File ( IOStream stream,
Endianness  endianness 
) [protected]

Member Function Documentation

unsigned int TagLib::RIFF::File::chunkCount ( ) const [protected]
Returns:
The number of chunks in the file.
ByteVector TagLib::RIFF::File::chunkData ( unsigned int  i) [protected]

Reads the chunk data from the file and returns it.

Note:
This will move the read pointer for the file.
unsigned int TagLib::RIFF::File::chunkDataSize ( unsigned int  i) const [protected]
Returns:
The size of the chunk data.
ByteVector TagLib::RIFF::File::chunkName ( unsigned int  i) const [protected]
Returns:
The name of the specified chunk, for instance, "COMM" or "ID3 "
unsigned int TagLib::RIFF::File::chunkOffset ( unsigned int  i) const [protected]
Returns:
The offset within the file for the selected chunk number.
unsigned int TagLib::RIFF::File::chunkPadding ( unsigned int  i) const [protected]
Returns:
The size of the padding after the chunk (can be either 0 or 1).
void TagLib::RIFF::File::removeChunk ( unsigned int  i) [protected]

Removes the specified chunk.

Warning:
This will update the file immediately.
void TagLib::RIFF::File::removeChunk ( const ByteVector name) [protected]

Removes the chunk name.

Warning:
This will update the file immediately.
This removes all the chunks with the given name.
unsigned int TagLib::RIFF::File::riffSize ( ) const [protected]
Returns:
The size of the main RIFF chunk.
void TagLib::RIFF::File::setChunkData ( unsigned int  i,
const ByteVector data 
) [protected]

Sets the data for the specified chunk to data.

Warning:
This will update the file immediately.
void TagLib::RIFF::File::setChunkData ( const ByteVector name,
const ByteVector data 
) [protected]

Sets the data for the chunk name to data. If a chunk with the given name already exists it will be overwritten, otherwise it will be created after the existing chunks.

Warning:
This will update the file immediately.
void TagLib::RIFF::File::setChunkData ( const ByteVector name,
const ByteVector data,
bool  alwaysCreate 
) [protected]

Sets the data for the chunk name to data. If a chunk with the given name already exists it will be overwritten, otherwise it will be created after the existing chunks.

Note:
If alwaysCreate is true, a new chunk is created regardless of whether or not the chunk name exists. It should only be used for "LIST" chunks.
Warning:
This will update the file immediately.

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