MetaIOOggVorbisComment Class Reference

#include <metaiooggvorbiscomment.h>

Inheritance diagram for MetaIOOggVorbisComment:

List of all members.

---

Detailed Description

Definition at line 9 of file metaiooggvorbiscomment.h.

Public Member Functions
	MetaIOOggVorbisComment (void)
virtual	~MetaIOOggVorbisComment (void)
bool	write (Metadata *mdata, bool exclusive=false)
	Writes metadata back to a file.
Metadata *	read (QString filename)
	Reads Metadata from a file.
Static Public Member Functions
static vorbis_comment *	getRawVorbisComment (Metadata *mdata, vorbis_comment *pComment=NULL)
	Low Level Function to get the raw vorbis comment block.
Private Member Functions
int	getTrackLength (QString filename)
	Find the length of the track (in milliseconds).
int	getTrackLength (OggVorbis_File *pVf)
	Find the length of the track (in milliseconds) of an ov_open'ed file.
QString	getComment (vorbis_comment *pComment, const char *pLabel)
	Function to return an individual comment from an OggVorbis comment.

---

Constructor & Destructor Documentation

MetaIOOggVorbisComment::MetaIOOggVorbisComment

(

void

)

Definition at line 26 of file metaiooggvorbiscomment.cpp.

MetaIOOggVorbisComment::~MetaIOOggVorbisComment

(

void

)

[virtual]

Definition at line 33 of file metaiooggvorbiscomment.cpp.

---

Member Function Documentation

vorbis_comment * MetaIOOggVorbisComment::getRawVorbisComment	(	Metadata *	mdata,
		vorbis_comment *	pComment = NULL
	)			[static]

Low Level Function to get the raw vorbis comment block.

Note:

Typically used when encoding a file at the same time

Parameters:

mdata

A pointer to a Metadata object

Returns:

A vorbis_comment pointer or NULL on error

Definition at line 48 of file metaiooggvorbiscomment.cpp.

Referenced by VorbisEncoder::VorbisEncoder(), and write().

bool MetaIOOggVorbisComment::write	(	Metadata *	mdata,
		bool	exclusive = false
	)			[virtual]

Writes metadata back to a file.

Parameters:

	mdata	A pointer to a Metadata object
	exclusive	Flag to indicate if only the data in mdata should be in the file. If false, any unrecognised tags already in the file will be maintained.

Returns:

Boolean to indicate success/failure.

Implements MetaIO.

Definition at line 187 of file metaiooggvorbiscomment.cpp.

Metadata * MetaIOOggVorbisComment::read

(

QString

filename

)

[virtual]

Reads Metadata from a file.

Parameters:

filename

The filename to read metadata from.

Returns:

Metadata pointer or NULL on error

Implements MetaIO.

Definition at line 274 of file metaiooggvorbiscomment.cpp.

int MetaIOOggVorbisComment::getTrackLength

(

QString

filename

)

[private, virtual]

Find the length of the track (in milliseconds).

Parameters:

filename

The filename for which we want to find the length.

Returns:

An integer (signed!) to represent the length in milliseconds.

Implements MetaIO.

Definition at line 363 of file metaiooggvorbiscomment.cpp.

Referenced by read().

int MetaIOOggVorbisComment::getTrackLength

(

OggVorbis_File *

pVf

)

[private]

Find the length of the track (in milliseconds) of an ov_open'ed file.

Parameters:

filename

The filename for which we want to find the length.

Returns:

An integer (signed!) to represent the length in milliseconds.

Definition at line 347 of file metaiooggvorbiscomment.cpp.

QString MetaIOOggVorbisComment::getComment	(	vorbis_comment *	pComment,
		const char *	pLabel
	)			[private]

Function to return an individual comment from an OggVorbis comment.

Parameters:

	pComment	Pointer to a vorbis_comment
	pLabel	The label of the comment you want

Returns:

QString containing the contents of the comment you want

Definition at line 398 of file metaiooggvorbiscomment.cpp.

Referenced by read().

---

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

• metaiooggvorbiscomment.h
• metaiooggvorbiscomment.cpp