AudioServerT< Client, Server > Class Template Reference

A simple Arduino Webserver which streams the result This class is based on the WiFiServer class. All you need to do is to provide the data with a callback method or from an Arduino Stream: in -copy> client. More...

#include <AudioServerT.h>

Inheritance diagram for AudioServerT< Client, Server >:

Public Member Functions
	AudioServerT (const char *network, const char *password, int port=80)
	Construct a new Audio WAV Server object.
	AudioServerT (int port=80)
	Construct a new Audio Server object We assume that the WiFi is already connected.
bool	begin (AudioServerDataCallback cb, const char *contentType)
	Start the server. The data must be provided by a callback method.
bool	begin (Stream &in, const char *contentType)
	Start the server. You need to be connected to WiFI before calling this method.
bool	copy ()
	Add this method to your loop Returns true while the client is connected. (The same functionality like doLoop())
bool	doLoop ()
	Add this method to your loop Returns true while the client is connected.
bool	isClientConnected ()
	Checks if any clinent has connnected.
Stream &	out ()
	Provides the output stream.
Client *	out_ptr ()
	Provides a pointer to the WiFiClient.
void	setConverter (BaseConverter *c)
	defines a converter that will be used when the audio is rendered
void	setCopyBufferSize (int size)
	Changes the copy buffer size.

Protected Member Functions
void	connectWiFi ()
void	processClient ()
virtual void	sendReplyContent ()
virtual void	sendReplyHeader ()
void	setupServer (int port)

Protected Attributes
AudioServerDataCallback	callback = nullptr
Client	client_obj
const char *	content_type = nullptr
BaseConverter *	converter_ptr = nullptr
StreamCopy	copier
Stream *	in = nullptr
size_t	max_bytes = 0
char *	network = nullptr
char *	password = nullptr
size_t	sent = 0
Server	server

Detailed Description

template<class Client, class Server>
class audio_tools::AudioServerT< Client, Server >

A simple Arduino Webserver which streams the result This class is based on the WiFiServer class. All you need to do is to provide the data with a callback method or from an Arduino Stream: in -copy> client.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

AudioServerT() [1/2]

template<class Client , class Server >

AudioServerT ( int  port = 80 )

inline

Construct a new Audio Server object We assume that the WiFi is already connected.

AudioServerT() [2/2]

template<class Client , class Server >

AudioServerT ( const char *  network, const char *  password, int  port = 80  )

inline

Construct a new Audio WAV Server object.

Parameters

network
password

Member Function Documentation

begin() [1/2]

template<class Client , class Server >

bool begin ( AudioServerDataCallback  cb, const char *  contentType  )

inline

Start the server. The data must be provided by a callback method.

Parameters

cb
contentType	Mime Type of result

begin() [2/2]

template<class Client , class Server >

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

inline

Start the server. You need to be connected to WiFI before calling this method.

Parameters

in
contentType	Mime Type of result

connectWiFi()

template<class Client , class Server >

void connectWiFi ( )

inlineprotected

copy()

template<class Client , class Server >

bool copy ( )

inline

Add this method to your loop Returns true while the client is connected. (The same functionality like doLoop())

Returns

true

false

doLoop()

template<class Client , class Server >

bool doLoop ( )

inline

Add this method to your loop Returns true while the client is connected.

isClientConnected()

template<class Client , class Server >

bool isClientConnected ( )

inline

Checks if any clinent has connnected.

out()

template<class Client , class Server >

Stream & out ( )

inline

Provides the output stream.

out_ptr()

template<class Client , class Server >

Client * out_ptr ( )

inline

Provides a pointer to the WiFiClient.

processClient()

template<class Client , class Server >

void processClient ( )

inlineprotected

sendReplyContent()

template<class Client , class Server >

virtual void sendReplyContent ( )

inlineprotectedvirtual

Reimplemented in AudioEncoderServerT< Client, Server >.

sendReplyHeader()

template<class Client , class Server >

virtual void sendReplyHeader ( )

inlineprotectedvirtual

Reimplemented in AudioEncoderServerT< Client, Server >.

setConverter()

template<class Client , class Server >

void setConverter ( BaseConverter *  c )

inline

defines a converter that will be used when the audio is rendered

setCopyBufferSize()

template<class Client , class Server >

void setCopyBufferSize ( int  size )

inline

Changes the copy buffer size.

setupServer()

template<class Client , class Server >

void setupServer ( int  port )

inlineprotected

Member Data Documentation

callback

template<class Client , class Server >

AudioServerDataCallback callback = nullptr

protected

client_obj

template<class Client , class Server >

Client client_obj

protected

content_type

template<class Client , class Server >

const char* content_type = nullptr

protected

converter_ptr

template<class Client , class Server >

BaseConverter* converter_ptr = nullptr

protected

copier

template<class Client , class Server >

StreamCopy copier

protected

in

template<class Client , class Server >

Stream* in = nullptr

protected

max_bytes

template<class Client , class Server >

size_t max_bytes = 0

protected

network

template<class Client , class Server >

char* network = nullptr

protected

password

template<class Client , class Server >

char* password = nullptr

protected

sent

template<class Client , class Server >

size_t sent = 0

protected

server

template<class Client , class Server >

Server server

protected

---

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

• src/AudioTools/Communication/HTTP/AudioServerT.h