RecordableSequence Struct Reference

#include <AudioIOSequences.h>

Inheritance diagram for RecordableSequence:

Public Member Functions
virtual	~RecordableSequence ()
virtual sampleFormat	GetSampleFormat () const =0
virtual double	GetRate () const =0
virtual size_t	NChannels () const =0
	A constant property. More...
virtual bool	Append (size_t iChannel, constSamplePtr buffer, sampleFormat format, size_t len, unsigned int stride, sampleFormat effectiveFormat)=0
	Append the sample data to the track. You must call Flush() after the last Append. More...
virtual void	Flush ()=0
	Flush must be called after last Append. More...
virtual void	RepairChannels ()=0
virtual void	InsertSilence (double t, double len)=0

Detailed Description

An interface for recording, by appending sequentially (but it also requires random access for insertion of silence)

Definition at line 42 of file AudioIOSequences.h.

Constructor & Destructor Documentation

~RecordableSequence()

RecordableSequence::~RecordableSequence ( )

virtualdefault

Member Function Documentation

Append()

virtual bool RecordableSequence::Append ( size_t  iChannel, constSamplePtr  buffer, sampleFormat  format, size_t  len, unsigned int  stride, sampleFormat  effectiveFormat  )

pure virtual

Append the sample data to the track. You must call Flush() after the last Append.

Precondition

iChannel < NChannels()

Returns

true in case a block was flushed from memory to underlying DB

Parameters

effectiveFormat

Make the effective format of the data at least the minumum of this value and `format`. (Maybe wider, if merging with preexistent data.) If the data are later narrowed from stored format, but not narrower than the effective, then no dithering will occur.

Implemented in WaveTrack.

Flush()

virtual void RecordableSequence::Flush ( )

pure virtual

Flush must be called after last Append.

Implemented in WaveTrack.

GetRate()

virtual double RecordableSequence::GetRate ( ) const

pure virtual

Implemented in WaveTrack, and WritableSampleTrack.

GetSampleFormat()

virtual sampleFormat RecordableSequence::GetSampleFormat ( ) const

pure virtual

Implemented in WaveTrack.

InsertSilence()

virtual void RecordableSequence::InsertSilence ( double  t, double  len  )

pure virtual

Implemented in WaveTrack.

NChannels()

virtual size_t RecordableSequence::NChannels ( ) const

pure virtual

A constant property.

Postcondition

result: result > 0

Implemented in WaveTrack, and WritableSampleTrack.

RepairChannels()

virtual void RecordableSequence::RepairChannels ( )

pure virtual

Called in exception handling after possibly unbalanced calls to Append in different channels. Allows the sequence to repair consistency.

Implemented in WaveTrack.

---

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

• AudioIOSequences.h
• AudioIOSequences.cpp