arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
audio_tools::VolumePrint Class Reference

A simple class to determine the volume. More...

#include <AudioPrint.h>

Inheritance diagram for audio_tools::VolumePrint:
audio_tools::AudioPrint Print audio_tools::AudioBaseInfoDependent audio_tools::AudioBaseInfoSource

Public Member Functions

bool begin (AudioBaseInfo info)
 
void setAudioInfo (AudioBaseInfo info)
 
float volume ()
 Determines the volume (the range depends on the bits_per_sample)
 
float volume (int channel)
 Determines the volume for the indicated channel.
 
size_t write (const uint8_t *buffer, size_t size)
 
- Public Member Functions inherited from audio_tools::AudioPrint
virtual AudioBaseInfo audioInfo () override
 
virtual int availableForWrite ()
 
virtual bool doRelease ()
 If true we need to release the related memory. More...
 
void flush ()
 
virtual void setAudioInfo (AudioBaseInfo info) override
 
virtual void setNotifyAudioChange (AudioBaseInfoDependent &bi) override
 
virtual size_t write (const uint8_t *buffer, size_t size) override=0
 
virtual size_t write (uint8_t ch) override
 
- Public Member Functions inherited from Print
virtual int availableForWrite ()
 
void clearWriteError ()
 
virtual void flush ()
 
int getWriteError ()
 
size_t print (char)
 
size_t print (const __FlashStringHelper *)
 
size_t print (const char[])
 
size_t print (const Printable &)
 
size_t print (const String &)
 
size_t print (double, int=2)
 
size_t print (int, int=DEC)
 
size_t print (long long, int=DEC)
 
size_t print (long, int=DEC)
 
size_t print (unsigned char, int=DEC)
 
size_t print (unsigned int, int=DEC)
 
size_t print (unsigned long long, int=DEC)
 
size_t print (unsigned long, int=DEC)
 
size_t println (char)
 
size_t println (const __FlashStringHelper *)
 
size_t println (const char[])
 
size_t println (const Printable &)
 
size_t println (const String &s)
 
size_t println (double, int=2)
 
size_t println (int, int=DEC)
 
size_t println (long long, int=DEC)
 
size_t println (long, int=DEC)
 
size_t println (unsigned char, int=DEC)
 
size_t println (unsigned int, int=DEC)
 
size_t println (unsigned long long, int=DEC)
 
size_t println (unsigned long, int=DEC)
 
size_t println (void)
 
size_t write (const char *buffer, size_t size)
 
size_t write (const char *str)
 
virtual size_t write (const uint8_t *buffer, size_t size)
 
virtual size_t write (uint8_t)=0
 
- Public Member Functions inherited from audio_tools::AudioBaseInfoDependent
virtual AudioBaseInfo audioInfo ()=0
 
virtual void setAudioInfo (AudioBaseInfo info)=0
 
virtual bool validate (AudioBaseInfo &info)
 
virtual void setNotifyAudioChange (AudioBaseInfoDependent &bi)=0
 

Protected Member Functions

void commit ()
 
void updateVolume (float tmp, int j)
 
- Protected Member Functions inherited from Print
void setWriteError (int err=1)
 

Protected Attributes

float f_volume = 0
 
float f_volume_tmp = 0
 
AudioBaseInfo info
 
float * volumes =nullptr
 
float * volumes_tmp =nullptr
 
- Protected Attributes inherited from audio_tools::AudioPrint
AudioBaseInfo cfg
 
AudioBaseInfoDependentp_notify =nullptr
 
uint8_t tmp [MAX_SINGLE_CHARS]
 
int tmpPos =0
 

Detailed Description

A simple class to determine the volume.

Author
Phil Schatzmann

Member Function Documentation

◆ setAudioInfo()

void audio_tools::VolumePrint::setAudioInfo ( AudioBaseInfo  info)
inlinevirtual

Reimplemented from audio_tools::AudioPrint.

◆ write()

size_t audio_tools::VolumePrint::write ( const uint8_t *  buffer,
size_t  size 
)
inlinevirtual

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