arduino-audio-tools
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
HLSStream Class Reference

HTTP Live Streaming using HLS: The result is a MPEG-TS data stream that must be decoded e.g. with a DecoderMTS. More...

#include <HLSStream.h>

Inheritance diagram for HLSStream:
AudioStream BaseStream AudioInfoSupport AudioInfoSource Stream Print

Public Member Functions

 HLSStream (const char *ssid, const char *password)
 
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 ()
 provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream
 
int available () override
 
virtual int availableForWrite () override
 
bool begin ()
 
bool begin (const char *urlStr)
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
const char * codec ()
 Returns the string representation of the codec of the audio stream.
 
int contentLength ()
 
const char * contentType ()
 
void end ()
 
virtual void flush () override
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
virtual operator bool ()
 
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 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 setBuffer (int size, int count)
 Defines the buffer size.
 
void setLogLevel (AudioLogger::LogLevel level)
 Defines the class specific custom log level.
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
void setPassword (const char *password)
 Sets the password that will be used for logging in (when calling begin)
 
void setSSID (const char *ssid)
 Sets the ssid that will be used for logging in (when calling begin)
 
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).
 

Protected Member Functions

void login ()
 
virtual int not_supported (int out, const char *msg="")
 
void notifyAudioChange (AudioInfo info)
 
void refillReadBuffer ()
 

Protected Attributes

int _timeout = 10
 
AudioInfo info
 
bool is_notify_active = true
 
Vector< AudioInfoSupport * > notify_vector
 
HLSParser parser
 
const char * password = nullptr
 
const char * ssid = nullptr
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 

Detailed Description

HTTP Live Streaming using HLS: The result is a MPEG-TS data stream that must be decoded e.g. with a DecoderMTS.

Author
Phil Schatzmann *@

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