CallbackStream Class Reference

CallbackStream: A Stream that allows to register callback methods for accessing and providing data. The callbacks can be lambda expressions. More...

#include <AudioStreams.h>

Inheritance diagram for CallbackStream:

Public Member Functions
	CallbackStream (Print &out, size_t(*cb_update)(uint8_t *data, size_t len))
	Allows to change the audio before sending it to the output.
	CallbackStream (size_t(*cb_read)(uint8_t *data, size_t len), size_t(*cb_write)(const uint8_t *data, size_t len))
	CallbackStream (Stream &io, size_t(*cb_update)(uint8_t *data, size_t len))
	Allows to change the audio before sending it to the output or before getting it from the original input.
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
virtual AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
	provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream
int	available () override
virtual int	availableForWrite () override
virtual bool	begin () override
virtual bool	begin (AudioInfo info)
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
void	end () override
virtual void	flush () override
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual	operator bool ()
size_t	readBytes (uint8_t *data, size_t len) override
virtual size_t	readSilence (uint8_t *buffer, size_t length)
	Source to generate silence: just sets the buffer to 0.
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
virtual void	setAudioInfo (AudioInfo newInfo) override
	Defines the input AudioInfo.
void	setAvailable (int val)
	optioinally define available bytes for next read
void	setAvailableCallback (int(*cb)())
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
void	setOutput (Print &out)
	Defines/Changes the output target.
void	setOutput (Stream &in)
	same as setStream
void	setReadCallback (size_t(*cb_read)(uint8_t *data, size_t len))
void	setStream (Print &out)
	same as set Output
void	setStream (Stream &in)
	Defines/Changes the input & output.
void	setUpdateCallback (size_t(*cb_update)(uint8_t *data, size_t len))
void	setWriteCallback (size_t(*cb_write)(const uint8_t *data, size_t len))
size_t	write (const uint8_t *data, size_t len) override
virtual size_t	write (uint8_t ch) override
virtual void	writeSilence (size_t len)
	Writes len bytes of silence (=0).

Protected Member Functions
virtual int	not_supported (int out, const char *msg="")
void	notifyAudioChange (AudioInfo info)
void	refillReadBuffer ()

Protected Attributes
int	_timeout = 10
bool	active =true
int	available_bytes = -1
int(*	cb_available )() = nullptr
size_t(*	cb_read )(uint8_t *data, size_t len) = nullptr
size_t(*	cb_update )(uint8_t *data, size_t len) = nullptr
size_t(*	cb_write )(const uint8_t *data, size_t len) = nullptr
AudioInfo	info
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
Print *	p_out = nullptr
Stream *	p_stream = nullptr
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}

Detailed Description

CallbackStream: A Stream that allows to register callback methods for accessing and providing data. The callbacks can be lambda expressions.

Author

Phil Schatzmann

Copyright

GPLv3

---

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

• src/AudioTools/CoreAudio/AudioStreams.h