RTSPSourceStream Class Reference

Simple Facade which can turn any Stream into a IAudioSource. This way we can e.g. use an I2SStream as source to stream data Depends on the https://github.com/pschatzmann/Micro-RTSP-Audio/ library. More...

#include <RTSP.h>

Inheritance diagram for RTSPSourceStream:

Public Member Functions
	RTSPSourceStream (Stream &stream, AudioInfo info)
	Construct a new RTSPOutputSource object from an Arduino Stream You need to provide the audio information by calling setAudioInfo()
	RTSPSourceStream (Stream &stream, RTSPFormat &format)
	Construct a new RTSPOutputSource object from an Arduino Stream You need to provide the audio information by calling setAudioInfo()
virtual RTSPFormat *	getFormat () override
virtual int	readBytes (void *dest, int byteCount) override
virtual void	setAudioInfo (AudioInfo info)
	Set the Audio Info. This needs to be called if we just pass a Stream. The AudioStream is usually able to provide the data from it's original configuration.
void	setFragmentSize (int fragmentSize)
void	setTimerPeriod (int period)
virtual void	start () override
virtual void	stop () override

Protected Attributes
bool	active = true
RTSPFormatPCM	format {rtp_info}
Stream *	p_stream = nullptr
RTSPPCMAudioInfo	rtp_info

Detailed Description

Simple Facade which can turn any Stream into a IAudioSource. This way we can e.g. use an I2SStream as source to stream data Depends on the https://github.com/pschatzmann/Micro-RTSP-Audio/ library.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

RTSPSourceStream() [1/2]

RTSPSourceStream ( Stream &  stream, AudioInfo  info  )

inline

Construct a new RTSPOutputSource object from an Arduino Stream You need to provide the audio information by calling setAudioInfo()

Parameters

stream
info

RTSPSourceStream() [2/2]

RTSPSourceStream ( Stream &  stream, RTSPFormat &  format  )

inline

Construct a new RTSPOutputSource object from an Arduino Stream You need to provide the audio information by calling setAudioInfo()

Parameters

stream
format

Member Function Documentation

readBytes()

virtual int readBytes ( void *  dest, int  byteCount  )

inlineoverridevirtual

(Reads and) Copies up to maxSamples samples into the given buffer

Returns

actual number of samples that were copied

setAudioInfo()

virtual void setAudioInfo ( AudioInfo  info )

inlinevirtual

Set the Audio Info. This needs to be called if we just pass a Stream. The AudioStream is usually able to provide the data from it's original configuration.

Parameters

info

start()

virtual void start ( )

inlineoverridevirtual

Start preparing data in order to provide it for the stream

stop()

virtual void stop ( )

inlineoverridevirtual

Stop preparing data as the stream has ended

---

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

• src/AudioTools/AudioLibs/RTSP.h