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

Arduino Audio Stream using PortAudio. More...

#include <PortAudioStream.h>

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

Public Member Functions

int available () override
 
bool begin () override
 
bool begin (PortAudioConfig info)
 
PortAudioConfig defaultConfig ()
 
PortAudioConfig defaultConfig (RxTxMode mode)
 
void end () override
 
 operator bool ()
 
size_t readBytes (uint8_t *data, size_t len) override
 
void setAudioInfo (AudioBaseInfo in) override
 notification of audio info change More...
 
size_t write (const uint8_t *data, size_t len) override
 
- 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

PaSampleFormat getFormat (int bitLength)
 
void startStream ()
 automatically start the stream when we start to get data
 
- Protected Member Functions inherited from audio_tools::AudioStream
virtual int not_supported (int out)
 

Protected Attributes

int buffer_size = 10*1024
 
PaError err = paNoError
 
PortAudioConfig info
 
PaStream * stream = nullptr
 
bool stream_started = false
 
- Protected Attributes inherited from audio_tools::AudioStream
AudioBaseInfo info
 
AudioBaseInfoDependentp_notify =nullptr
 

Detailed Description

Arduino Audio Stream using PortAudio.

Member Function Documentation

◆ available()

int audio_tools::PortAudioStream::available ( )
inlineoverridevirtual

Reimplemented from audio_tools::AudioStreamX.

◆ begin()

bool audio_tools::PortAudioStream::begin ( )
inlineoverridevirtual

Reimplemented from audio_tools::AudioStream.

◆ end()

void audio_tools::PortAudioStream::end ( )
inlineoverridevirtual

Reimplemented from audio_tools::AudioStream.

◆ readBytes()

size_t audio_tools::PortAudioStream::readBytes ( uint8_t *  data,
size_t  len 
)
inlineoverridevirtual

Reimplemented from audio_tools::AudioStreamX.

◆ setAudioInfo()

void audio_tools::PortAudioStream::setAudioInfo ( AudioBaseInfo  in)
inlineoverridevirtual

notification of audio info change

Reimplemented from audio_tools::AudioStream.

◆ write()

size_t audio_tools::PortAudioStream::write ( const uint8_t *  data,
size_t  len 
)
inlineoverridevirtual

Reimplemented from audio_tools::AudioStreamX.


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