gramods::gmSound::CaptureFromWav Class Reference

The instantiation of this class will attempt to open a capture device and allow for extraction of sample data from this. More...

#include <CaptureFromWav.hh>

Inheritance diagram for gramods::gmSound::CaptureFromWav:

Collaboration diagram for gramods::gmSound::CaptureFromWav:

Classes
struct	Impl

Public Member Functions
void	setFile (std::filesystem::path file)
void	setLoop (bool on)
void	setExit (bool on)
size_t	getSampleRate () override
	Returns the sample rate.
size_t	getChannelCount () override
	Sets the number of channels to attempt to open for the capture device.
bool	isOpen () override
void	startCapture () override
void	stopCapture () override
std::vector< float >	getAvailableSamples () override
size_t	getAvailableSamplesCount () override
void	initialize () override
	Called to initialize the Object.
Public Member Functions inherited from gramods::gmSound::Capture
std::string	getDefaultKey () override
	Returns the default key for the Object when automatically instantiated in a Configuration, i.e.
Public Member Functions inherited from gramods::gmCore::Object
	Object ()
	Initializes internal data.
virtual	~Object ()
	Cleaning up internal data.
virtual void	accept (Visitor *visitor)
	Calls the visitors apply method with this as argument.
virtual void	traverse (Visitor *visitor)
	Calls the child Object's accept method, if such exist.
bool	isInitialized ()
	Returns true if the Object is initialized.

Static Public Attributes
static gramods::gmCore::OFactory::OFactoryInformation	_gm_ofi

Additional Inherited Members
Static Public Member Functions inherited from gramods::gmSound::Capture
template<size_t N>
static std::array< std::vector< float >, N >	deinterlaceSamples (std::vector< float > data)
	De-interlaces the input sample data into an array of N vectors each with an Nth of the original samples.
static std::vector< std::vector< float > >	deinterlaceSamples (std::vector< float > data, size_t N)
	De-interlaces the input sample data into an array of N vectors each with an Nth of the original samples.

Detailed Description

The instantiation of this class will attempt to open a capture device and allow for extraction of sample data from this.

Member Function Documentation

getAvailableSamples()

std::vector< float > gramods::gmSound::CaptureFromWav::getAvailableSamples ( )

overridevirtual

Implements gramods::gmSound::Capture.

getAvailableSamplesCount()

size_t gramods::gmSound::CaptureFromWav::getAvailableSamplesCount ( )

overridevirtual

Implements gramods::gmSound::Capture.

getChannelCount()

size_t gramods::gmSound::CaptureFromWav::getChannelCount ( )

overridevirtual

Sets the number of channels to attempt to open for the capture device.

Implements gramods::gmSound::Capture.

getSampleRate()

size_t gramods::gmSound::CaptureFromWav::getSampleRate ( )

overridevirtual

Returns the sample rate.

Implements gramods::gmSound::Capture.

initialize()

void gramods::gmSound::CaptureFromWav::initialize ( )

overridevirtual

Called to initialize the Object.

This should be called once only!

Sub classes should override this method to make use of set parameter data. They should also always call its base class' implementation as well.

Reimplemented from gramods::gmCore::Object.

isOpen()

bool gramods::gmSound::CaptureFromWav::isOpen ( )

overridevirtual

Implements gramods::gmSound::Capture.

startCapture()

void gramods::gmSound::CaptureFromWav::startCapture ( )

overridevirtual

Implements gramods::gmSound::Capture.

stopCapture()

void gramods::gmSound::CaptureFromWav::stopCapture ( )

overridevirtual

Implements gramods::gmSound::Capture.

---

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

• /home/karlu/private/program/gramods/modules/gmSound/include/gmSound/CaptureFromWav.hh
• /home/karlu/private/program/gramods/modules/gmSound/src/CaptureFromWav.cpp