VISR  0.11.1
Versatile Interactive Scene Renderer
visr::AudioOutputBase Class Reference

#include <audio_output.hpp>

Inheritance diagram for visr::AudioOutputBase:
visr::AudioPortBase visr::AudioOutputT< SampleType > visr::AudioOutputT< DataType >

Public Member Functions

 AudioOutputBase (char const *name, Component &container, AudioSampleType::Id typeId, std::size_t width)
 
virtual ~AudioOutputBase () 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

Common base class for audio output ports, not specific to a sample type This class contains the common implementation of the templated concrete port types.

Constructor & Destructor Documentation

◆ AudioOutputBase()

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

Constructor.

Parameters
nameThe name of the port as a null-terminated character array. Must be unique among the audio ports of the containing components.
containerThe containing component (atomic or composite)
typeIdThe sample type id of the contained component.
widthThe width of the port, i.e., the number of single audio channels provided.

◆ ~AudioOutputBase()

visr::AudioOutputBase::~AudioOutputBase ( )
overridevirtualdefault

Desctructor (virtual) Virtual because the base class destructor is also virtual.


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