DownmixSource Class Reference

Describes an input source for DownmixStage Decorates an AudioGraph::Source with operations that are necessary to perform down mixing, which are: number of source channels, per-channel gain, channel mapping. More...

#include <DownmixSource.h>

Inheritance diagram for DownmixSource:

Public Member Functions
	DownmixSource ()=default
virtual	~DownmixSource ()=default
virtual AudioGraph::Source &	GetDownstream () const =0
	Returns underlying AudioGraph::Source processed by Mixer. More...
virtual size_t	NChannels () const =0
	Number of output channels of the underlying Source. More...
virtual float	GetChannelGain (size_t channel) const =0
	Gain multiplier that should be applied to the channel. More...
virtual void	FindChannelFlags (unsigned char *channelFlags, size_t numChannels, size_t iChannel)=0
virtual bool	CanMakeMono () const =0
	Returns true if source channels could be combined into mono if needed. More...

Detailed Description

Describes an input source for DownmixStage Decorates an AudioGraph::Source with operations that are necessary to perform down mixing, which are: number of source channels, per-channel gain, channel mapping.

Definition at line 24 of file DownmixSource.h.

Constructor & Destructor Documentation

DownmixSource()

DownmixSource::DownmixSource ( )

default

~DownmixSource()

virtual DownmixSource::~DownmixSource ( )

virtualdefault

Member Function Documentation

CanMakeMono()

virtual bool DownmixSource::CanMakeMono ( ) const

pure virtual

Returns true if source channels could be combined into mono if needed.

Implemented in SequenceDownmixSource, and SimpleDonwmixSource.

FindChannelFlags()

virtual void DownmixSource::FindChannelFlags ( unsigned char *  channelFlags, size_t  numChannels, size_t  iChannel  )

pure virtual

For the given iChannel fills the channelFlags array, that describes to which output it should go.

Implemented in SequenceDownmixSource, and SimpleDonwmixSource.

GetChannelGain()

virtual float DownmixSource::GetChannelGain ( size_t  channel ) const

pure virtual

Gain multiplier that should be applied to the channel.

Implemented in SequenceDownmixSource, and SimpleDonwmixSource.

GetDownstream()

virtual AudioGraph::Source & DownmixSource::GetDownstream ( ) const

pure virtual

Returns underlying AudioGraph::Source processed by Mixer.

Implemented in SequenceDownmixSource, and SimpleDonwmixSource.

NChannels()

virtual size_t DownmixSource::NChannels ( ) const

pure virtual

Number of output channels of the underlying Source.

Implemented in SequenceDownmixSource, and SimpleDonwmixSource.

---

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

• DownmixSource.h