arduino-audio-tools
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MetaDataOutput Class Reference

ID3 and Icecast/Shoutcast metadata output support. Just write the audio data to an object of this class and receive the metadata via the callback. More...

#include <MetaData.h>

Inheritance diagram for MetaDataOutput:
AudioOutput Print AudioInfoSupport AudioInfoSource

Public Member Functions

 MetaDataOutput (MetaDataOutput const &)=delete
 
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
 
virtual AudioInfo audioInfo () override
 provides the actual input AudioInfo
 
virtual AudioInfo audioInfoOut ()
 provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream
 
virtual int availableForWrite () override
 
virtual bool begin ()
 
virtual bool begin (AudioInfo info)
 
virtual void begin (HttpRequest &http)
 Starts the processing - iceMetaint is determined from the HttpRequest.
 
virtual void begin (int iceMetaint=0)
 Starts the processing - if iceMetaint is defined we use icecast.
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
virtual void end ()
 
virtual void flush () override
 
virtual bool isDeletable ()
 If true we need to release the related memory in the destructor.
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
 operator bool ()
 
MetaDataOutputoperator= (MetaDataOutput const &)=delete
 
virtual bool removeNotifyAudioChange (AudioInfoSupport &bi)
 Removes a target in order not to be notified about audio changes.
 
virtual void setAudioInfo (AudioInfo newInfo) override
 Defines the input AudioInfo.
 
virtual void setCallback (void(*fn)(MetaDataType info, const char *str, int len))
 Defines the callback.
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
virtual size_t write (const uint8_t *data, size_t length)
 Provide tha audio data to the API to parse for Meta Data.
 
virtual size_t write (uint8_t c)
 
virtual void writeSilence (size_t len)
 

Protected Member Functions

void notifyAudioChange (AudioInfo info)
 

Protected Attributes

int _timeout = 10
 
void(* callback )(MetaDataType info, const char *str, int len) =nullptr
 
AudioInfo cfg
 
bool is_active = false
 
bool is_notify_active = true
 
AbstractMetaDatameta =nullptr
 
Vector< AudioInfoSupport * > notify_vector
 
SingleBuffer< uint8_t > tmp {MAX_SINGLE_CHARS}
 
int tmpPos = 0
 

Detailed Description

ID3 and Icecast/Shoutcast metadata output support. Just write the audio data to an object of this class and receive the metadata via the callback.

Author
Phil Schatzmann

Member Function Documentation

◆ writeSilence()

virtual void writeSilence ( size_t  len)
inlinevirtualinherited

Writes n 0 values (= silence)

Parameters
len

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