Cinder  0.8.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | List of all members
cinder::audio::ChannelRouterNode::RouteConnector Struct Reference

Used in conjunction with operator>> and the route() methods to make connections that conduct channel routing. This class is usually not directly constructed by the user. More...

#include <ChannelRouterNode.h>

Public Member Functions

 RouteConnector (const ChannelRouterNodeRef &outputRouter, size_t inputChannelIndex, size_t outputChannelIndex)
 Constructs a RouteConnector with no number of channels information, so the maximum possible will be used. More...
 
 RouteConnector (const ChannelRouterNodeRef &outputRouter, size_t inputChannelIndex, size_t outputChannelIndex, size_t numChannels)
 Constructs a RouteConnector that will route numChannels from the input to the output ChannelRouterNode. More...
 
const ChannelRouterNodeRefgetOutputRouter () const
 Returns the output ChannelRouterNode. More...
 
size_t getInputChannelIndex () const
 Returns the channel index to start routing input channels from. More...
 
size_t getOutputChannelIndex () const
 Returns the channel index to route input channels to. More...
 
size_t getNumChannels () const
 Returns the number of channels to route in the connection. More...
 

Detailed Description

Used in conjunction with operator>> and the route() methods to make connections that conduct channel routing. This class is usually not directly constructed by the user.

Constructor & Destructor Documentation

cinder::audio::ChannelRouterNode::RouteConnector::RouteConnector ( const ChannelRouterNodeRef outputRouter,
size_t  inputChannelIndex,
size_t  outputChannelIndex 
)

Constructs a RouteConnector with no number of channels information, so the maximum possible will be used.

cinder::audio::ChannelRouterNode::RouteConnector::RouteConnector ( const ChannelRouterNodeRef outputRouter,
size_t  inputChannelIndex,
size_t  outputChannelIndex,
size_t  numChannels 
)

Constructs a RouteConnector that will route numChannels from the input to the output ChannelRouterNode.

Member Function Documentation

const ChannelRouterNodeRef& cinder::audio::ChannelRouterNode::RouteConnector::getOutputRouter ( ) const

Returns the output ChannelRouterNode.

size_t cinder::audio::ChannelRouterNode::RouteConnector::getInputChannelIndex ( ) const

Returns the channel index to start routing input channels from.

size_t cinder::audio::ChannelRouterNode::RouteConnector::getOutputChannelIndex ( ) const

Returns the channel index to route input channels to.

size_t cinder::audio::ChannelRouterNode::RouteConnector::getNumChannels ( ) const

Returns the number of channels to route in the connection.


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