LMMS
Loading...
Searching...
No Matches
water::AudioProcessorGraph::Connection Struct Reference

#include <AudioProcessorGraph.h>

Public Member Functions

 Connection (ChannelType channelType, uint32 sourceNodeId, uint sourceChannelIndex, uint32 destNodeId, uint destChannelIndex) noexcept

Public Attributes

ChannelType channelType
uint32 sourceNodeId
uint sourceChannelIndex
uint32 destNodeId
uint destChannelIndex

Detailed Description

Represents a connection between two channels of two nodes in an AudioProcessorGraph.

To create a connection, use AudioProcessorGraph::addConnection().

Constructor & Destructor Documentation

◆ Connection()

water::AudioProcessorGraph::Connection::Connection ( ChannelType channelType,
uint32 sourceNodeId,
uint sourceChannelIndex,
uint32 destNodeId,
uint destChannelIndex )
noexcept

Member Data Documentation

◆ channelType

ChannelType water::AudioProcessorGraph::Connection::channelType

Defines the connection type.

◆ destChannelIndex

uint water::AudioProcessorGraph::Connection::destChannelIndex

The index of the input channel of the destination node to which this connection delivers its data.

If this value is the special number AudioProcessorGraph::midiChannelIndex, then it is referring to the destination node's midi input. Otherwise, it is the zero-based index of an audio input channel in the destination node.

◆ destNodeId

uint32 water::AudioProcessorGraph::Connection::destNodeId

The ID number of the node which is the destination for this connection.

See also
AudioProcessorGraph::getNodeForId

◆ sourceChannelIndex

uint water::AudioProcessorGraph::Connection::sourceChannelIndex

The index of the output channel of the source node from which this connection takes its data.

If this value is the special number AudioProcessorGraph::midiChannelIndex, then it is referring to the source node's midi output. Otherwise, it is the zero-based index of an audio output channel in the source node.

◆ sourceNodeId

uint32 water::AudioProcessorGraph::Connection::sourceNodeId

The ID number of the node which is the input source for this connection.

See also
AudioProcessorGraph::getNodeForId

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