VISR  0.11.6
Versatile Interactive Scene Renderer
visr::AudioInputBase Class Reference

#include <audio_input.hpp>

Inheritance diagram for visr::AudioInputBase:
visr::AudioPortBase visr::AudioInputT< SampleType > visr::AudioInputT< DataType >

Public Member Functions

 AudioInputBase (char const *name, Component &container, AudioSampleType::Id typeId, std::size_t width)
 
virtual ~AudioInputBase () override
 
- Public Member Functions inherited from visr::AudioPortBase
 AudioPortBase (char const *name, Component &container, AudioSampleType::Id sampleType, PortBase::Direction direction)
 
 AudioPortBase (char const *name, Component &container, AudioSampleType::Id sampleType, PortBase::Direction direction, std::size_t width)
 
virtual ~AudioPortBase ()
 
void setWidth (std::size_t newWidth)
 
std::size_t width () const noexcept
 
std::size_t alignmentBytes () noexcept
 
std::size_t alignmentSamples () noexcept
 
std::size_t channelStrideSamples () const noexcept
 
std::size_t channelStrideBytes () const noexcept
 
AudioSampleType::Id sampleType () const noexcept
 
std::size_t sampleSize () const noexcept
 
impl::AudioPortBaseImplementationimplementation ()
 
impl::AudioPortBaseImplementation const & implementation () const
 

Additional Inherited Members

- Protected Member Functions inherited from visr::AudioPortBase
void * basePointer ()
 
void const * basePointer () const
 

Detailed Description

Base class for audio input ports. This base class is not intended to be used by API users. This class itself cannot be instantiated, because it is not associated with a specific sample type. Only derived classes may actually be instantiated.

Constructor & Destructor Documentation

◆ AudioInputBase()

visr::AudioInputBase::AudioInputBase ( char const *  name,
Component container,
AudioSampleType::Id  typeId,
std::size_t  width 
)

Constructor. Sets up the data members of the base port type and defines it as an input.

Parameters
nameThe name of the port as a zero-terminated character array. Name must be unique among the audio ports of the containing component.
containerThe component (atomic or composite) holding that audio type.
typeIdAn enumeration value that specifies the data type.
widthThe number of single audio channels associated with this port.

◆ ~AudioInputBase()

visr::AudioInputBase::~AudioInputBase ( )
overridevirtualdefault

Destructor (virtual).

Note
Reconsider whether audio ports shall be instantiated polymorphically. Otherwise, the destructor would not need to be virtual.

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