Abstract class for protocol to control the audio player. More...

#include <AudioPlayerProtocol.h>

Inheritance diagram for AudioPlayerProtocol:

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

AudioPlayer *	p_player = nullptr

Detailed Description

Abstract class for protocol to control the audio player.

Author: Phil Schatzmann

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.

◆ readLine()

int readLine	(	Stream &	in,
		char *	str,
		int	max
	)

inlineprotected

Reads a line delimited by '
' from the stream.

◆ setMaxInputBufferSize()

void setMaxInputBufferSize ( int size )

inline

Defines the input buffer size used by the readLine function (default 256)

◆ setPlayer()

virtual void setPlayer ( AudioPlayer & player )

inlinevirtual

Defines the player.

Reimplemented in KARadioProtocol.

Member Data Documentation

◆ max_input_buffer_size

int max_input_buffer_size = 256

protected

◆ p_player

AudioPlayer* p_player = nullptr