arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
audio_tools::SPDIFStream Class Reference

Output as 16 bit stereo SPDIF on the I2S data output pin. More...

#include <AudioSPDIF.h>

Inheritance diagram for audio_tools::SPDIFStream:
audio_tools::AudioStreamX audio_tools::AudioStream audio_tools::Stream audio_tools::AudioBaseInfoDependent audio_tools::AudioBaseInfoSource audio_tools::Print

Public Member Functions

 SPDIFStream ()=default
 default constructor
 
virtual ~SPDIFStream ()
 destructor
 
bool begin ()
 Starting with default settings. More...
 
bool begin (SPDIFConfig cfg)
 Start with the provided parameters.
 
SPDIFConfig defaultConfig ()
 Provides the default configuration.
 
void end ()
 
void setAudioInfo (AudioBaseInfo info)
 Change the audio parameters. More...
 
size_t write (const uint8_t *src, size_t size)
 Writes the audio data as SPDIF to the defined output pin. More...
 
- Public Member Functions inherited from audio_tools::AudioStreamX
 AudioStreamX (AudioStreamX const &)=delete
 
virtual int available () override
 
AudioStreamXoperator= (AudioStreamX const &)=delete
 
virtual int peek () override
 
virtual int read () override
 
virtual size_t readBytes (uint8_t *buffer, size_t length) override
 
virtual size_t write (const uint8_t *buffer, size_t size) override
 
virtual size_t write (uint8_t) override
 
- Public Member Functions inherited from audio_tools::AudioStream
 AudioStream (AudioStream const &)=delete
 
virtual AudioBaseInfo audioInfo () override
 
virtual int availableForWrite () override
 
virtual bool begin ()
 
virtual void end ()
 
virtual void flush () override
 
 operator bool ()
 
AudioStreamoperator= (AudioStream const &)=delete
 
virtual size_t readBytes (char *buffer, size_t length)
 
virtual size_t readBytes (uint8_t *buffer, size_t length) STREAM_WRITE_OVERRIDE=0
 
virtual void setAudioInfo (AudioBaseInfo info) override
 
virtual void setNotifyAudioChange (AudioBaseInfoDependent &bi) override
 
virtual StreamtoStreamPointer ()
 
virtual size_t write (const uint8_t *buffer, size_t size) override=0
 
- Public Member Functions inherited from audio_tools::Stream
virtual int available ()
 
virtual int peek ()
 
virtual int read ()
 
virtual size_t readBytes (uint8_t *buffer, size_t len)
 
virtual void setTimeout (size_t t)
 
- Public Member Functions inherited from audio_tools::Print
virtual int availableForWrite ()
 
virtual void flush ()
 
virtual int print (char c, PrintCharFmt spec)
 
virtual int print (const char *msg)
 
virtual int print (int number)
 
virtual int println (const char *msg="")
 
virtual size_t write (const char *buffer, size_t size)
 
virtual size_t write (const char *str)
 
virtual size_t write (const uint8_t *buffer, size_t size)
 
virtual size_t write (uint8_t ch)
 
- Public Member Functions inherited from audio_tools::AudioBaseInfoDependent
virtual AudioBaseInfo audioInfo ()=0
 
virtual void setAudioInfo (AudioBaseInfo info)=0
 
virtual bool validate (AudioBaseInfo &info)
 
virtual void setNotifyAudioChange (AudioBaseInfoDependent &bi)=0
 

Protected Member Functions

void spdif_buf_init (void)
 
- Protected Member Functions inherited from audio_tools::AudioStream
virtual int not_supported (int out)
 

Protected Attributes

SPDIFConfig cfg
 
I2SStream i2s
 
bool i2sOn = false
 
- Protected Attributes inherited from audio_tools::AudioStream
AudioBaseInfo info
 
AudioBaseInfoDependentp_notify =nullptr
 

Detailed Description

Output as 16 bit stereo SPDIF on the I2S data output pin.

Author
Phil Schatzmann

Member Function Documentation

◆ begin()

bool audio_tools::SPDIFStream::begin ( )
inlinevirtual

Starting with default settings.

Reimplemented from audio_tools::AudioStream.

◆ end()

void audio_tools::SPDIFStream::end ( )
inlinevirtual

Reimplemented from audio_tools::AudioStream.

◆ setAudioInfo()

void audio_tools::SPDIFStream::setAudioInfo ( AudioBaseInfo  info)
inlinevirtual

Change the audio parameters.

Reimplemented from audio_tools::AudioStream.

◆ write()

size_t audio_tools::SPDIFStream::write ( const uint8_t *  src,
size_t  size 
)
inlinevirtual

Writes the audio data as SPDIF to the defined output pin.

Reimplemented from audio_tools::AudioStreamX.


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