ZephyrFile Class Reference

Arduino File API for Zephyr. More...

#include <ZephyrFile.h>

Inheritance diagram for ZephyrFile:

Public Member Functions
	ZephyrFile ()
	ZephyrFile (const ZephyrFile &)=delete
	ZephyrFile (ZephyrFile &&other) noexcept
	~ZephyrFile ()
int	available () override
virtual int	availableForWrite ()
void	close ()
void	flush () override
bool	isOpen () const
const char *	name () const
bool	open (const char *file_path, fs_mode_t mode=FS_O_READ)
	operator bool ()
	operator bool () const
ZephyrFile &	operator= (const ZephyrFile &)=delete
ZephyrFile &	operator= (ZephyrFile &&other) noexcept
int	peek () override
size_t	position () const
int	read () override
size_t	readBytes (char *buffer, size_t len)
virtual size_t	readBytes (uint8_t *data, size_t len)
bool	seek (size_t pos)
size_t	size () const
size_t	write (const uint8_t *buffer, size_t len) override
size_t	write (uint8_t value) override

Protected Attributes
int	_timeout = 10

Detailed Description

Arduino File API for Zephyr.

Note

Supported by all Zephyr platforms with FS support!

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

ZephyrFile() [1/3]

ZephyrFile ( )

inline

~ZephyrFile()

~ZephyrFile ( )

inline

ZephyrFile() [2/3]

ZephyrFile ( const ZephyrFile &  )

delete

ZephyrFile() [3/3]

ZephyrFile ( ZephyrFile &&  other )

inlinenoexcept

Member Function Documentation

available()

int available ( )

inlineoverridevirtual

Reimplemented from Stream.

availableForWrite()

virtual int availableForWrite ( )

inlinevirtualinherited

Reimplemented in AudioESP32ULP, AudioLoRa, RTSPOutput< Platform >, SPIAudioMaster, UDPStream, VBANStream, AudioStreamWrapper, ConverterStream< T >, LoRaStream, EncodedAudioOutput, EncodedAudioStream, FaustStream< DSP >, AudioFFTBase, FileOutput, I2SCodecStream, MiniAudioStream, StdioStream, A2DPStream, AudioServerEx, AudioSyncWriter, ESPNowStream, HammingFEC< bytecount, block_t >, AbstractURLStream, URLStreamESP32, NRF24Stream, ReadioHeadStream, ReedSolomonFEC< bytecount, additional_bytes >, SPIAudioSlave, USBAudioDeviceBase, SynchronizedStream, AnalogAudioStream, AudioEffectStreamT< T >, Equalizer3Bands, Equalizer3BandsPerChannel, I2SStream, ReformatBaseStream, AdapterAudioStreamToAudioOutput, TimedStream, AudioOutput, CsvOutput< T >, OutputMixer< T >, MemoryOutput, PWMAudioOutput< PWMDriverT >, MemoryStream, RingBufferStream, MeasuringStream, ProgressStream, Throttle, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, BaseStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, FadeStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, Pipeline, QualityAnalysisStream, VolumeStream, AudioBLEClient, AudioBLEClient, AudioBLEServer, and AudioBLEServer.

close()

void close ( )

inline

flush()

void flush ( )

inlineoverridevirtual

Reimplemented from Print.

isOpen()

bool isOpen ( ) const

inline

name()

const char * name ( ) const

inline

open()

bool open ( const char *  file_path, fs_mode_t  mode = FS_O_READ  )

inline

operator bool() [1/2]

operator bool ( )

inlineinherited

operator bool() [2/2]

operator bool ( ) const

inline

operator=() [1/2]

ZephyrFile & operator= ( const ZephyrFile &  )

delete

operator=() [2/2]

ZephyrFile & operator= ( ZephyrFile &&  other )

inlinenoexcept

peek()

int peek ( )

inlineoverride

position()

size_t position ( ) const

inline

read()

int read ( )

inlineoverride

readBytes() [1/2]

size_t readBytes ( char *  buffer, size_t  len  )

inline

readBytes() [2/2]

virtual size_t readBytes ( uint8_t *  data, size_t  len  )

inlinevirtualinherited

Reimplemented in LMSEchoCancellationStream< T >, MDFEchoCancellationStream< Allocator >, USBAudioDeviceBase, HDLCStream, MozziStream, PureDataStream, AudioLoRa, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, AudioStreamWrapper, VFSFile, LoRaStream, EncodedAudioStream, FaustStream< DSP >, AudioFFTBase, AudioKitStream, AudioMP34DT05, I2SCodecStream, MiniAudioStream, PortAudioStream, StdioStream, TfLiteAudioStream, A2DPStream, AdaptiveResamplingStream, ESPNowStream, HammingFEC< bytecount, block_t >, HLSStreamT< URLStream >, ICYStreamT< T >, URLStream, BufferedTaskStream, URLStreamESP32, NRF24Stream, ReadioHeadStream, ReedSolomonFEC< bytecount, additional_bytes >, SPIAudioSlave, UDPStream, VBANStream, AnalogAudioStream, AudioEffectStreamT< T >, Equalizer3Bands, Equalizer3BandsPerChannel, I2SStream, ReformatBaseStream, TimedStream, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, BufferedStream, ConverterStream< T >, MeasuringStream, ProgressStream, Throttle, InputMixer< T, SumT >, InputMerge< T >, CallbackStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, VolumeMeter, AudioInputMonitor, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, AudioStream, CatStream, NullStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, FadeStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, GoertzelStream, Pipeline, QualityAnalysisStream, VolumeStream, FileLoopT< FileType >, FileLoopT< File >, AudioBLEClient, AudioBLEClient, AudioBLEServer, AudioBLEServer, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, BaseStream, WM8960Stream, AnalogDriverESP32V1::IO16Bit, AnalogDriverESP32V2::IO16Bit, and HttpRequest.

seek()

bool seek ( size_t  pos )

inline

size()

size_t size ( ) const

inline

write() [1/2]

size_t write ( const uint8_t *  buffer, size_t  len  )

inlineoverridevirtual

Reimplemented from Print.

write() [2/2]

size_t write ( uint8_t  value )

inlineoverride

Member Data Documentation

_timeout

int _timeout = 10

protectedinherited

---

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

• src/AudioTools/Disk/ZephyrFile.h