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

#include <metadata.h>

Inheritance diagram for FLAC::Metadata::Picture:
FLAC::Metadata::Prototype

Public Member Functions

 Picture (::FLAC__StreamMetadata *object, bool copy)
 
Pictureassign (::FLAC__StreamMetadata *object, bool copy)
 
::FLAC__StreamMetadata_Picture_Type get_type () const
 
const char * get_mime_type () const
 
const FLAC__byte * get_description () const
 
FLAC__uint32 get_width () const
 
FLAC__uint32 get_height () const
 
FLAC__uint32 get_depth () const
 
FLAC__uint32 get_colors () const
 
FLAC__uint32 get_data_length () const
 
const FLAC__byte * get_data () const
 
void set_type (::FLAC__StreamMetadata_Picture_Type type)
 
bool set_mime_type (const char *string)
 
bool set_description (const FLAC__byte *string)
 
void set_width (FLAC__uint32 value) const
 
void set_height (FLAC__uint32 value) const
 
void set_depth (FLAC__uint32 value) const
 
void set_colors (FLAC__uint32 value) const
 
bool set_data (const FLAC__byte *data, FLAC__uint32 data_length)
 
bool is_legal (const char **violation)
 
bool is_valid () const
 
bool get_is_last () const
 
unsigned get_length () const
 
void set_is_last (bool)
 
 operator const ::FLAC__StreamMetadata * () const
 
 Picture (const Picture &object)
 
 Picture (const ::FLAC__StreamMetadata &object)
 
 Picture (const ::FLAC__StreamMetadata *object)
 
Pictureoperator= (const Picture &object)
 
Pictureoperator= (const ::FLAC__StreamMetadata &object)
 
Pictureoperator= (const ::FLAC__StreamMetadata *object)
 
bool operator== (const Picture &object) const
 
bool operator== (const ::FLAC__StreamMetadata &object) const
 
bool operator== (const ::FLAC__StreamMetadata *object) const
 
bool operator!= (const Picture &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

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

Constructor & Destructor Documentation

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

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

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

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

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

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

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

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

Member Function Documentation

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

Assign from another object. Always performs a deep copy.

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

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

Assign from another object. Always performs a deep copy.

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

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

Assign from another object. Always performs a deep copy.

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

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

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

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

bool FLAC::Metadata::Picture::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::Picture::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::Picture::operator!= ( const Picture object) const
inline

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

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

bool FLAC::Metadata::Picture::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::Picture::operator!= ( const ::FLAC__StreamMetadata object) const
inline

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

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

FLAC__uint32 FLAC::Metadata::Picture::get_colors ( ) const

a return value of 0 means true-color, i.e. 2^depth colors

bool FLAC::Metadata::Picture::set_mime_type ( const char *  string)
bool FLAC::Metadata::Picture::set_description ( const FLAC__byte *  string)
void FLAC::Metadata::Picture::set_colors ( FLAC__uint32  value) const

a value of 0 means true-color, i.e. 2^depth colors

bool FLAC::Metadata::Picture::set_data ( const FLAC__byte *  data,
FLAC__uint32  data_length 
)
bool FLAC::Metadata::Picture::is_legal ( const char **  violation)
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:
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: