DSPark 1.8.0
Header-only C++20 DSP for real-time and offline audio
Loading...
Searching...
No Matches
dspark::OfflineAudioSink< T > Class Template Referenceabstract

Transactional worker sink for arbitrarily long offline output. More...

#include <OfflineProcessing.h>

Public Member Functions

virtual ~OfflineAudioSink ()=default
 
virtual bool begin (const OfflineAudioSpec &spec)=0
 
virtual bool write (std::int64_t first, AudioBufferView< const T > block)=0
 
virtual bool commit ()=0
 
virtual void abort () noexcept=0
 

Detailed Description

template<FloatType T>
class dspark::OfflineAudioSink< T >

Transactional worker sink for arbitrarily long offline output.

begin/write/commit return false on failure. abort() must discard all provisional output, including after a failed begin or commit, and must not throw. commit() returning true is the only publication point. A file sink may stage a temporary file; DSPark does not prescribe storage or perform filesystem operations.

Definition at line 231 of file OfflineProcessing.h.

Constructor & Destructor Documentation

◆ ~OfflineAudioSink()

template<FloatType T>
virtual dspark::OfflineAudioSink< T >::~OfflineAudioSink ( )
virtualdefault

Member Function Documentation

◆ abort()

template<FloatType T>
virtual void dspark::OfflineAudioSink< T >::abort ( )
pure virtualnoexcept

◆ begin()

template<FloatType T>
virtual bool dspark::OfflineAudioSink< T >::begin ( const OfflineAudioSpec &  spec)
pure virtual

◆ commit()

template<FloatType T>
virtual bool dspark::OfflineAudioSink< T >::commit ( )
pure virtual

◆ write()

template<FloatType T>
virtual bool dspark::OfflineAudioSink< T >::write ( std::int64_t  first,
AudioBufferView< const T >  block 
)
pure virtual

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