VolumeMeter Class Reference

A simple class to determine the volume. You can use it as final output or as output or input in your audio chain. More...

#include <AudioStreams.h>

Inheritance diagram for VolumeMeter:

Public Member Functions
	VolumeMeter (AudioOutput &ao)
	VolumeMeter (AudioStream &as)
	VolumeMeter (Print &print)
	VolumeMeter (Stream &stream)
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	available () override
virtual int	availableForWrite () override
bool	begin () override
bool	begin (AudioInfo info)
void	clear ()
	Resets the actual volume.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	end ()
virtual void	flush () override
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual	operator bool ()
size_t	readBytes (uint8_t *data, size_t len)
virtual size_t	readSilence (uint8_t *buffer, size_t length)
	Source to generate silence: just sets the buffer to 0.
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
void	setAudioInfo (AudioInfo info)
	Defines the input AudioInfo.
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
void	setOutput (Print &out) override
	Defines/Changes the output target.
void	setStream (Stream &io) override
	Defines/Changes the input & output.
float	volume ()
float	volume (int channel)
float	volumeDB ()
	Volume in db: max amplitude is 0 (range: -1000 to 0)
float	volumeDB (int channel)
	Volume of indicated channel in db: max amplitude is 0.
float	volumePercent ()
	Volume in %: max amplitude is 100.
float	volumePercent (int channel)
	Volume of indicated channel in %: max amplitude is 100.
float	volumeRatio ()
	Volume Ratio: max amplitude is 1.0.
float	volumeRatio (int channel)
	Volume Ratio of indicated channel: max amplitude is 1.0.
size_t	write (const uint8_t *data, size_t len)
virtual size_t	write (uint8_t ch) override
virtual void	writeSilence (size_t len)
	Writes len bytes of silence (=0).

Protected Member Functions
void	commit ()
virtual int	not_supported (int out, const char *msg="")
void	notifyAudioChange (AudioInfo info)
void	refillReadBuffer ()
void	updateVolume (float tmp, int j)
void	updateVolumes (const uint8_t *data, size_t len)
template<typename T >
void	updateVolumesT (const uint8_t *buffer, size_t size)

Protected Attributes
int	_timeout = 10
float	f_volume = 0
float	f_volume_tmp = 0
AudioInfo	info
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
Print *	p_out = nullptr
Stream *	p_stream = nullptr
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}
Vector< float >	volumes {0}
Vector< float >	volumes_tmp {0}

Detailed Description

A simple class to determine the volume. You can use it as final output or as output or input in your audio chain.

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

volume() [1/2]

float volume ( )

inline

Determines the volume (max amplitude). The range depends on the bits_per_sample.

volume() [2/2]

float volume ( int  channel )

inline

Determines the volume for the indicated channel. You must call the begin method to define the number of channels

---

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

• src/AudioTools/AudioStreams.h