Tag Parser  8.0.1
C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags
Public Member Functions | List of all members
TagParser::FlacMetaDataBlockPicture Class Reference

The FlacMetaDataBlockPicture class is a FLAC "METADATA_BLOCK_PICTURE" parser and maker. More...

#include <flacmetadata.h>

Public Member Functions

 FlacMetaDataBlockPicture (TagValue &tagValue)
 Constructs a new FLAC "METADATA_BLOCK_PICTURE". More...
 
void parse (std::istream &inputStream, uint32 maxSize)
 Parses the FLAC "METADATA_BLOCK_PICTURE". More...
 
uint32 requiredSize () const
 Returns the number of bytes make() will write. More...
 
void make (std::ostream &outputStream)
 Makes the FLAC "METADATA_BLOCK_PICTURE". More...
 
uint32 pictureType () const
 Returns the picture type according to the ID3v2 APIC frame. More...
 
void setPictureType (uint32 pictureType)
 Sets the picture type according to the ID3v2 APIC frame. More...
 
TagValuevalue ()
 Returns the tag value the picture is read from/stored to. More...
 

Detailed Description

The FlacMetaDataBlockPicture class is a FLAC "METADATA_BLOCK_PICTURE" parser and maker.

See also
https://xiph.org/flac/format.html

Definition at line 249 of file flacmetadata.h.

Constructor & Destructor Documentation

◆ FlacMetaDataBlockPicture()

TagParser::FlacMetaDataBlockPicture::FlacMetaDataBlockPicture ( TagValue tagValue)
inline

Constructs a new FLAC "METADATA_BLOCK_PICTURE".

The picture is read from/stored to the specified tagValue. The FlacMetaDataBlockPicture does not take ownership over the specified tagValue.

Definition at line 273 of file flacmetadata.h.

Member Function Documentation

◆ make()

void TagParser::FlacMetaDataBlockPicture::make ( std::ostream &  outputStream)

Makes the FLAC "METADATA_BLOCK_PICTURE".

Exceptions
Throwsan InvalidDataException() if the assigned data can not be serialized into a "METADATA_BLOCK_PICTURE" structure.

Definition at line 126 of file flacmetadata.cpp.

◆ parse()

void TagParser::FlacMetaDataBlockPicture::parse ( std::istream &  inputStream,
uint32  maxSize 
)

Parses the FLAC "METADATA_BLOCK_PICTURE".

maxSize specifies the maximum size of the structure.

Definition at line 84 of file flacmetadata.cpp.

◆ pictureType()

uint32 TagParser::FlacMetaDataBlockPicture::pictureType ( ) const
inline

Returns the picture type according to the ID3v2 APIC frame.

Definition at line 282 of file flacmetadata.h.

◆ requiredSize()

uint32 TagParser::FlacMetaDataBlockPicture::requiredSize ( ) const

Returns the number of bytes make() will write.

Remarks
Any changes to the object will invalidate this value.
Exceptions
Throwsan InvalidDataException() if the assigned data is too big.

Definition at line 113 of file flacmetadata.cpp.

◆ setPictureType()

void TagParser::FlacMetaDataBlockPicture::setPictureType ( uint32  pictureType)
inline

Sets the picture type according to the ID3v2 APIC frame.

Definition at line 290 of file flacmetadata.h.

◆ value()

TagValue & TagParser::FlacMetaDataBlockPicture::value ( )
inline

Returns the tag value the picture is read from/stored to.

Definition at line 298 of file flacmetadata.h.


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