IMultiChannelOutput Class Reference

#include <audio/core/multichannel.h>

Public Member Functions
virtual	~IMultiChannelOutput ()=default
virtual int	getChannelCount () const =0
virtual OutputPin *	getOutputForChannel (int channel)=0
OutputPin *	tryGetOutputForChannel (unsigned int)

Description

Interface for any class that exposes multichannel audio output.

Inheritance diagram for IMultiChannelOutput:

Constructor & Destructor Documentation

~IMultiChannelOutput()

virtual ~IMultiChannelOutput ( )

virtualdefault

Destructor

Member Function Documentation

getChannelCount()

virtual int getChannelCount ( ) const

pure virtual

Override this method to specify the number of audio channels output by this object.

Returns

the number of channels this object outputs.

Implemented in PlaybackComponentInstance, SequencePlayerAudioOutputComponentInstance, AudioInputComponentInstance, and VideoAudioComponentInstance.

getOutputForChannel()

virtual OutputPin* getOutputForChannel ( int  channel )

pure virtual

To be overridden by descendants.

Parameters

channel

channel index to request the output for

Returns

the output pin that outputs audio data for the specified channel.

Implemented in PlaybackComponentInstance, SequencePlayerAudioOutputComponentInstance, VideoAudioComponentInstance, and AudioInputComponentInstance.

tryGetOutputForChannel()

OutputPin* tryGetOutputForChannel

(

unsigned int

)

Returns

an output pin for a given channel, but returns nullptr if the channel is out of bounds.