AudioProcessorGraph::Connection Struct Reference

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

Public Member Functions

 Connection (uint32 sourceNodeId, int sourceChannelIndex, uint32 destNodeId, int destChannelIndex) noexcept
 

Public Attributes

uint32 sourceNodeId
 The ID number of the node which is the input source for this connection. More...
 
int sourceChannelIndex
 The index of the output channel of the source node from which this connection takes its data. More...
 
uint32 destNodeId
 The ID number of the node which is the destination for this connection. More...
 
int destChannelIndex
 The index of the input channel of the destination node to which this connection delivers its data. More...
 

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()

AudioProcessorGraph::Connection::Connection ( uint32  sourceNodeId,
int  sourceChannelIndex,
uint32  destNodeId,
int  destChannelIndex 
)
noexcept

Member Data Documentation

◆ sourceNodeId

uint32 AudioProcessorGraph::Connection::sourceNodeId

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

See also
AudioProcessorGraph::getNodeForId

◆ sourceChannelIndex

int 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.

◆ destNodeId

uint32 AudioProcessorGraph::Connection::destNodeId

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

See also
AudioProcessorGraph::getNodeForId

◆ destChannelIndex

int 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.


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