MetaDataID3V1 Class Reference

Simple ID3 Meta Data API which supports ID3 V1. More...

#include <MetaDataID3.h>

Inheritance diagram for MetaDataID3V1:

Public Member Functions
	MetaDataID3V1 ()=default
bool	begin ()
	(re)starts the processing
void	end ()
	Ends the processing and releases the memory.
void	setCallback (void(*fn)(MetaDataType info, const char *str, int len))
size_t	write (const uint8_t *data, size_t len)
	provide the (partial) data which might contain the meta data

Protected Member Functions
int	findTag (const char *tag, const char *str, size_t len)
	find the tag position in the string - if not found we return -1;
void	processnotifyAudioChange ()
	executes the callbacks
void	processPartialTagAtTail (const uint8_t *data, size_t len)
	We had part of the start tag at the end of the last write, now we get the full data.
void	processTagFoundPartial (const uint8_t *data, size_t len)
	We have the beginning of the metadata and need to process the remainder.
void	processTagNotFound (const uint8_t *data, size_t len)
	try to find the metatdata tag in the provided data

Protected Attributes
bool	armed = false
void(*	callback )(MetaDataType info, const char *title, int len)
ParseStatus	status = TagNotFound
ID3v1 *	tag = nullptr
ID3v1Enhanced *	tag_ext = nullptr
char	tag_str [5] = ""
int	use_bytes_of_next_write = 0

Detailed Description

Simple ID3 Meta Data API which supports ID3 V1.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

MetaDataID3V1()

MetaDataID3V1 ( )

default

Member Function Documentation

begin()

bool begin ( )

inline

(re)starts the processing

end()

void end ( )

inline

Ends the processing and releases the memory.

findTag()

int findTag ( const char *  tag, const char *  str, size_t  len  )

inlineprotectedinherited

find the tag position in the string - if not found we return -1;

processnotifyAudioChange()

void processnotifyAudioChange ( )

inlineprotected

executes the callbacks

processPartialTagAtTail()

void processPartialTagAtTail ( const uint8_t *  data, size_t  len  )

inlineprotected

We had part of the start tag at the end of the last write, now we get the full data.

processTagFoundPartial()

void processTagFoundPartial ( const uint8_t *  data, size_t  len  )

inlineprotected

We have the beginning of the metadata and need to process the remainder.

processTagNotFound()

void processTagNotFound ( const uint8_t *  data, size_t  len  )

inlineprotected

try to find the metatdata tag in the provided data

setCallback()

void setCallback ( void(*)(MetaDataType info, const char *str, int len)  fn )

inlineinherited

write()

size_t write ( const uint8_t *  data, size_t  len  )

inline

provide the (partial) data which might contain the meta data

Member Data Documentation

armed

bool armed = false

protectedinherited

callback

void(* callback) (MetaDataType info, const char *title, int len)

protectedinherited

status

ParseStatus status = TagNotFound

protected

tag

ID3v1* tag = nullptr

protected

tag_ext

ID3v1Enhanced* tag_ext = nullptr

protected

tag_str

char tag_str[5] = ""

protected

use_bytes_of_next_write

int use_bytes_of_next_write = 0

protected

---

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

• src/AudioTools/CoreAudio/AudioMetaData/MetaDataID3.h