A powerfull Web server which is based on https://github.com/pschatzmann/TinyHttp. It supports multiple concurrent clients. You can e.g. use it to write mp3 data and make it available in multiple clients. More...

#include <AudioServerEx.h>

Inheritance diagram for AudioServerEx:

Public Member Functions
	AudioServerEx ()=default

	AudioServerEx (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)

virtual bool	begin (AudioServerExConfig cfg)

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

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.

virtual AudioServerExConfig	defaultConfig ()

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

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 Web server which is based on https://github.com/pschatzmann/TinyHttp. It supports multiple concurrent clients. You can e.g. use it to write mp3 data and make it available in multiple clients.

Note: Supported only on Arduino platforms with WiFi support (e.g. ESP32) and the WiFi library!; Requires: 👉 https://github.com/pschatzmann/TinyHttp

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ AudioServerEx() [1/2]

AudioServerEx ( )

default

◆ AudioServerEx() [2/2]

AudioServerEx	(	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 MP3EncoderShine, PureDataStream, PWMAudioOutput< PWMDriverT >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, and ResampleStreamT< TInterpolator >.

◆ availableForWrite()

int availableForWrite ( )

inlineoverridevirtual

Reimplemented from AudioOutput.

◆ begin() [1/4]

virtual bool begin ( )

inlinevirtual

Reimplemented from AudioOutput.

◆ begin() [2/4]

virtual bool begin ( AudioInfo info )

inlinevirtualinherited

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

◆ begin() [3/4]

virtual bool begin ( AudioServerExConfig cfg )

inlinevirtual

Reimplemented in AudioWAVServerEx.

◆ begin() [4/4]

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

inlinevirtual

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ copy()

virtual void copy ( )

inlinevirtual

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

◆ defaultConfig()

virtual AudioServerExConfig defaultConfig ( )

inlinevirtual

Reimplemented in AudioWAVServerEx.

◆ end()

virtual void end ( )

inlinevirtual

Reimplemented from AudioOutput.

◆ flush()

virtual void flush ( )

inlinevirtualinherited

Reimplemented from Print.

Reimplemented in MultiOutput, and HexDumpOutput.

◆ getReplyHeader()

virtual tinyhttp::StrView * getReplyHeader ( )

inlineprotectedvirtual

Reimplemented in AudioWAVServerEx.

◆ 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, SPIAudioMaster, AdapterAudioStreamToAudioOutput, CsvOutput< T >, PWMAudioOutput< PWMDriverT >, 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
	)

inlineoverridevirtual

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

◆ info

AudioServerExConfig info

protected

◆ 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

protected

◆ p_stream

ExtensionStream* p_stream =nullptr

protected

◆ tmp

SingleBuffer<uint8_t> tmp {MAX_SINGLE_CHARS}

protectedinherited

◆ tmpPos

int tmpPos = 0

protectedinherited

◆ wifi

WiFiServer wifi

protected

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

src/AudioTools/Communication/AudioServerEx.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AudioServerEx() [1/2]

◆ AudioServerEx() [2/2]

Member Function Documentation

◆ addNotifyAudioChange()

◆ audioInfo()

◆ audioInfoOut()

◆ availableForWrite()

◆ begin() [1/4]

◆ begin() [2/4]

◆ begin() [3/4]

◆ begin() [4/4]

◆ clearNotifyAudioChange()

◆ copy()

◆ defaultConfig()

◆ end()

◆ flush()

◆ getReplyHeader()

◆ isDeletable()

◆ isNotifyActive()

◆ notifyAudioChange()

◆ operator bool()

◆ removeNotifyAudioChange()

◆ setAudioInfo()

◆ setNotifyActive()

◆ write() [1/2]

◆ write() [2/2]

◆ writeSilence()

Member Data Documentation

◆ _timeout

◆ cfg

◆ info

◆ is_active

◆ is_notify_active

◆ notify_vector

◆ p_server

◆ p_stream

◆ tmp

◆ tmpPos

◆ wifi