Cinder  0.8.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
cinder::audio::TargetFile Class Referenceabstract

Base class that is used to create and write to an audio destination. Currently only supports .wav encoding. More...

#include <Target.h>

Inheritance diagram for cinder::audio::TargetFile:
[legend]

Public Member Functions

virtual ~TargetFile ()
 
void write (const Buffer *buffer)
 
void write (const Buffer *buffer, size_t numFrames)
 
void write (const Buffer *buffer, size_t numFrames, size_t frameOffset)
 
size_t getSampleRate () const
 
size_t getNumChannels () const
 

Static Public Member Functions

static std::unique_ptr
< TargetFile
create (const DataTargetRef &dataTarget, size_t sampleRate, size_t numChannels, SampleType sampleType=SampleType::INT_16, const std::string &extension="")
 
static std::unique_ptr
< TargetFile
create (const fs::path &path, size_t sampleRate, size_t numChannels, SampleType sampleType=SampleType::INT_16, const std::string &extension="")
 

Protected Member Functions

 TargetFile (const DataTargetRef &dataTarget, size_t sampleRate, size_t numChannels, SampleType sampleType)
 
virtual void performWrite (const Buffer *buffer, size_t numFrames, size_t frameOffset)=0
 

Protected Attributes

size_t mSampleRate
 
size_t mNumChannels
 
SampleType mSampleType
 

Detailed Description

Base class that is used to create and write to an audio destination. Currently only supports .wav encoding.

Constructor & Destructor Documentation

virtual cinder::audio::TargetFile::~TargetFile ( )
virtual
cinder::audio::TargetFile::TargetFile ( const DataTargetRef dataTarget,
size_t  sampleRate,
size_t  numChannels,
SampleType  sampleType 
)
protected

Member Function Documentation

std::unique_ptr< TargetFile > cinder::audio::TargetFile::create ( const DataTargetRef dataTarget,
size_t  sampleRate,
size_t  numChannels,
SampleType  sampleType = SampleType::INT_16,
const std::string extension = "" 
)
static
std::unique_ptr< TargetFile > cinder::audio::TargetFile::create ( const fs::path &  path,
size_t  sampleRate,
size_t  numChannels,
SampleType  sampleType = SampleType::INT_16,
const std::string extension = "" 
)
static
void cinder::audio::TargetFile::write ( const Buffer buffer)
void cinder::audio::TargetFile::write ( const Buffer buffer,
size_t  numFrames 
)
void cinder::audio::TargetFile::write ( const Buffer buffer,
size_t  numFrames,
size_t  frameOffset 
)
size_t cinder::audio::TargetFile::getSampleRate ( ) const
size_t cinder::audio::TargetFile::getNumChannels ( ) const
virtual void cinder::audio::TargetFile::performWrite ( const Buffer buffer,
size_t  numFrames,
size_t  frameOffset 
)
protectedpure virtual

Member Data Documentation

size_t cinder::audio::TargetFile::mSampleRate
protected
size_t cinder::audio::TargetFile::mNumChannels
protected
SampleType cinder::audio::TargetFile::mSampleType
protected

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