AudioSegment Class Reference

A generalization for audio segments, whether clips or silence between clips. More...

#include <AudioSegment.h>

Inheritance diagram for AudioSegment:

Public Member Functions
virtual	~AudioSegment ()
virtual size_t	GetFloats (float *const *buffers, size_t numSamples)=0
	Fills buffers with as many as numSamples or the number of remaining samples, whichever is smaller. More...
virtual size_t	NChannels () const =0
	The number of channels in the segment. More...
virtual bool	Empty () const =0
	Whether the segment has no more samples to provide. More...

Detailed Description

A generalization for audio segments, whether clips or silence between clips.

---

Audacity: A Digital Audio Editor

AudioSegment.h

Matthieu Hodgkinson

Definition at line 22 of file AudioSegment.h.

Constructor & Destructor Documentation

~AudioSegment()

AudioSegment::~AudioSegment ( )

virtualdefault

Member Function Documentation

Empty()

virtual bool AudioSegment::Empty ( ) const

pure virtual

Whether the segment has no more samples to provide.

Implemented in ClipSegment, SilenceSegment, and NiceAudioSegment.

GetFloats()

virtual size_t AudioSegment::GetFloats ( float *const *  buffers, size_t  numSamples  )

pure virtual

Fills buffers with as many as numSamples or the number of remaining samples, whichever is smaller.

Parameters

buffers	Pointers to buffers, one for each channel.
numSamples	The max. number of samples to write to each buffer.

Returns

The number of samples actually provided in each buffer.

Implemented in NiceAudioSegment, ClipSegment, and SilenceSegment.

NChannels()

virtual size_t AudioSegment::NChannels ( ) const

pure virtual

The number of channels in the segment.

Implemented in ClipSegment, SilenceSegment, and NiceAudioSegment.

---

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

• AudioSegment.h
• AudioSegment.cpp