Audacity 3.2.0
Public Member Functions | List of all members
PlayableSequence Struct Referenceabstract

#include <AudioIOSequences.h>

Inheritance diagram for PlayableSequence:
[legend]
Collaboration diagram for PlayableSequence:
[legend]

Public Member Functions

 ~PlayableSequence () override
 
virtual const ChannelGroupFindChannelGroup () const =0
 Find associated ChannelGroup if any. More...
 
virtual bool GetSolo () const =0
 May vary asynchronously. More...
 
virtual bool GetMute () const =0
 May vary asynchronously. More...
 
- Public Member Functions inherited from WideSampleSequence
virtual ~WideSampleSequence ()
 
virtual size_t NChannels () const =0
 A constant property. More...
 
virtual float GetChannelGain (int channel) const =0
 
bool GetFloats (size_t iChannel, size_t nBuffers, float *const buffers[], sampleCount start, size_t len, bool backwards=false, fillFormat fill=FillFormat::fillZero, bool mayThrow=true, sampleCount *pNumWithinClips=nullptr) const
 
virtual bool DoGet (size_t iChannel, size_t nBuffers, const samplePtr buffers[], sampleFormat format, sampleCount start, size_t len, bool backward, fillFormat fill=FillFormat::fillZero, bool mayThrow=true, sampleCount *pNumWithinClips=nullptr) const =0
 
virtual double GetStartTime () const =0
 
virtual double GetEndTime () const =0
 
virtual double GetRate () const =0
 
sampleCount TimeToLongSamples (double t0) const
 
double LongSamplesToTime (sampleCount pos) const
 
double SnapToSample (double t) const
 
virtual sampleFormat WidestEffectiveFormat () const =0
 
virtual bool HasTrivialEnvelope () const =0
 
virtual void GetEnvelopeValues (double *buffer, size_t bufferLen, double t0, bool backwards) const =0
 
- Public Member Functions inherited from AudioGraph::Channel
virtual ~Channel ()
 
virtual ChannelType GetChannelType () const =0
 Classify this channel. More...
 

Detailed Description

Extends the interface for random access into a sample stream with tests for muting and solo

Definition at line 22 of file AudioIOSequences.h.

Constructor & Destructor Documentation

◆ ~PlayableSequence()

PlayableSequence::~PlayableSequence ( )
overridedefault

Member Function Documentation

◆ FindChannelGroup()

virtual const ChannelGroup * PlayableSequence::FindChannelGroup ( ) const
pure virtual

Find associated ChannelGroup if any.

Implemented in StretchingSequence, MockPlayableSequence, and WaveTrack.

Referenced by StretchingSequence::FindChannelGroup().

Here is the caller graph for this function:

◆ GetMute()

virtual bool PlayableSequence::GetMute ( ) const
pure virtual

May vary asynchronously.

Implemented in StretchingSequence, MockPlayableSequence, and WaveTrack.

Referenced by StretchingSequence::GetMute(), and AudioIoCallback::SequenceShouldBeSilent().

Here is the caller graph for this function:

◆ GetSolo()

virtual bool PlayableSequence::GetSolo ( ) const
pure virtual

May vary asynchronously.

Implemented in StretchingSequence, MockPlayableSequence, and WaveTrack.

Referenced by StretchingSequence::GetSolo(), and AudioIoCallback::SequenceShouldBeSilent().

Here is the caller graph for this function:

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