A simple wrapper class that lets you use the standard Arduino Print class output commands to send audio data over a WebSocket connection. Uses https://github.com/Links2004/arduinoWebSockets. More...

#include <WebSocketOutput.h>

Inheritance diagram for WebSocketOutput:

Public Member Functions
	WebSocketOutput ()=default

	WebSocketOutput (WebSocketsClient &ws)
	Constructor which defines an alternative WebSocket object. By default we use WebSocket.

	WebSocketOutput (WebSocketsServer &ws)
	Constructor which defines an alternative WebSocket object. By default we use WebSocket.

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 ()

virtual int	availableForWrite () override

virtual bool	begin ()

virtual bool	begin (AudioInfo info)

virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.

virtual void	end ()

virtual void	flush ()

virtual bool	isDeletable ()
	If true we need to release the related memory in the destructor.

bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.

virtual	operator bool ()

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	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)

void	setTargetNo (int clientNo)
	For WebSocketServer we can define an individual recipient!

void	setWebSocket (WebSocketsClient &ws)
	Defines an alternative WebSocket object. By default we use WebSocket.

void	setWebSocket (WebSocketsServer &ws)
	Defines an alternative WebSocket object. By default we use WebSocket.

size_t	write (const uint8_t *data, size_t len) override
	Replys will be sent to the initial remote caller.

virtual size_t	write (uint8_t ch) override

virtual void	writeSilence (size_t len)

Protected Member Functions
void	notifyAudioChange (AudioInfo info)

Protected Attributes
int	_timeout = 10

AudioInfo	cfg

int	clientNo = -1

bool	is_active = false

bool	is_notify_active = true

Vector< AudioInfoSupport * >	notify_vector

WebSocketsClient *	p_ws = nullptr

WebSocketsServer *	p_ws_server = nullptr

SingleBuffer< uint8_t >	tmp {MAX_SINGLE_CHARS}

int	tmpPos = 0

Detailed Description

A simple wrapper class that lets you use the standard Arduino Print class output commands to send audio data over a WebSocket connection. Uses https://github.com/Links2004/arduinoWebSockets.

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ WebSocketOutput() [1/3]

WebSocketOutput ( )

default

◆ WebSocketOutput() [2/3]

WebSocketOutput ( WebSocketsClient & ws )

inline

Constructor which defines an alternative WebSocket object. By default we use WebSocket.

◆ WebSocketOutput() [3/3]

WebSocketOutput ( WebSocketsServer & ws )

inline

Constructor which defines an alternative WebSocket object. By default we use WebSocket.

Member Function Documentation

◆ addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, CodecChain, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, RTSPClient< TcpClient, UdpSocket >, Pipeline, and Pipeline::ModifyingStreamAdapter.

◆ audioInfo()

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in AdapterPrintToAudioOutput, EncodedAudioOutput, and AdapterAudioStreamToAudioOutput.

◆ audioInfoOut()

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

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

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

◆ availableForWrite()

virtual int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in AudioESP32ULP, RTSPOutput< Platform >, EncodedAudioOutput, AudioServerEx, AudioSyncWriter, AdapterAudioStreamToAudioOutput, CsvOutput< T >, MemoryOutput, and PWMAudioOutput.

◆ begin() [1/2]

virtual bool begin ( )

inlinevirtualinherited

Reimplemented in OSCContainerEncoder::OSCOutput, AudioOutputWithCallback, AudioServerEx, RTSPOutput< Platform >, PitchShiftOutput< T, BufferT >, PWMAudioOutput, RTTTLOutput< T >, EncodedAudioOutput, OggContainerOutput, FFTEffect, FFTPitchShift, R2ROutput, AdapterAudioStreamToAudioOutput, ChannelsSelectOutput, MetaDataFilter, CsvOutput< T >, HexDumpOutput, MemoryOutput, and RTTTLOutput< T >.

◆ begin() [2/2]

virtual bool begin ( AudioInfo info )

inlinevirtualinherited

Reimplemented in AudioESP32ULP, RTSPOutput< Platform >, RTTTLOutput< T >, ChannelsSelectOutput, CsvOutput< T >, and EncodedAudioOutput.

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ end()

virtual void end ( )

inlinevirtualinherited

Reimplemented in AudioESP32ULP, AudioServerEx, AudioSyncWriter, RTSPOutput< Platform >, PitchShiftOutput< T, BufferT >, MetaDataOutput, EncodedAudioOutput, OggContainerOutput, AdapterAudioStreamToAudioOutput, MetaDataFilter, and PWMAudioOutput.

◆ flush()

virtual void flush ( )

inlinevirtualinherited

Reimplemented from Print.

Reimplemented in MultiOutput, and HexDumpOutput.

◆ isDeletable()

virtual bool isDeletable ( )

inlinevirtualinherited

If true we need to release the related memory in the destructor.

Reimplemented in AdapterPrintToAudioOutput, and AdapterAudioStreamToAudioOutput.

◆ isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ notifyAudioChange()

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ operator bool()

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in RTSPOutput< Platform >, EncodedAudioOutput, and AdapterAudioStreamToAudioOutput.

◆ removeNotifyAudioChange()

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

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

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ setAudioInfo()

virtual void setAudioInfo ( AudioInfo info )

inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

Reimplemented in ChannelsSelectOutput, AdapterPrintToAudioOutput, MultiOutput, AdapterAudioStreamToAudioOutput, CsvOutput< T >, PWMAudioOutput, and EncodedAudioOutput.

◆ setNotifyActive()

void setNotifyActive ( bool flag )

inlineinherited

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

◆ setTargetNo()

void setTargetNo ( int clientNo )

inline

For WebSocketServer we can define an individual recipient!

◆ setWebSocket() [1/2]

void setWebSocket ( WebSocketsClient & ws )

inline

Defines an alternative WebSocket object. By default we use WebSocket.

◆ setWebSocket() [2/2]

void setWebSocket ( WebSocketsServer & ws )

inline

Defines an alternative WebSocket object. By default we use WebSocket.

◆ write() [1/2]

size_t write	(	const uint8_t *	data,
		size_t	len
	)

inlineoverridevirtual

Replys will be sent to the initial remote caller.

Implements AudioOutput.

◆ write() [2/2]

virtual size_t write ( uint8_t ch )

inlineoverridevirtualinherited

Reimplemented in MetaDataOutput, and MultiOutput.

◆ writeSilence()

virtual void writeSilence ( size_t len )

inlinevirtualinherited

Writes n 0 values (= silence)

Parameters

len

Member Data Documentation

◆ _timeout

int _timeout = 10

protectedinherited

◆ cfg

AudioInfo cfg

protectedinherited

◆ clientNo

int clientNo = -1

protected

◆ is_active

bool is_active = false

protectedinherited

◆ is_notify_active

bool is_notify_active = true

protectedinherited

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

◆ p_ws

WebSocketsClient* p_ws = nullptr

protected

◆ p_ws_server

WebSocketsServer* p_ws_server = nullptr

protected

◆ tmp

SingleBuffer<uint8_t> tmp {MAX_SINGLE_CHARS}

protectedinherited

◆ tmpPos

int tmpPos = 0

protectedinherited

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

src/AudioTools/Communication/WebSocketOutput.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ WebSocketOutput() [1/3]

◆ WebSocketOutput() [2/3]

◆ WebSocketOutput() [3/3]

Member Function Documentation

◆ addNotifyAudioChange()

◆ audioInfo()

◆ audioInfoOut()

◆ availableForWrite()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clearNotifyAudioChange()

◆ end()

◆ flush()

◆ isDeletable()

◆ isNotifyActive()

◆ notifyAudioChange()

◆ operator bool()

◆ removeNotifyAudioChange()

◆ setAudioInfo()

◆ setNotifyActive()

◆ setTargetNo()

◆ setWebSocket() [1/2]

◆ setWebSocket() [2/2]

◆ write() [1/2]

◆ write() [2/2]

◆ writeSilence()

Member Data Documentation

◆ _timeout

◆ cfg

◆ clientNo

◆ is_active

◆ is_notify_active

◆ notify_vector

◆ p_ws

◆ p_ws_server

◆ tmp

◆ tmpPos