Transmit and receive data via BLE using a Serial API. The following additional experimental features are offered: setFramed(true) tries to keep the original write sizes; setAudioInfoActive(true) informs about changes in the audio info. More...

#include <AudioBLEStream.h>

Inheritance diagram for AudioBLEStream:

Public Member Functions
	AudioBLEStream (int defaultMTU)
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
virtual AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
virtual AudioInfo	audioInfoOut ()
virtual int	available () override
virtual int	available () override
virtual int	availableForWrite () override
virtual int	availableForWrite () override
virtual bool	begin ()
virtual bool	begin ()
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual bool	connected ()=0
virtual void	end ()=0
virtual void	flush () override
virtual void	flush () override
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
	operator bool ()
virtual size_t	readBytes (uint8_t *data, size_t len) override
virtual 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 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 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	setAudioInfo (AudioInfo info)
void	setAudioInfoActive (bool flag)
void	setAudioInfoUUID (const char *uuid)
void	setFramed (bool flag)
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active).
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active).
void	setRxUUID (const char *uuid)
void	setServiceUUID (const char *uuid)
void	setTxUUID (const char *uuid)
void	setWriteBufferSize (int size)
void	setWriteBufferSize (int size)
AudioInfo	toInfo (const uint8_t *str)
StrView	toStr (AudioInfo info)
virtual size_t	write (const uint8_t *data, size_t len) override
virtual 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).
virtual void	writeSilence (size_t len)
	Writes len bytes of silence (=0).

Protected Member Functions
	AudioBLEStream (AudioBLEStream const &other)=delete
virtual int	getMTU ()=0
virtual int	not_supported (int out, const char *msg="")
virtual int	not_supported (int out, const char *msg="")
void	notifyAudioChange (AudioInfo info)
void	notifyAudioChange (AudioInfo info)
void	operator= (AudioBLEStream const &other)=delete
void	refillReadBuffer ()
	Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read().
void	refillReadBuffer ()
	Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read().
virtual void	setAudioInfo (const uint8_t *data, size_t size)
virtual void	writeAudioInfoCharacteristic (AudioInfo info)=0

Protected Attributes
int	_timeout = 10
char	audio_info_str [40]
const char *	BLE_AUDIO_SERVICE_UUID = "6e400001-b5a3-f393-e0a9-e50e24dcca9e"
const char *	BLE_CH1_UUID = "6e400002-b5a3-f393-e0a9-e50e24dcca9e"
const char *	BLE_CH2_UUID = "6e400003-b5a3-f393-e0a9-e50e24dcca9e"
const char *	BLE_INFO_UUID = "6e400004-b5a3-f393-e0a9-e50e24dcca9e"
const char *	ble_server_name = nullptr
AudioInfo	info
bool	is_audio_info_active = false
bool	is_framed = false
bool	is_notify_active = true
bool	is_started = false
uint16_t	max_transfer_size = 0
Vector< AudioInfoSupport * >	notify_vector
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}
int	write_buffer_size = 8

Detailed Description

Transmit and receive data via BLE using a Serial API. The following additional experimental features are offered: setFramed(true) tries to keep the original write sizes; setAudioInfoActive(true) informs about changes in the audio info.

Author: Phil Schatzmann

Constructor & Destructor Documentation

◆ AudioBLEStream() [1/2]

AudioBLEStream ( int defaultMTU )

inline

◆ AudioBLEStream() [2/2]

AudioBLEStream ( AudioBLEStream const & other )

protecteddelete

Member Function Documentation

◆ addNotifyAudioChange() [1/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

◆ addNotifyAudioChange() [2/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

◆ audioInfo() [1/2]

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

◆ audioInfo() [2/2]

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

◆ audioInfoOut() [1/2]

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, FormatConverterStream, MP3EncoderShine, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PureDataStream, PWMAudioOutput< PWMDriverT >, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

◆ audioInfoOut() [2/2]

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, FormatConverterStream, MP3EncoderShine, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PureDataStream, PWMAudioOutput< PWMDriverT >, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

◆ available() [1/2]

virtual int available ( )

inlineoverridevirtualinherited

Reimplemented from Stream.

Reimplemented in A2DPStream, AnalogAudioStream, AudioStreamWrapper, AudioStreamWrapper, BufferedStream, BufferedStream, CallbackStream, CallbackStream, CatStream, CatStream, ConverterStream< T >, ConverterStream< T >, DynamicMemoryStream, DynamicMemoryStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMerge< T >, InputMerge< T >, InputMixer< T, SumT >, InputMixer< T, SumT >, MemoryStream, MemoryStream, ProgressStream, ProgressStream, QueueStream< T >, QueueStream< T >, QueueStream< uint8_t >, ReformatBaseStream, RingBufferStream, RingBufferStream, Throttle, Throttle, TimedStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, AudioEffectStream, AudioEffectStreamT< T >, AudioFFTBase, AudioKitStream, AudioLoRa, AudioMP34DT05, AudioStreamWrapper, AutomaticGainControlStream, BufferedStream, BufferedTaskStream, CallbackStream, CatStream, ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, ConverterStream< T >, DynamicMemoryStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, ESPNowStream, FadeStream, FaustStream< DSP >, FileLoopT< FileType >, FileLoopT< File >, FilteredStream< T, TF >, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, GeneratedSoundStream< T >, HammingFEC< bytecount, block_t >, HLSStreamT< URLStream >, HLSStreamT< URLStreamESP32 >, HttpRequest, I2SCodecStream, I2SStream, ICYStreamT< T >, ICYStreamT< URLStream >, ICYStreamT< URLStreamESP32 >, InputMerge< T >, InputMixer< T, SumT >, MeasuringStream, MemoryStream, MiniAudioStream, NRF24Stream, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, Pipeline::ModifyingStreamAdapter, ProgressStream, QualityAnalysisStream, QueueStream< T >, ReedSolomonFEC< bytecount, additional_bytes >, ReformatBaseStream, RingBufferStream, SPIAudioSlave, StdioStream, SupportedRatesStream, TfLiteAudioStream, Throttle, TimedStream, UDPStream, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, URLStreamBufferedT< ICYStreamESP32 >, URLStreamBufferedT< URLStream >, URLStreamBufferedT< URLStreamESP32 >, USBAudioStreamBase, VBANStream, and VolumeStream.

◆ available() [2/2]

virtual int available ( )

inlineoverridevirtualinherited

Reimplemented from Stream.

Reimplemented in A2DPStream, AnalogAudioStream, AudioStreamWrapper, AudioStreamWrapper, BufferedStream, BufferedStream, CallbackStream, CallbackStream, CatStream, CatStream, ConverterStream< T >, ConverterStream< T >, DynamicMemoryStream, DynamicMemoryStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMerge< T >, InputMerge< T >, InputMixer< T, SumT >, InputMixer< T, SumT >, MemoryStream, MemoryStream, ProgressStream, ProgressStream, QueueStream< T >, QueueStream< T >, QueueStream< uint8_t >, ReformatBaseStream, RingBufferStream, RingBufferStream, Throttle, Throttle, TimedStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, AudioEffectStream, AudioEffectStreamT< T >, AudioFFTBase, AudioKitStream, AudioLoRa, AudioMP34DT05, AudioStreamWrapper, AutomaticGainControlStream, BufferedStream, BufferedTaskStream, CallbackStream, CatStream, ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, ConverterStream< T >, DynamicMemoryStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, ESPNowStream, FadeStream, FaustStream< DSP >, FileLoopT< FileType >, FileLoopT< File >, FilteredStream< T, TF >, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, GeneratedSoundStream< T >, HammingFEC< bytecount, block_t >, HLSStreamT< URLStream >, HLSStreamT< URLStreamESP32 >, HttpRequest, I2SCodecStream, I2SStream, ICYStreamT< T >, ICYStreamT< URLStream >, ICYStreamT< URLStreamESP32 >, InputMerge< T >, InputMixer< T, SumT >, MeasuringStream, MemoryStream, MiniAudioStream, NRF24Stream, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, Pipeline::ModifyingStreamAdapter, ProgressStream, QualityAnalysisStream, QueueStream< T >, ReedSolomonFEC< bytecount, additional_bytes >, ReformatBaseStream, RingBufferStream, SPIAudioSlave, StdioStream, SupportedRatesStream, TfLiteAudioStream, Throttle, TimedStream, UDPStream, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, URLStreamBufferedT< ICYStreamESP32 >, URLStreamBufferedT< URLStream >, URLStreamBufferedT< URLStreamESP32 >, USBAudioStreamBase, VBANStream, and VolumeStream.

◆ availableForWrite() [1/2]

virtual int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in A2DPStream, AbstractURLStream, AnalogAudioStream, AudioStreamWrapper, AudioStreamWrapper, ConverterStream< T >, ConverterStream< T >, DynamicMemoryStream, DynamicMemoryStream, EncodedAudioStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, MemoryStream, MemoryStream, ProgressStream, ProgressStream, QueueStream< T >, QueueStream< T >, QueueStream< uint8_t >, ReformatBaseStream, RingBufferStream, RingBufferStream, Throttle, Throttle, TimedStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, AudioEffectStream, AudioEffectStreamT< T >, AudioFFTBase, AudioLoRa, AudioStreamWrapper, AutomaticGainControlStream, ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, ConverterStream< T >, DynamicMemoryStream, EncodedAudioStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, ESPNowStream, FadeStream, FaustStream< DSP >, FilteredStream< T, TF >, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, HammingFEC< bytecount, block_t >, I2SCodecStream, I2SStream, MeasuringStream, MemoryStream, MiniAudioStream, NRF24Stream, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, ProgressStream, QualityAnalysisStream, QueueStream< T >, ReedSolomonFEC< bytecount, additional_bytes >, ReformatBaseStream, RingBufferStream, SPIAudioSlave, StdioStream, SupportedRatesStream, Throttle, TimedStream, UDPStream, URLStreamESP32, USBAudioStreamBase, VBANStream, and VolumeStream.

◆ availableForWrite() [2/2]

virtual int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in A2DPStream, AbstractURLStream, AnalogAudioStream, AudioStreamWrapper, AudioStreamWrapper, ConverterStream< T >, ConverterStream< T >, DynamicMemoryStream, DynamicMemoryStream, EncodedAudioStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, MemoryStream, MemoryStream, ProgressStream, ProgressStream, QueueStream< T >, QueueStream< T >, QueueStream< uint8_t >, ReformatBaseStream, RingBufferStream, RingBufferStream, Throttle, Throttle, TimedStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, AudioEffectStream, AudioEffectStreamT< T >, AudioFFTBase, AudioLoRa, AudioStreamWrapper, AutomaticGainControlStream, ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, ConverterStream< T >, DynamicMemoryStream, EncodedAudioStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, ESPNowStream, FadeStream, FaustStream< DSP >, FilteredStream< T, TF >, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, HammingFEC< bytecount, block_t >, I2SCodecStream, I2SStream, MeasuringStream, MemoryStream, MiniAudioStream, NRF24Stream, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, ProgressStream, QualityAnalysisStream, QueueStream< T >, ReedSolomonFEC< bytecount, additional_bytes >, ReformatBaseStream, RingBufferStream, SPIAudioSlave, StdioStream, SupportedRatesStream, Throttle, TimedStream, UDPStream, URLStreamESP32, USBAudioStreamBase, VBANStream, and VolumeStream.

◆ begin() [1/2]

virtual bool begin ( )

inlinevirtualinherited

Reimplemented in AdapterAudioOutputToAudioStream, AdaptiveResamplingStream, AnalogAudioStream, AdapterAudioOutputToAudioStream, AudioInputMonitor, AudioInputMonitor, AudioStreamWrapper, AudioStreamWrapper, AudioTimeSourceStream, CallbackStream, CallbackStream, CatStream, CatStream, DynamicMemoryStream, DynamicMemoryStream, EncodedAudioStream, FilteredStream< T, TF >, FilteredStream< T, TF >, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMerge< T >, InputMerge< T >, MemoryStream, MemoryStream, ProgressStream, ProgressStream, QueueStream< T >, QueueStream< T >, QueueStream< uint8_t >, Throttle, Throttle, TimedStream, TimerCallbackAudioStream, TimerCallbackAudioStream, VolumeMeter, VolumeMeter, AudioBoardStream, AudioEffectStream, AudioEffectStreamT< T >, AudioFFTBase, AudioInputMonitor, AudioKitStream, AudioLoRa, AudioMP34DT05, AudioOutputWithCallback, AudioStreamWrapper, AudioTimeSourceStream, AutomaticGainControlStream, CallbackStream, CatStream, ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, DynamicMemoryStream, EncodedAudioStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, ESPNowStream, FileLoopT< FileType >, FileLoopT< File >, FilteredStream< T, TF >, FormatConverterStream, FrequencyDetectorAutoCorrelation, GeneratedSoundStream< T >, GoertzelStream, HLSStreamT< URLStream >, HLSStreamT< URLStreamESP32 >, I2SCodecStream, I2SStream, InputMerge< T >, MeasuringStream, MemoryStream, MiniAudioStream, MozziStream, NRF24Stream, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, Pipeline::ModifyingStreamAdapter, PortAudioStream, ProgressStream, PureDataStream, QualityAnalysisStream, QueueStream< T >, ResampleStream, ResampleStreamT< TInterpolator >, SPDIFOutput, StdioStream, SupportedRatesStream, Throttle, TimedStream, TimerCallbackAudioStream, USBAudioDeviceBase, USBAudioHostBase, VBANStream, VolumeMeter, VolumeStream, VS1053Stream, and WM8960Stream.

◆ begin() [2/2]

virtual bool begin ( )

inlinevirtualinherited

Reimplemented in AdapterAudioOutputToAudioStream, AdaptiveResamplingStream, AnalogAudioStream, AdapterAudioOutputToAudioStream, AudioInputMonitor, AudioInputMonitor, AudioStreamWrapper, AudioStreamWrapper, AudioTimeSourceStream, CallbackStream, CallbackStream, CatStream, CatStream, DynamicMemoryStream, DynamicMemoryStream, EncodedAudioStream, FilteredStream< T, TF >, FilteredStream< T, TF >, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMerge< T >, InputMerge< T >, MemoryStream, MemoryStream, ProgressStream, ProgressStream, QueueStream< T >, QueueStream< T >, QueueStream< uint8_t >, Throttle, Throttle, TimedStream, TimerCallbackAudioStream, TimerCallbackAudioStream, VolumeMeter, VolumeMeter, AudioBoardStream, AudioEffectStream, AudioEffectStreamT< T >, AudioFFTBase, AudioInputMonitor, AudioKitStream, AudioLoRa, AudioMP34DT05, AudioOutputWithCallback, AudioStreamWrapper, AudioTimeSourceStream, AutomaticGainControlStream, CallbackStream, CatStream, ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, DynamicMemoryStream, EncodedAudioStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, ESPNowStream, FileLoopT< FileType >, FileLoopT< File >, FilteredStream< T, TF >, FormatConverterStream, FrequencyDetectorAutoCorrelation, GeneratedSoundStream< T >, GoertzelStream, HLSStreamT< URLStream >, HLSStreamT< URLStreamESP32 >, I2SCodecStream, I2SStream, InputMerge< T >, MeasuringStream, MemoryStream, MiniAudioStream, MozziStream, NRF24Stream, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, Pipeline::ModifyingStreamAdapter, PortAudioStream, ProgressStream, PureDataStream, QualityAnalysisStream, QueueStream< T >, ResampleStream, ResampleStreamT< TInterpolator >, SPDIFOutput, StdioStream, SupportedRatesStream, Throttle, TimedStream, TimerCallbackAudioStream, USBAudioDeviceBase, USBAudioHostBase, VBANStream, VolumeMeter, VolumeStream, VS1053Stream, and WM8960Stream.

◆ clearNotifyAudioChange() [1/2]

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

◆ clearNotifyAudioChange() [2/2]

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

◆ connected()

virtual bool connected ( )

pure virtual

Implemented in AudioBLEClient, AudioBLEClient, AudioBLEServer, and AudioBLEServer.

◆ end()

virtual void end ( )

pure virtual

Reimplemented from BaseStream.

Implemented in AudioBLEClient, AudioBLEClient, AudioBLEServer, and AudioBLEServer.

◆ flush() [1/2]

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in AudioStreamWrapper, AudioStreamWrapper, BufferedStream, BufferedStream, EncodedAudioStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, MemoryStream, MemoryStream, QueueStream< T >, QueueStream< T >, QueueStream< uint8_t >, ReformatBaseStream, RingBufferStream, RingBufferStream, TimedStream, AudioEffectStream, AudioEffectStreamT< T >, AudioStreamWrapper, AutomaticGainControlStream, BufferedStream, BufferedTaskStream, EncodedAudioStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, FadeStream, FilteredStream< T, TF >, GeneratedSoundStream< T >, I2SStream, MeasuringStream, MemoryStream, Pipeline::ModifyingStreamAdapter, PureDataStream, QualityAnalysisStream, QueueStream< T >, ReformatBaseStream, ResampleStream, RingBufferStream, SupportedRatesStream, TimedStream, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, URLStreamBufferedT< ICYStreamESP32 >, URLStreamBufferedT< URLStream >, URLStreamBufferedT< URLStreamESP32 >, and VolumeStream.

◆ flush() [2/2]

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in AudioStreamWrapper, AudioStreamWrapper, BufferedStream, BufferedStream, EncodedAudioStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, MemoryStream, MemoryStream, QueueStream< T >, QueueStream< T >, QueueStream< uint8_t >, ReformatBaseStream, RingBufferStream, RingBufferStream, TimedStream, AudioEffectStream, AudioEffectStreamT< T >, AudioStreamWrapper, AutomaticGainControlStream, BufferedStream, BufferedTaskStream, EncodedAudioStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, FadeStream, FilteredStream< T, TF >, GeneratedSoundStream< T >, I2SStream, MeasuringStream, MemoryStream, Pipeline::ModifyingStreamAdapter, PureDataStream, QualityAnalysisStream, QueueStream< T >, ReformatBaseStream, ResampleStream, RingBufferStream, SupportedRatesStream, TimedStream, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, URLStreamBufferedT< ICYStreamESP32 >, URLStreamBufferedT< URLStream >, URLStreamBufferedT< URLStreamESP32 >, and VolumeStream.

◆ getMTU()

virtual int getMTU ( )

protectedpure virtual

Implemented in AudioBLEClient, AudioBLEServer, and AudioBLEServer.

◆ isNotifyActive() [1/2]

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ isNotifyActive() [2/2]

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ not_supported() [1/2]

virtual int not_supported	(	int	out,
		const char *	msg = "" )

inlineprotectedvirtualinherited

◆ not_supported() [2/2]

virtual int not_supported	(	int	out,
		const char *	msg = "" )

inlineprotectedvirtualinherited

◆ notifyAudioChange() [1/2]

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ notifyAudioChange() [2/2]

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ operator bool()

operator bool ( )

inlinevirtual

Reimplemented from AudioStream.

◆ operator=()

void operator= ( AudioBLEStream const & other )

protecteddelete

◆ readBytes() [1/2]

virtual size_t readBytes	(	uint8_t *	data,
		size_t	len )

inlineoverridevirtualinherited

Implements BaseStream.

Reimplemented in A2DPStream, AdaptiveResamplingStream, AnalogAudioStream, AnalogDriverESP32V1::IO16Bit, AnalogDriverESP32V2::IO16Bit, AudioInputMonitor, AudioInputMonitor, AudioStreamWrapper, AudioStreamWrapper, AudioTimeSourceStream, BufferedStream, BufferedStream, CallbackStream, CallbackStream, ConverterStream< T >, ConverterStream< T >, EncodedAudioStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMerge< T >, InputMerge< T >, InputMixer< T, SumT >, InputMixer< T, SumT >, MemoryStream, MemoryStream, ProgressStream, ProgressStream, ReformatBaseStream, RingBufferStream, RingBufferStream, Throttle, Throttle, TimedStream, VolumeMeter, VolumeMeter, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, AudioEffectStream, AudioEffectStreamT< T >, AudioFFTBase, AudioInputMonitor, AudioKitStream, AudioLoRa, AudioMP34DT05, AudioStreamWrapper, AudioTimeSourceStream, AutomaticGainControlStream, BufferedStream, BufferedTaskStream, CallbackStream, ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, ConverterStream< T >, EncodedAudioStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, FadeStream, FaustStream< DSP >, FilteredStream< T, TF >, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, GeneratedSoundStream< T >, GoertzelStream, HLSStreamT< URLStream >, HLSStreamT< URLStreamESP32 >, I2SCodecStream, I2SStream, ICYStreamT< T >, ICYStreamT< URLStream >, ICYStreamT< URLStreamESP32 >, InputMerge< T >, InputMixer< T, SumT >, LMSEchoCancellationStream< T >, MDFEchoCancellationStream< T, SampleType >, MeasuringStream, MemoryStream, MiniAudioStream, MozziStream, NRF24Stream, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PortAudioStream, ProgressStream, PureDataStream, QualityAnalysisStream, ReformatBaseStream, RingBufferStream, SPIAudioSlave, SupportedRatesStream, TfLiteAudioStream, Throttle, TimedStream, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, URLStreamBufferedT< ICYStreamESP32 >, URLStreamBufferedT< URLStream >, URLStreamBufferedT< URLStreamESP32 >, URLStreamESP32, USBAudioStreamBase, VBANStream, VolumeMeter, VolumeStream, and WM8960Stream.

◆ readBytes() [2/2]

virtual size_t readBytes	(	uint8_t *	data,
		size_t	len )

inlineoverridevirtualinherited

Implements BaseStream.

Reimplemented in A2DPStream, AdaptiveResamplingStream, AnalogAudioStream, AnalogDriverESP32V1::IO16Bit, AnalogDriverESP32V2::IO16Bit, AudioInputMonitor, AudioInputMonitor, AudioStreamWrapper, AudioStreamWrapper, AudioTimeSourceStream, BufferedStream, BufferedStream, CallbackStream, CallbackStream, ConverterStream< T >, ConverterStream< T >, EncodedAudioStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, InputMerge< T >, InputMerge< T >, InputMixer< T, SumT >, InputMixer< T, SumT >, MemoryStream, MemoryStream, ProgressStream, ProgressStream, ReformatBaseStream, RingBufferStream, RingBufferStream, Throttle, Throttle, TimedStream, VolumeMeter, VolumeMeter, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, AudioEffectStream, AudioEffectStreamT< T >, AudioFFTBase, AudioInputMonitor, AudioKitStream, AudioLoRa, AudioMP34DT05, AudioStreamWrapper, AudioTimeSourceStream, AutomaticGainControlStream, BufferedStream, BufferedTaskStream, CallbackStream, ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, ConverterStream< T >, EncodedAudioStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, FadeStream, FaustStream< DSP >, FilteredStream< T, TF >, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, GeneratedSoundStream< T >, GoertzelStream, HLSStreamT< URLStream >, HLSStreamT< URLStreamESP32 >, I2SCodecStream, I2SStream, ICYStreamT< T >, ICYStreamT< URLStream >, ICYStreamT< URLStreamESP32 >, InputMerge< T >, InputMixer< T, SumT >, LMSEchoCancellationStream< T >, MDFEchoCancellationStream< T, SampleType >, MeasuringStream, MemoryStream, MiniAudioStream, MozziStream, NRF24Stream, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PortAudioStream, ProgressStream, PureDataStream, QualityAnalysisStream, ReformatBaseStream, RingBufferStream, SPIAudioSlave, SupportedRatesStream, TfLiteAudioStream, Throttle, TimedStream, URLStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, URLStreamBufferedT< ICYStreamESP32 >, URLStreamBufferedT< URLStream >, URLStreamBufferedT< URLStreamESP32 >, URLStreamESP32, USBAudioStreamBase, VBANStream, VolumeMeter, VolumeStream, and WM8960Stream.

◆ readSilence() [1/2]

virtual size_t readSilence	(	uint8_t *	buffer,
		size_t	length )

inlinevirtualinherited

Source to generate silence: just sets the buffer to 0.

◆ readSilence() [2/2]

virtual size_t readSilence	(	uint8_t *	buffer,
		size_t	length )

inlinevirtualinherited

Source to generate silence: just sets the buffer to 0.

◆ refillReadBuffer() [1/2]

void refillReadBuffer ( )

inlineprotectedinherited

Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read().

◆ refillReadBuffer() [2/2]

void refillReadBuffer ( )

inlineprotectedinherited

Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read().

◆ removeNotifyAudioChange() [1/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

◆ removeNotifyAudioChange() [2/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

◆ setAudioInfo() [1/3]

virtual void setAudioInfo ( AudioInfo info )

inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

Reimplemented in AdapterAudioOutputToAudioStream, AudioInputMonitor, AudioInputMonitor, CallbackStream, CallbackStream, EncodedAudioStream, GeneratedSoundStream< T >, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, ProgressStream, ProgressStream, TimedStream, TimerCallbackAudioStream, TimerCallbackAudioStream, VolumeMeter, and VolumeMeter.

◆ setAudioInfo() [2/3]

void setAudioInfo ( AudioInfo info )

inline

◆ setAudioInfo() [3/3]

virtual void setAudioInfo	(	const uint8_t *	data,
		size_t	size )

inlineprotectedvirtual

◆ setAudioInfoActive()

void setAudioInfoActive ( bool flag )

inline

◆ setAudioInfoUUID()

void setAudioInfoUUID ( const char * uuid )

inline

◆ setFramed()

void setFramed ( bool flag )

inline

◆ setNotifyActive() [1/2]

void setNotifyActive ( bool flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active).

◆ setNotifyActive() [2/2]

void setNotifyActive ( bool flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active).

◆ setRxUUID()

void setRxUUID ( const char * uuid )

inline

◆ setServiceUUID()

void setServiceUUID ( const char * uuid )

inline

◆ setTxUUID()

void setTxUUID ( const char * uuid )

inline

◆ setWriteBufferSize() [1/2]

void setWriteBufferSize ( int size )

inlineinherited

◆ setWriteBufferSize() [2/2]

void setWriteBufferSize ( int size )

inlineinherited

◆ toInfo()

AudioInfo toInfo ( const uint8_t * str )

inline

◆ toStr()

StrView toStr ( AudioInfo info )

inline

◆ write() [1/3]

virtual size_t write	(	const uint8_t *	data,
		size_t	len )

inlineoverridevirtualinherited

Implements BaseStream.

Reimplemented in A2DPStream, AdapterAudioOutputToAudioStream, AdaptiveResamplingStream, AnalogAudioStream, AnalogDriverESP32V1::IO16Bit, AnalogDriverESP32V2::IO16Bit, AdapterAudioOutputToAudioStream, AudioInputMonitor, AudioInputMonitor, AudioStreamWrapper, AudioStreamWrapper, AudioTimeSourceStream, BufferedStream, BufferedStream, CallbackStream, CallbackStream, ConverterStream< T >, ConverterStream< T >, EncodedAudioStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, MemoryStream, MemoryStream, ProgressStream, ProgressStream, RingBufferStream, RingBufferStream, Throttle, Throttle, TimedStream, VolumeMeter, VolumeMeter, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, AudioEffectStream, AudioEffectStreamT< T >, AudioFFTBase, AudioInputMonitor, AudioKitStream, AudioLoRa, AudioStreamWrapper, AudioTimeSourceStream, AutomaticGainControlStream, BufferedStream, BufferedTaskStream, CallbackStream, ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, ConverterStream< T >, EncodedAudioStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, ESP3288AudioOutput, FadeStream, FaustStream< DSP >, FilteredStream< T, TF >, FormatConverterStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, GoertzelStream, I2SCodecStream, I2SStream, LMSEchoCancellationStream< T >, MDFEchoCancellationStream< T, SampleType >, MeasuringStream, MemoryStream, MiniAudioStream, MozziStream, NRF24Stream, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline::ModifyingStreamAdapter, Pipeline, PortAudioStream, ProgressStream, PureDataStream, QualityAnalysisStream, ResampleStream, ResampleStreamT< TInterpolator >, RingBufferStream, SPDIFOutput, SPIAudioSlave, SupportedRatesStream, TfLiteAudioStream, TfLiteAudioStreamBase, Throttle, TimedStream, URLStream, URLStreamESP32, USBAudioStreamBase, VBANStream, VolumeMeter, VolumeStream, VS1053Stream, and WM8960Stream.

◆ write() [2/3]

virtual size_t write	(	const uint8_t *	data,
		size_t	len )

inlineoverridevirtualinherited

Implements BaseStream.

Reimplemented in A2DPStream, AdapterAudioOutputToAudioStream, AdaptiveResamplingStream, AnalogAudioStream, AnalogDriverESP32V1::IO16Bit, AnalogDriverESP32V2::IO16Bit, AdapterAudioOutputToAudioStream, AudioInputMonitor, AudioInputMonitor, AudioStreamWrapper, AudioStreamWrapper, AudioTimeSourceStream, BufferedStream, BufferedStream, CallbackStream, CallbackStream, ConverterStream< T >, ConverterStream< T >, EncodedAudioStream, FilteredStream< T, TF >, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, MemoryStream, MemoryStream, ProgressStream, ProgressStream, RingBufferStream, RingBufferStream, Throttle, Throttle, TimedStream, VolumeMeter, VolumeMeter, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, AudioEffectStream, AudioEffectStreamT< T >, AudioFFTBase, AudioInputMonitor, AudioKitStream, AudioLoRa, AudioStreamWrapper, AudioTimeSourceStream, AutomaticGainControlStream, BufferedStream, BufferedTaskStream, CallbackStream, ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, ConverterStream< T >, EncodedAudioStream, Equalizer3BandsPerChannelT< T >, Equalizer3BandsPerChannelT< float >, Equalizer3BandsT< T >, Equalizer3BandsT< float >, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, ESP3288AudioOutput, FadeStream, FaustStream< DSP >, FilteredStream< T, TF >, FormatConverterStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, GoertzelStream, I2SCodecStream, I2SStream, LMSEchoCancellationStream< T >, MDFEchoCancellationStream< T, SampleType >, MeasuringStream, MemoryStream, MiniAudioStream, MozziStream, NRF24Stream, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline::ModifyingStreamAdapter, Pipeline, PortAudioStream, ProgressStream, PureDataStream, QualityAnalysisStream, ResampleStream, ResampleStreamT< TInterpolator >, RingBufferStream, SPDIFOutput, SPIAudioSlave, SupportedRatesStream, TfLiteAudioStream, TfLiteAudioStreamBase, Throttle, TimedStream, URLStream, URLStreamESP32, USBAudioStreamBase, VBANStream, VolumeMeter, VolumeStream, VS1053Stream, and WM8960Stream.

◆ write() [3/3]

virtual size_t write ( uint8_t ch )

inlineoverridevirtualinherited

Reimplemented in AudioStreamWrapper, AudioStreamWrapper, BufferedStream, BufferedStream, MemoryStream, MemoryStream, RingBufferStream, RingBufferStream, AudioStreamWrapper, BufferedStream, BufferedTaskStream, MemoryStream, RingBufferStream, and URLStream.

◆ writeAudioInfoCharacteristic()

virtual void writeAudioInfoCharacteristic ( AudioInfo info )

protectedpure virtual

Implemented in AudioBLEClient, AudioBLEClient, AudioBLEServer, and AudioBLEServer.

◆ writeSilence() [1/2]

virtual void writeSilence ( size_t len )

inlinevirtualinherited

Writes len bytes of silence (=0).

◆ writeSilence() [2/2]

virtual void writeSilence ( size_t len )

inlinevirtualinherited

Writes len bytes of silence (=0).

Member Data Documentation

◆ _timeout

int _timeout = 10

protectedinherited

◆ audio_info_str

char audio_info_str[40]

protected

◆ BLE_AUDIO_SERVICE_UUID

const char* BLE_AUDIO_SERVICE_UUID = "6e400001-b5a3-f393-e0a9-e50e24dcca9e"

protected

◆ BLE_CH1_UUID

const char* BLE_CH1_UUID = "6e400002-b5a3-f393-e0a9-e50e24dcca9e"

protected

◆ BLE_CH2_UUID

const char* BLE_CH2_UUID = "6e400003-b5a3-f393-e0a9-e50e24dcca9e"

protected

◆ BLE_INFO_UUID

const char* BLE_INFO_UUID = "6e400004-b5a3-f393-e0a9-e50e24dcca9e"

protected

◆ ble_server_name

const char* ble_server_name = nullptr

protected

◆ info

AudioInfo info

protectedinherited

◆ is_audio_info_active

bool is_audio_info_active = false

protected

◆ is_framed

bool is_framed = false

protected

◆ is_notify_active

bool is_notify_active = true

protectedinherited

◆ is_started

bool is_started = false

protected

◆ max_transfer_size

uint16_t max_transfer_size = 0

protected

◆ notify_vector

Vector< AudioInfoSupport * > notify_vector

protectedinherited

◆ tmp_in

RingBuffer< uint8_t > tmp_in {0}

protectedinherited

◆ tmp_out

RingBuffer< uint8_t > tmp_out {0}

protectedinherited

◆ write_buffer_size

int write_buffer_size = 8

protectedinherited

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

src/AudioTools/Sandbox/BLE/AudioBLEStream.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AudioBLEStream() [1/2]

◆ AudioBLEStream() [2/2]

Member Function Documentation

◆ addNotifyAudioChange() [1/2]

◆ addNotifyAudioChange() [2/2]

◆ audioInfo() [1/2]

◆ audioInfo() [2/2]

◆ audioInfoOut() [1/2]

◆ audioInfoOut() [2/2]

◆ available() [1/2]

◆ available() [2/2]

◆ availableForWrite() [1/2]

◆ availableForWrite() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ clearNotifyAudioChange() [1/2]

◆ clearNotifyAudioChange() [2/2]

◆ connected()

◆ end()

◆ flush() [1/2]

◆ flush() [2/2]

◆ getMTU()

◆ isNotifyActive() [1/2]

◆ isNotifyActive() [2/2]

◆ not_supported() [1/2]

◆ not_supported() [2/2]

◆ notifyAudioChange() [1/2]

◆ notifyAudioChange() [2/2]

◆ operator bool()

◆ operator=()

◆ readBytes() [1/2]

◆ readBytes() [2/2]

◆ readSilence() [1/2]

◆ readSilence() [2/2]

◆ refillReadBuffer() [1/2]

◆ refillReadBuffer() [2/2]

◆ removeNotifyAudioChange() [1/2]

◆ removeNotifyAudioChange() [2/2]

◆ setAudioInfo() [1/3]

◆ setAudioInfo() [2/3]

◆ setAudioInfo() [3/3]

◆ setAudioInfoActive()

◆ setAudioInfoUUID()

◆ setFramed()

◆ setNotifyActive() [1/2]

◆ setNotifyActive() [2/2]

◆ setRxUUID()

◆ setServiceUUID()

◆ setTxUUID()

◆ setWriteBufferSize() [1/2]

◆ setWriteBufferSize() [2/2]

◆ toInfo()

◆ toStr()

◆ write() [1/3]

◆ write() [2/3]

◆ write() [3/3]

◆ writeAudioInfoCharacteristic()

◆ writeSilence() [1/2]

◆ writeSilence() [2/2]

Member Data Documentation

◆ _timeout

◆ audio_info_str

◆ BLE_AUDIO_SERVICE_UUID

◆ BLE_CH1_UUID

◆ BLE_CH2_UUID

◆ BLE_INFO_UUID

◆ ble_server_name

◆ info

◆ is_audio_info_active

◆ is_framed

◆ is_notify_active

◆ is_started

◆ max_transfer_size

◆ notify_vector

◆ tmp_in