Audacity 3.2.0
Classes | Enumerations | Functions
AudioGraph Namespace Reference

Classes

class  Buffers
 Accumulates (non-interleaved) data during effect processing. More...
 
struct  Channel
 
class  Sink
 Downstream receiver of sample streams, taking Buffers as external context. More...
 
class  Source
 Upstream producer of sample streams, taking Buffers as external context. More...
 
struct  Task
 Copies from a Source to a Sink, mediated by Buffers. More...
 

Enumerations

enum  ChannelType : unsigned { MonoChannel , LeftChannel , RightChannel }
 Mutually exclusive channel classifications. More...
 

Functions

bool IsMono (const Channel &channel)
 Whether the channel is mono. More...
 
bool PlaysLeft (const Channel &channel)
 Whether the channel may play through a left speaker. More...
 
bool PlaysRight (const Channel &channel)
 Whether the channel may play through a right speaker. More...
 

Enumeration Type Documentation

◆ ChannelType

enum AudioGraph::ChannelType : unsigned

Mutually exclusive channel classifications.

Enumerator
MonoChannel 
LeftChannel 
RightChannel 

Definition at line 18 of file AudioGraphChannel.h.

Function Documentation

◆ IsMono()

bool AudioGraph::IsMono ( const Channel channel)
inline

Whether the channel is mono.

Definition at line 32 of file AudioGraphChannel.h.

32 {
33 return channel.GetChannelType() == MonoChannel;
34}
virtual ChannelType GetChannelType() const =0
Classify this channel.

References AudioGraph::Channel::GetChannelType(), and MonoChannel.

Referenced by ExportMixerDialog::ExportMixerDialog(), MixAndRender(), EffectLoudness::Process(), and Mixer::Process().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ PlaysLeft()

bool AudioGraph::PlaysLeft ( const Channel channel)
inline

Whether the channel may play through a left speaker.

Definition at line 37 of file AudioGraphChannel.h.

37 {
38 const auto type = channel.GetChannelType();
39 return type == MonoChannel || type == LeftChannel;
40}

References AudioGraph::Channel::GetChannelType(), LeftChannel, and MonoChannel.

Here is the call graph for this function:

◆ PlaysRight()

bool AudioGraph::PlaysRight ( const Channel channel)
inline

Whether the channel may play through a right speaker.

Definition at line 42 of file AudioGraphChannel.h.

42 {
43 const auto type = channel.GetChannelType();
44 return type == MonoChannel || type == RightChannel;
45}

References AudioGraph::Channel::GetChannelType(), MonoChannel, and RightChannel.

Here is the call graph for this function: