FLAC  1.3.1
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members

#include <metadata.h>

Inheritance diagram for FLAC::Metadata::VorbisComment:
FLAC::Metadata::Prototype

Classes

class  Entry
 

Public Member Functions

 VorbisComment (::FLAC__StreamMetadata *object, bool copy)
 
VorbisCommentassign (::FLAC__StreamMetadata *object, bool copy)
 
unsigned get_num_comments () const
 
const FLAC__byte * get_vendor_string () const
 
Entry get_comment (unsigned index) const
 
bool set_vendor_string (const FLAC__byte *string)
 
bool resize_comments (unsigned new_num_comments)
 
bool set_comment (unsigned index, const Entry &entry)
 
bool insert_comment (unsigned index, const Entry &entry)
 
bool append_comment (const Entry &entry)
 
bool replace_comment (const Entry &entry, bool all)
 
bool delete_comment (unsigned index)
 
int find_entry_from (unsigned offset, const char *field_name)
 
int remove_entry_matching (const char *field_name)
 
int remove_entries_matching (const char *field_name)
 
bool is_valid () const
 
bool get_is_last () const
 
::FLAC__MetadataType get_type () const
 
unsigned get_length () const
 
void set_is_last (bool)
 
 operator const ::FLAC__StreamMetadata * () const
 
 VorbisComment (const VorbisComment &object)
 
 VorbisComment (const ::FLAC__StreamMetadata &object)
 
 VorbisComment (const ::FLAC__StreamMetadata *object)
 
VorbisCommentoperator= (const VorbisComment &object)
 
VorbisCommentoperator= (const ::FLAC__StreamMetadata &object)
 
VorbisCommentoperator= (const ::FLAC__StreamMetadata *object)
 
bool operator== (const VorbisComment &object) const
 
bool operator== (const ::FLAC__StreamMetadata &object) const
 
bool operator== (const ::FLAC__StreamMetadata *object) const
 
bool operator!= (const VorbisComment &object) const
 
bool operator!= (const ::FLAC__StreamMetadata &object) const
 
bool operator!= (const ::FLAC__StreamMetadata *object) const
 
bool operator== (const Prototype &) const
 
bool operator!= (const Prototype &) const
 

Protected Member Functions

Prototypeassign_object (::FLAC__StreamMetadata *object, bool copy)
 
virtual void clear ()
 

Protected Attributes

::FLAC__StreamMetadataobject_
 

Detailed Description

VORBIS_COMMENT metadata block. See the overview for more, and the format specification.

Constructor & Destructor Documentation

FLAC::Metadata::VorbisComment::VorbisComment ( const VorbisComment object)
inline

Constructs a copy of the given object. This form always performs a deep copy.

FLAC::Metadata::VorbisComment::VorbisComment ( const ::FLAC__StreamMetadata object)
inline

Constructs a copy of the given object. This form always performs a deep copy.

FLAC::Metadata::VorbisComment::VorbisComment ( const ::FLAC__StreamMetadata object)
inline

Constructs a copy of the given object. This form always performs a deep copy.

FLAC::Metadata::VorbisComment::VorbisComment ( ::FLAC__StreamMetadata object,
bool  copy 
)
inline

Constructs an object with copy control. See Prototype(::FLAC__StreamMetadata *object, bool copy).

Member Function Documentation

VorbisComment& FLAC::Metadata::VorbisComment::operator= ( const VorbisComment object)
inline

Assign from another object. Always performs a deep copy.

References FLAC::Metadata::Prototype::operator=().

VorbisComment& FLAC::Metadata::VorbisComment::operator= ( const ::FLAC__StreamMetadata object)
inline

Assign from another object. Always performs a deep copy.

References FLAC::Metadata::Prototype::operator=().

VorbisComment& FLAC::Metadata::VorbisComment::operator= ( const ::FLAC__StreamMetadata object)
inline

Assign from another object. Always performs a deep copy.

References FLAC::Metadata::Prototype::operator=().

VorbisComment& FLAC::Metadata::VorbisComment::assign ( ::FLAC__StreamMetadata object,
bool  copy 
)
inline
bool FLAC::Metadata::VorbisComment::operator== ( const VorbisComment object) const
inline

Check for equality, performing a deep compare by following pointers.

References FLAC::Metadata::Prototype::operator==().

bool FLAC::Metadata::VorbisComment::operator== ( const ::FLAC__StreamMetadata object) const
inline

Check for equality, performing a deep compare by following pointers.

References FLAC::Metadata::Prototype::operator==().

bool FLAC::Metadata::VorbisComment::operator== ( const ::FLAC__StreamMetadata object) const
inline

Check for equality, performing a deep compare by following pointers.

References FLAC::Metadata::Prototype::operator==().

bool FLAC::Metadata::VorbisComment::operator!= ( const VorbisComment object) const
inline

Check for inequality, performing a deep compare by following pointers.

References FLAC::Metadata::Prototype::operator!=().

bool FLAC::Metadata::VorbisComment::operator!= ( const ::FLAC__StreamMetadata object) const
inline

Check for inequality, performing a deep compare by following pointers.

References FLAC::Metadata::Prototype::operator!=().

bool FLAC::Metadata::VorbisComment::operator!= ( const ::FLAC__StreamMetadata object) const
inline

Check for inequality, performing a deep compare by following pointers.

References FLAC::Metadata::Prototype::operator!=().

bool FLAC::Metadata::VorbisComment::set_vendor_string ( const FLAC__byte *  string)
bool FLAC::Metadata::VorbisComment::resize_comments ( unsigned  new_num_comments)
bool FLAC::Metadata::VorbisComment::set_comment ( unsigned  index,
const Entry entry 
)
bool FLAC::Metadata::VorbisComment::insert_comment ( unsigned  index,
const Entry entry 
)
bool FLAC::Metadata::VorbisComment::append_comment ( const Entry entry)
bool FLAC::Metadata::VorbisComment::replace_comment ( const Entry entry,
bool  all 
)
bool FLAC::Metadata::VorbisComment::delete_comment ( unsigned  index)
int FLAC::Metadata::VorbisComment::find_entry_from ( unsigned  offset,
const char *  field_name 
)
int FLAC::Metadata::VorbisComment::remove_entry_matching ( const char *  field_name)
int FLAC::Metadata::VorbisComment::remove_entries_matching ( const char *  field_name)
Prototype& FLAC::Metadata::Prototype::assign_object ( ::FLAC__StreamMetadata object,
bool  copy 
)
protectedinherited
virtual void FLAC::Metadata::Prototype::clear ( )
protectedvirtualinherited

Deletes the underlying FLAC__StreamMetadata object.

bool FLAC::Metadata::Prototype::get_is_last ( ) const
inherited

Returns true if this block is the last block in a stream, else false.

Assertions:
::FLAC__MetadataType FLAC::Metadata::Prototype::get_type ( ) const
inherited

Returns the type of the block.

Assertions:
unsigned FLAC::Metadata::Prototype::get_length ( ) const
inherited

Returns the stream length of the metadata block.

Note
The length does not include the metadata block header, per spec.
Assertions:
void FLAC::Metadata::Prototype::set_is_last ( bool  )
inherited

Sets the "is_last" flag for the block. When using the iterators it is not necessary to set this flag; they will do it for you.

Assertions:

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