arduino-audio-tools
All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Modules Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AudioPlayerProtocol Class Referenceabstract
Inheritance diagram for AudioPlayerProtocol:
KARadioProtocol

Public Member Functions

virtual bool processCommand (const char *input, Print &result)=0
 
virtual bool processCommand (Stream &input, Print &result)
 Proceess commands passed by Stream (e.g. Serial)
 
void setMaxInputBufferSize (int size)
 Defines the input buffer size used by the readLine function (default 256)
 
virtual void setPlayer (AudioPlayer &player)
 Defines the player.
 

Protected Member Functions

int readLine (Stream &in, char *str, int max)
 Reads a line delimited by '
' from the stream.
 

Protected Attributes

int max_input_buffer_size = 256
 
AudioPlayerp_player = nullptr
 

Member Function Documentation

◆ processCommand() [1/2]

virtual bool processCommand ( const char *  input,
Print result 
)
pure virtual

processes the commands and returns the result output via the Print object

Implemented in KARadioProtocol.

◆ processCommand() [2/2]

virtual bool processCommand ( Stream input,
Print result 
)
inlinevirtual

Proceess commands passed by Stream (e.g. Serial)

Reimplemented in KARadioProtocol.

◆ setPlayer()

virtual void setPlayer ( AudioPlayer player)
inlinevirtual

Defines the player.

Reimplemented in KARadioProtocol.


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