tracktion::engine::ChannelIndex Struct Reference

Describes a channel of audio by specifying the channel index in a device's audio buffer and the purpose as an AudioChannelSet::ChannelType e.g. More...

#include <tracktion_ChannelConfiguration.h>

Public Member Functions
	ChannelIndex ()
	Creates a default, invalid ChannelIndex.
	ChannelIndex (int indexInDevice, juce::AudioChannelSet::ChannelType)
	Creates a ChannelIndex for a given index and a channel type.
bool	operator== (const ChannelIndex &) const
bool	operator!= (const ChannelIndex &) const

Static Public Member Functions
static ChannelIndex	createMono (int indexInDevice)
	Creates a discrete (mono) channel at the given index.

Public Attributes
int	indexInDevice = -1
juce::AudioChannelSet::ChannelType	channel = juce::AudioChannelSet::unknown

Detailed Description

Describes a channel of audio by specifying the channel index in a device's audio buffer and the purpose as an AudioChannelSet::ChannelType e.g.

left, right, leftSurround etc.

Constructor & Destructor Documentation

ChannelIndex() [1/2]

tracktion::engine::ChannelIndex::ChannelIndex

(

)

Creates a default, invalid ChannelIndex.

ChannelIndex() [2/2]

tracktion::engine::ChannelIndex::ChannelIndex	(	int	indexInDevice,
		juce::AudioChannelSet::ChannelType
	)

Creates a ChannelIndex for a given index and a channel type.

Member Function Documentation

createMono()

static ChannelIndex tracktion::engine::ChannelIndex::createMono ( int  indexInDevice )

static

Creates a discrete (mono) channel at the given index.

operator==()

bool tracktion::engine::ChannelIndex::operator==

(

const ChannelIndex &

)

const

operator!=()

bool tracktion::engine::ChannelIndex::operator!=

(

const ChannelIndex &

)

const

Member Data Documentation

indexInDevice

int tracktion::engine::ChannelIndex::indexInDevice = -1

channel

juce::AudioChannelSet::ChannelType tracktion::engine::ChannelIndex::channel = juce::AudioChannelSet::unknown

---

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

• tracktion_ChannelConfiguration.h