|
|
TagLib::Ogg::File Class Reference
An implementation of TagLib::File with some helpers for Ogg based formats. More...
#include <oggfile.h>
Public Member Functions | |
| virtual | ~File () |
| ByteVector | packet (uint i) |
| void | setPacket (uint i, const ByteVector &p) |
| const PageHeader * | firstPageHeader () |
| const PageHeader * | lastPageHeader () |
| virtual bool | save () |
Protected Member Functions | |
| File (FileName file) | |
Detailed Description
An implementation of TagLib::File with some helpers for Ogg based formats.This is an implementation of Ogg file page and packet rendering and is of use to Ogg based formats. While the API is small this handles the non-trivial details of breaking up an Ogg stream into packets and makes these available (via subclassing) to the codec meta data implementations.
Constructor & Destructor Documentation
| virtual TagLib::Ogg::File::~File | ( | ) | [virtual] |
Destroys this File instance.
Reimplemented from TagLib::File.
Reimplemented in TagLib::Ogg::FLAC::File, TagLib::Ogg::Speex::File, and TagLib::Ogg::Vorbis::File.
| TagLib::Ogg::File::File | ( | FileName | file | ) | [protected] |
Contructs an Ogg file from file. If readProperties is true the file's audio properties will also be read using propertiesStyle. If false, propertiesStyle is ignored.
- Note:
- This constructor is protected since Ogg::File shouldn't be instantiated directly but rather should be used through the codec specific subclasses.
Reimplemented from TagLib::File.
Member Function Documentation
| ByteVector TagLib::Ogg::File::packet | ( | uint | i | ) |
Returns the packet contents for the i-th packet (starting from zero) in the Ogg bitstream.
- Warning:
- The requires reading at least the packet header for every page up to the requested page.
| void TagLib::Ogg::File::setPacket | ( | uint | i, | |
| const ByteVector & | p | |||
| ) |
Sets the packet with index i to the value p.
| const PageHeader* TagLib::Ogg::File::firstPageHeader | ( | ) |
Returns a pointer to the PageHeader for the first page in the stream or null if the page could not be found.
| const PageHeader* TagLib::Ogg::File::lastPageHeader | ( | ) |
Returns a pointer to the PageHeader for the last page in the stream or null if the page could not be found.
| virtual bool TagLib::Ogg::File::save | ( | ) | [virtual] |
Save the file and its associated tags. This should be reimplemented in the concrete subclasses. Returns true if the save succeeds.
- Warning:
- On UNIX multiple processes are able to write to the same file at the same time. This can result in serious file corruption. If you are developing a program that makes use of TagLib from multiple processes you must insure that you are only doing writes to a particular file from one of them.
Implements TagLib::File.
Reimplemented in TagLib::Ogg::FLAC::File, TagLib::Ogg::Speex::File, and TagLib::Ogg::Vorbis::File.
The documentation for this class was generated from the following file: