SAL
A C++ library for spatial audio.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
sal::MonoMic Class Reference

#include <monomics.h>

Inheritance diagram for sal::MonoMic:
sal::Microphone sal::MemorylessMonoMic sal::GainMic sal::TanMic sal::TrigMic sal::OmniMic

Public Member Functions

 MonoMic (mcl::Point position, mcl::Quaternion orientation)
 
Sample RecordPlaneWave (const Sample input_sample, const mcl::Point &point, const Int &wave_id=0) noexcept
 
bool IsCoincident () const noexcept
 
Int num_channels () const noexcept
 
virtual ~MonoMic ()
 
- Public Member Functions inherited from sal::Microphone
 Microphone (mcl::Point position, mcl::Quaternion orientation=mcl::Quaternion::Identity())
 
mcl::Point position () const noexcept
 
virtual void SetPosition (const mcl::Point &position) noexcept
 
mcl::Quaternion orientation () const noexcept
 
virtual void SetOrientation (const mcl::Quaternion &orientation) noexcept
 
void SetHandedness (const mcl::Handedness handedness) noexcept
 
void AddPlaneWave (const MonoBuffer &signal, const mcl::Point &point, Buffer &output_buffer) noexcept
 
void AddPlaneWave (const Sample *input_data, const Int num_samples, const mcl::Point &point, Buffer &output_buffer) noexcept
 
void AddPlaneWave (const Sample input_sample, const mcl::Point &point, Buffer &output_buffer) noexcept
 
void AddPlaneWave (const MonoBuffer &input_buffer, const mcl::Point &point, const Int wave_id, Buffer &output_buffer) noexcept
 
void AddPlaneWave (const Sample input_sample, const mcl::Point &point, const Int wave_id, Buffer &output_buffer) noexcept
 
virtual void AddPlaneWave (const Sample *input_data, const Int num_samples, const mcl::Point &point, const Int wave_id, Buffer &output_buffer) noexcept
 
virtual bool IsOmni () const noexcept
 
mcl::Point GetRelativePoint (const mcl::Point &point) const noexcept
 
virtual void Reset () noexcept
 
virtual ~Microphone ()
 
virtual void AddPlaneWaveRelative (const MonoBuffer &signal, const mcl::Point &point, const Int wave_id, Buffer &output_buffer) noexcept
 
virtual void AddPlaneWaveRelative (const Sample *input_data, const Int num_samples, const mcl::Point &point, const Int wave_id, Buffer &output_buffer) noexcept=0
 

Additional Inherited Members

- Static Public Member Functions inherited from sal::Microphone
static bool Test ()
 
- Protected Attributes inherited from sal::Microphone
mcl::Handedness handedness_
 

Constructor & Destructor Documentation

sal::MonoMic::MonoMic ( mcl::Point  position,
mcl::Quaternion  orientation 
)
inline
virtual sal::MonoMic::~MonoMic ( )
inlinevirtual

Member Function Documentation

bool sal::MonoMic::IsCoincident ( ) const
inlinevirtualnoexcept

Implements sal::Microphone.

Int sal::MonoMic::num_channels ( ) const
inlinevirtualnoexcept

Implements sal::Microphone.

Sample sal::MonoMic::RecordPlaneWave ( const Sample  input_sample,
const mcl::Point &  point,
const Int wave_id = 0 
)
inlinenoexcept

This method is used mostly for testing, as it is very slow. You should use AddPlaneWave instead.


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