FileComments Class Reference

#include <FileComments.h>

Inheritance diagram for FileComments:

[legend]Collaboration diagram for FileComments:

[legend]List of all members.

Public Member Functions
virtual bool	acceptOggPage (OggPage *inOggPage)
bool	addStreamComment (StreamCommentInfo *inStreamComment)
	FileComments (void)
string	fileName ()
StreamCommentInfo *	getStreamComment (unsigned long inIndex)
bool	loadFile (string inFileName)
unsigned long	streamCount ()
bool	writeOutAll (string inFileName)
bool	writeOutStream (unsigned long inIndex)
	~FileComments (void)
Protected Attributes
LOOG_INT64	mBytePos
string	mFileName
unsigned long	mMinorStreamCount
vector< StreamCommentInfo * >	mStreams

---

Constructor & Destructor Documentation

FileComments::FileComments (  void   )

Definition at line 35 of file FileComments.cpp.

FileComments::~FileComments (  void   )

Definition at line 40 of file FileComments.cpp.

---

Member Function Documentation

bool FileComments::acceptOggPage (  OggPage *  inOggPage  )  [virtual]

All callers to acceptOggPage give away their pointer to this function. All methods implementing this interface are responsible for deleting this page. All callers should NULL their pointer immediately after calling to avoid reusing them. Implements IOggCallback. Definition at line 44 of file FileComments.cpp. References OggPage::getPacket(), mBytePos, mMinorStreamCount, mStreams, OggPage::numPackets(), OggPacket::packetData(), OggPage::pageSize(), VorbisComments::parseOggPacket(), StreamCommentInfo::setCodecID(), StreamCommentInfo::setComments(), StreamCommentInfo::setMajorStreamNo(), StreamCommentInfo::setMinorStreamNo(), and StreamCommentInfo::setPageStart().

Here is the call graph for this function:

bool FileComments::addStreamComment (  StreamCommentInfo *  inStreamComment  )

Definition at line 129 of file FileComments.cpp. References mStreams.

string FileComments::fileName (   )

Definition at line 110 of file FileComments.cpp. Referenced by illiminable::Ogg::libVorbisCommentDotNET::DNFileComments::fileName().

StreamCommentInfo * FileComments::getStreamComment (  unsigned long  inIndex  )

Definition at line 133 of file FileComments.cpp. References mStreams. Referenced by illiminable::Ogg::libVorbisCommentDotNET::DNFileComments::getStreamComment(), and main().

bool FileComments::loadFile (  string  inFileName  )

Definition at line 86 of file FileComments.cpp. References OggDataBuffer::feed(), inFileName, mBytePos, and OggDataBuffer::registerVirtualCallback(). Referenced by illiminable::Ogg::libVorbisCommentDotNET::DNFileComments::loadFile(), and main().

Here is the call graph for this function:

unsigned long FileComments::streamCount (   )

Definition at line 141 of file FileComments.cpp. References mStreams. Referenced by main(), and illiminable::Ogg::libVorbisCommentDotNET::DNFileComments::streamCount().

bool FileComments::writeOutAll (  string  inFileName  )

Definition at line 114 of file FileComments.cpp. References inFileName. Referenced by illiminable::Ogg::libVorbisCommentDotNET::DNFileComments::writeOutAll().

bool FileComments::writeOutStream (  unsigned long  inIndex  )

Definition at line 125 of file FileComments.cpp. Referenced by illiminable::Ogg::libVorbisCommentDotNET::DNFileComments::writeOutStream().

---

Member Data Documentation

LOOG_INT64 FileComments::mBytePos [protected]

Definition at line 69 of file FileComments.h. Referenced by acceptOggPage(), and loadFile().

string FileComments::mFileName [protected]

Definition at line 67 of file FileComments.h.

unsigned long FileComments::mMinorStreamCount [protected]

Definition at line 68 of file FileComments.h. Referenced by acceptOggPage().

vector<StreamCommentInfo*> FileComments::mStreams [protected]

Definition at line 66 of file FileComments.h. Referenced by acceptOggPage(), addStreamComment(), getStreamComment(), and streamCount().

---

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

• src/lib/core/ogg/libVorbisComment/FileComments.h
• src/lib/core/ogg/libVorbisComment/FileComments.cpp

---