IMultiChannelInput Class Reference

#include <audio/core/multichannel.h>

Public Member Functions
virtual	~IMultiChannelInput ()=default
virtual void	connect (unsigned int channel, OutputPin &pin)
virtual int	getInputChannelCount () const
void	tryConnect (unsigned int channel, OutputPin &pin)
void	connect (IMultiChannelOutput &inputObject)

Description

Interface for any class that exposes multichannel audio input.

Constructor & Destructor Documentation

~IMultiChannelInput()

virtual ~IMultiChannelInput ( )

virtualdefault

Destructor

Member Function Documentation

connect() [1/2]

void connect

(

IMultiChannelOutput &

inputObject

)

Convenience method that connects the outputs of inputObject to the inputs of this object. If this object has more input channels than inputObject has output channels they will be repeated.

Parameters

inputObject

object to be connected to this object

connect() [2/2]

virtual void connect ( unsigned int  channel, OutputPin &  pin  )

virtual

This method has to be overwritten to connect an output pin from another object to this object's input.

Parameters

channel	index of the channel to connect to
pin	pin that will be connected to this object

getInputChannelCount()

virtual int getInputChannelCount ( ) const

virtual

This method has to be overwritten by descendants.

Returns

the number of input channels of audio this object receives.

tryConnect()

void tryConnect	(	unsigned int	channel,
		OutputPin &	pin
	)

This method calls connect() but first checks wether the given channel is not out of bounds.

Parameters

channel	channel index to connect to
pin	pin that will be connected to this object