arduino-audio-tools
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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 <AudioServer.h>

Inheritance diagram for AudioServerT< Client, Server >:
AudioEncoderServer AudioWAVServer

Public Member Functions

 AudioServerT (const char *network, const char *password, int port=80)
 Construct a new Audio WAV Server object. More...
 
 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. More...
 
bool begin (Stream &in, const char *contentType)
 Start the server. You need to be connected to WiFI before calling this method. More...
 
bool copy ()
 Add this method to your loop Returns true while the client is connected. (The same functionality like doLoop()) More...
 
bool doLoop ()
 Add this method to your loop Returns true while the client is connected.
 
bool isClientConnected ()
 Checks if any clinent has connnected.
 
Streamout ()
 Provides the output stream.
 
Clientout_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
 
BaseConverterconverter_ptr = nullptr
 
StreamCopy copier
 
Streamin = nullptr
 
char * network = nullptr
 
char * password = nullptr
 
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

Constructor & Destructor Documentation

◆ AudioServerT()

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]

bool begin ( AudioServerDataCallback  cb,
const char *  contentType 
)
inline

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

Parameters
cb
contentTypeMime Type of result

◆ begin() [2/2]

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

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

Parameters
in
contentTypeMime Type of result

◆ copy()

bool copy ( )
inline

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

Returns
true
false

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