AudioWAVServerEx Class Reference

A powerfull WAV Web server which is based on https://github.com/pschatzmann/TinyHttp. It supports multiple concurrent clients. More...

#include <AudioServerEx.h>

Inheritance diagram for AudioWAVServerEx:

Public Member Functions
	AudioWAVServerEx ()=default
	AudioWAVServerEx (const char *ssid, const char *pwd)
	To be compatible with legacy API.
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 ()
int	availableForWrite () override
virtual bool	begin ()
virtual bool	begin (AudioInfo info)
bool	begin (AudioServerExConfig cfg) override
virtual bool	begin (Stream &in, const char *contentType)
bool	begin (Stream &in, int sample_rate, int channels, int bits_per_sample=16)
	Legacy API support.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	copy ()
	Needs to be called if the data was provided as input Stream in the AudioServerExConfig.
AudioServerExConfig	defaultConfig () override
virtual void	end ()
virtual void	flush ()
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.
virtual	operator bool ()
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.
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
size_t	write (const uint8_t *data, size_t len) override
	Web server supports write so that we can e.g. use is as destination for the audio player.
virtual size_t	write (uint8_t ch) override
virtual void	writeSilence (size_t len)

Protected Member Functions
virtual tinyhttp::StrView *	getReplyHeader ()
void	notifyAudioChange (AudioInfo info)

Protected Attributes
int	_timeout = 10
AudioInfo	cfg
tinyhttp::Str	header
AudioServerExConfig	info
bool	is_active = false
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
HttpServer *	p_server
ExtensionStream *	p_stream =nullptr
SingleBuffer< uint8_t >	tmp {MAX_SINGLE_CHARS}
int	tmpPos = 0
WiFiServer	wifi

Detailed Description

A powerfull WAV Web server which is based on https://github.com/pschatzmann/TinyHttp. It supports multiple concurrent clients.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

AudioWAVServerEx() [1/2]

AudioWAVServerEx ( )

default

AudioWAVServerEx() [2/2]

AudioWAVServerEx ( const char *  ssid, const char *  pwd  )

inline

To be compatible with legacy API.

Member Function Documentation

addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, CodecChain, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, RTSPClient< TcpClient, UdpSocket >, Pipeline, and Pipeline::ModifyingStreamAdapter.

audioInfo()

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in AdapterPrintToAudioOutput, EncodedAudioOutput, and AdapterAudioStreamToAudioOutput.

audioInfoOut()

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in PureDataStream, PWMAudioOutput, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, and ResampleStreamT< TInterpolator >.

availableForWrite()

int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from AudioOutput.

begin() [1/5]

virtual bool begin ( )

inlinevirtualinherited

Reimplemented from AudioOutput.

begin() [2/5]

virtual bool begin ( AudioInfo  info )

inlinevirtualinherited

Reimplemented in AudioESP32ULP, RTSPOutput< Platform >, RTTTLOutput< T >, ChannelsSelectOutput, CsvOutput< T >, and EncodedAudioOutput.

begin() [3/5]

bool begin ( AudioServerExConfig  cfg )

inlineoverridevirtual

Reimplemented from AudioServerEx.

begin() [4/5]

virtual bool begin ( Stream &  in, const char *  contentType  )

inlinevirtualinherited

begin() [5/5]

bool begin ( Stream &  in, int  sample_rate, int  channels, int  bits_per_sample = 16  )

inline

Legacy API support.

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

copy()

virtual void copy ( )

inlinevirtualinherited

Needs to be called if the data was provided as input Stream in the AudioServerExConfig.

defaultConfig()

AudioServerExConfig defaultConfig ( )

inlineoverridevirtual

Reimplemented from AudioServerEx.

end()

virtual void end ( )

inlinevirtualinherited

Reimplemented from AudioOutput.

flush()

virtual void flush ( )

inlinevirtualinherited

Reimplemented from Print.

Reimplemented in MultiOutput, and HexDumpOutput.

getReplyHeader()

virtual tinyhttp::StrView * getReplyHeader ( )

inlineprotectedvirtual

Reimplemented from AudioServerEx.

isDeletable()

virtual bool isDeletable ( )

inlinevirtualinherited

If true we need to release the related memory in the destructor.

Reimplemented in AdapterPrintToAudioOutput, and AdapterAudioStreamToAudioOutput.

isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

notifyAudioChange()

void notifyAudioChange ( AudioInfo  info )

inlineprotectedinherited

operator bool()

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in RTSPOutput< Platform >, EncodedAudioOutput, and AdapterAudioStreamToAudioOutput.

removeNotifyAudioChange()

virtual bool removeNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

setAudioInfo()

virtual void setAudioInfo ( AudioInfo  info )

inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

Reimplemented in ChannelsSelectOutput, AdapterPrintToAudioOutput, MultiOutput, AdapterAudioStreamToAudioOutput, CsvOutput< T >, PWMAudioOutput, and EncodedAudioOutput.

setNotifyActive()

void setNotifyActive ( bool  flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active)

write() [1/2]

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtualinherited

Web server supports write so that we can e.g. use is as destination for the audio player.

Implements AudioOutput.

write() [2/2]

virtual size_t write ( uint8_t  ch )

inlineoverridevirtualinherited

Reimplemented in MetaDataOutput, and MultiOutput.

writeSilence()

virtual void writeSilence ( size_t  len )

inlinevirtualinherited

Writes n 0 values (= silence)

Parameters

len

Member Data Documentation

_timeout

int _timeout = 10

protectedinherited

cfg

AudioInfo cfg

protectedinherited

header

tinyhttp::Str header

protected

info

AudioServerExConfig info

protectedinherited

is_active

bool is_active = false

protectedinherited

is_notify_active

bool is_notify_active = true

protectedinherited

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

p_server

HttpServer* p_server

protectedinherited

p_stream

ExtensionStream* p_stream =nullptr

protectedinherited

tmp

SingleBuffer<uint8_t> tmp {MAX_SINGLE_CHARS}

protectedinherited

tmpPos

int tmpPos = 0

protectedinherited

wifi

WiFiServer wifi

protectedinherited

---

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

• src/AudioTools/Communication/AudioServerEx.h