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

Encoder for Ogg Container. Encodes a packet for an Ogg container. The Ogg begin segment contains the AudioInfo structure. You can subclass ond overwrite the writeHeader() method to implement your own header logic. When an optional encoder is specified in the constructor we package the encoded data. Dependency: https://github.com/pschatzmann/arduino-libopus. More...

#include <ContainerOgg.h>

Inheritance diagram for OggContainerEncoder:
AudioEncoder AudioWriter AudioInfoSupport OpusOggEncoder

Public Member Functions

 OggContainerEncoder (AudioEncoder &encoder)
 
 OggContainerEncoder (AudioEncoder *encoder)
 
AudioInfo audioInfo ()
 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
 
virtual bool begin () override
 starts the processing using the actual AudioInfo
 
virtual bool begin (AudioInfo from) override
 
void end () override
 stops the processing
 
bool isOpen ()
 
const char * mime () override
 Provides "audio/pcm".
 
 operator bool () override
 
virtual void setAudioInfo (AudioInfo info) override
 We actually do nothing with this.
 
void setOutput (Print &print) override
 Defines the output Stream.
 
virtual size_t write (const uint8_t *data, size_t len) override
 Writes raw data to be encoded and packaged.
 

Protected Member Functions

void setEncoder (AudioEncoder *enc)
 
void setOggOutput (OggContainerOutput *out)
 Replace the ogg output class.
 
void writeBlocking (Print *out, uint8_t *data, size_t len)
 

Protected Attributes

AudioInfo info
 
OggContainerOutput ogg
 
AudioEncoderp_codec = nullptr
 
OggContainerOutputp_ogg = &ogg
 

Detailed Description

Encoder for Ogg Container. Encodes a packet for an Ogg container. The Ogg begin segment contains the AudioInfo structure. You can subclass ond overwrite the writeHeader() method to implement your own header logic. When an optional encoder is specified in the constructor we package the encoded data. Dependency: https://github.com/pschatzmann/arduino-libopus.

Author
Phil Schatzmann

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