![]() |
Miam-Player
0.8.0
A nice music player
|
An implementation of Ogg::File with Vorbis specific methods. More...
#include <vorbisfile.h>
Public Member Functions | |
File (FileName file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average) | |
Constructs a Vorbis file from file. More... | |
File (IOStream *stream, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average) | |
Constructs a Vorbis file from stream. More... | |
virtual | ~File () |
Destroys this instance of the File. More... | |
virtual Ogg::XiphComment * | tag () const |
Returns the XiphComment for this file. More... | |
PropertyMap | properties () const |
Implements the unified property interface – export function. More... | |
PropertyMap | setProperties (const PropertyMap &) |
Implements the unified tag dictionary interface – import function. More... | |
virtual Properties * | audioProperties () const |
Returns the Vorbis::Properties for this file. More... | |
virtual bool | save () |
Save the file. More... | |
![]() | |
ByteVector | packet (unsigned int i) |
Returns the packet contents for the i-th packet (starting from zero) in the Ogg bitstream. More... | |
void | setPacket (unsigned int i, const ByteVector &p) |
Sets the packet with index i to the value p. More... | |
const PageHeader * | firstPageHeader () |
Returns a pointer to the PageHeader for the first page in the stream or null if the page could not be found. More... | |
const PageHeader * | lastPageHeader () |
Returns a pointer to the PageHeader for the last page in the stream or null if the page could not be found. More... | |
![]() | |
FileName | name () const |
Returns the file name in the local file system encoding. More... | |
PropertyMap | properties () const |
Exports the tags of the file as dictionary mapping (human readable) tag names (uppercase Strings) to StringLists of tag values. More... | |
void | removeUnsupportedProperties (const StringList &properties) |
Removes unsupported properties, or a subset of them, from the file's metadata. More... | |
PropertyMap | setProperties (const PropertyMap &properties) |
Sets the tags of this File to those specified in properties. More... | |
ByteVector | readBlock (unsigned long length) |
Reads a block of size length at the current get pointer. More... | |
void | writeBlock (const ByteVector &data) |
Attempts to write the block data at the current get pointer. More... | |
long | find (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector()) |
Returns the offset in the file that pattern occurs at or -1 if it can not be found. More... | |
long | rfind (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector()) |
Returns the offset in the file that pattern occurs at or -1 if it can not be found. More... | |
void | insert (const ByteVector &data, unsigned long start=0, unsigned long replace=0) |
Insert data at position start in the file overwriting replace bytes of the original content. More... | |
void | removeBlock (unsigned long start=0, unsigned long length=0) |
Removes a block of the file starting a start and continuing for length bytes. More... | |
bool | readOnly () const |
Returns true if the file is read only (or if the file can not be opened). More... | |
bool | isOpen () const |
Since the file can currently only be opened as an argument to the constructor (sort-of by design), this returns if that open succeeded. More... | |
bool | isValid () const |
Returns true if the file is open and readable. More... | |
void | seek (long offset, Position p=Beginning) |
Move the I/O pointer to offset in the file from position p. More... | |
void | clear () |
Reset the end-of-file and error flags on the file. More... | |
long | tell () const |
Returns the current offset within the file. More... | |
long | length () |
Returns the length of the file. More... | |
Additional Inherited Members | |
![]() | |
enum | Position { Beginning, Current, End } |
Position in the file used for seeking. More... | |
![]() | |
static bool | isReadable (const char *file) |
Returns true if file can be opened for reading. More... | |
static bool | isWritable (const char *name) |
Returns true if file can be opened for writing. More... | |
![]() | |
File (FileName file) | |
Constructs an Ogg file from file. More... | |
File (IOStream *stream) | |
Constructs an Ogg file from stream. More... | |
![]() | |
File (FileName file) | |
Construct a File object and opens the file. More... | |
File (IOStream *stream) | |
Construct a File object and use the stream instance. More... | |
void | setValid (bool valid) |
Marks the file as valid or invalid. More... | |
void | truncate (long length) |
Truncates the file to a length. More... | |
![]() | |
static unsigned int | bufferSize () |
Returns the buffer size that is used for internal buffering. More... | |
An implementation of Ogg::File with Vorbis specific methods.
This is the central class in the Ogg Vorbis metadata processing collection of classes. It's built upon Ogg::File which handles processing of the Ogg logical bitstream and breaking it down into pages which are handled by the codec implementations, in this case Vorbis specifically.
TagLib::Vorbis::File::File | ( | FileName | file, |
bool | readProperties = true , |
||
Properties::ReadStyle | propertiesStyle = Properties::Average |
||
) |
Constructs a Vorbis file from file.
If readProperties is true the file's audio properties will also be read.
TagLib::Vorbis::File::File | ( | IOStream * | stream, |
bool | readProperties = true , |
||
Properties::ReadStyle | propertiesStyle = Properties::Average |
||
) |
|
virtual |
Destroys this instance of the File.
Reimplemented from TagLib::Ogg::File.
|
virtual |
Returns the Vorbis::Properties for this file.
If no audio properties were read then this will return a null pointer.
Implements TagLib::File.
PropertyMap TagLib::Vorbis::File::properties | ( | ) | const |
Implements the unified property interface – export function.
This forwards directly to XiphComment::properties().
|
virtual |
Save the file.
This returns true if the save was successful.
Reimplemented from TagLib::Ogg::File.
PropertyMap TagLib::Vorbis::File::setProperties | ( | const PropertyMap & | ) |
Implements the unified tag dictionary interface – import function.
Like properties(), this is a forwarder to the file's XiphComment.
|
virtual |
Returns the XiphComment for this file.
XiphComment implements the tag interface, so this serves as the reimplementation of TagLib::File::tag().
Implements TagLib::File.