switchboard::AudioGraphNodeState Struct Reference

Holds the state of an audio node inside the AudioGraph instance. More...

#include <AudioGraphNodeState.hpp>

Public Member Functions
	AudioGraphNodeState (const uint numberOfInputBuses, const uint numberOfOutputBuses)
	Creates an AudioGraphNodeState instance.
	~AudioGraphNodeState ()
	AudioGraphNodeState destructor.
uint	getNumberOfInputBuses () const
	Returns the number of input buses for the node.
uint	getNumberOfOutputBuses () const
	Returns the number of output buses for the node.
bool	getIsInputFormatSet () const
	Returns whether input format is completely set for all buses of the audio node.
bool	getIsInputFormatPartlySet () const
	Returns whether input format is set for any buses of the audio node.
bool	getIsOutputFormatSet () const
	Returns whether output format is completely set for all buses of the audio node.
bool	getIsOutputFormatPartlySet () const
	Returns whether output format is set for any buses of the audio node.
	AudioGraphNodeState (const AudioGraphNodeState &)=delete
AudioGraphNodeState &	operator= (const AudioGraphNodeState &)=delete

Public Attributes
AudioBusFormatList *	inputFormat
	Input format of the audio node's buses.
AudioBusFormatList *	outputFormat
	Output format of the audio node's buses.
AudioBusList *	inAudioBuses
	Input buses of the audio node.
AudioBusList *	outAudioBuses
	Output buses of the audio node.
std::vector< AudioGraphNodeConnection * >	inputConnections
	Connections connected to the node's input.
std::vector< AudioGraphNodeConnection * >	outputConnections
	Connections connected to the node's output.

Detailed Description

Holds the state of an audio node inside the AudioGraph instance.

AudioGraphNodeState class.

Constructor & Destructor Documentation

AudioGraphNodeState()

switchboard::AudioGraphNodeState::AudioGraphNodeState	(	const uint	numberOfInputBuses,
		const uint	numberOfOutputBuses
	)

Creates an AudioGraphNodeState instance.

Parameters

numberOfInputBuses	The number of input buses.
numberOfOutputBuses	The number of output buses.

Member Function Documentation

getIsInputFormatPartlySet()

bool switchboard::AudioGraphNodeState::getIsInputFormatPartlySet

(

)

const

Returns whether input format is set for any buses of the audio node.

Returns

True if input format is partly defined, false otherwise.

getIsInputFormatSet()

bool switchboard::AudioGraphNodeState::getIsInputFormatSet

(

)

const

Returns whether input format is completely set for all buses of the audio node.

Returns

True if input format is fully defined, false otherwise.

getIsOutputFormatPartlySet()

bool switchboard::AudioGraphNodeState::getIsOutputFormatPartlySet

(

)

const

Returns whether output format is set for any buses of the audio node.

Returns

True if output format is partly defined, false otherwise.

getIsOutputFormatSet()

bool switchboard::AudioGraphNodeState::getIsOutputFormatSet

(

)

const

Returns whether output format is completely set for all buses of the audio node.

Returns

True if output format is fully defined, false otherwise.

getNumberOfInputBuses()

uint switchboard::AudioGraphNodeState::getNumberOfInputBuses

(

)

const

Returns the number of input buses for the node.

Returns

The number of input buses.

getNumberOfOutputBuses()

uint switchboard::AudioGraphNodeState::getNumberOfOutputBuses

(

)

const

Returns the number of output buses for the node.

Returns

The number of output buses.

---

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

• /Users/jenkins/.jenkins/workspace/Switchboard Developer Site - Production/SwitchboardSDK/src/all/AudioGraph/AudioGraphNodeState.hpp
• /Users/jenkins/.jenkins/workspace/Switchboard Developer Site - Production/SwitchboardSDK/src/all/AudioGraph/AudioGraphNodeState.cpp