cinder::audio::Input Class Reference

#include <Input.h>

List of all members.

Public Member Functions

 Input ()
 Input (InputDeviceRef aDevice)
 ~Input ()
void start ()
 Starts capturing audio data from the input.
void stop ()
 Stops capturing audio data from the input.
PcmBuffer32fRef getPcmBuffer ()
 Returns a copy of the buffer of the most recently captured audio data.
bool isCapturing () const
 Returns whether or not the input is currently capturing audio data.
uint32_t getSampleRate ()
 Returns the sample rate of the captured audio data.
uint16_t getChannelCount ()
 Returns the number of channels of the captured audio data.

Static Public Member Functions

static const std::vector
< InputDeviceRef > & 
getDevices (bool forceRefresh=false)
 Returns a vector of all Devices connected to the system. If forceRefresh then the system will be polled for connected devices.
static InputDeviceRef getDefaultDevice ()
 Gets the default audio input device.
static InputDeviceRef findDeviceByName (const std::string &name)
 Finds a particular device based on its name.
static InputDeviceRef findDeviceByNameContains (const std::string &nameFragment)
 Finds the first device whose name contains the string nameFragment.



typedef std::shared_ptr
< InputImpl > Input::* 
unspecified_bool_type
 Emulates shared_ptr-like behavior.
 operator unspecified_bool_type () const
 Emulates shared_ptr-like behavior.
void reset ()
 Emulates shared_ptr-like behavior.

Member Typedef Documentation

typedef std::shared_ptr<InputImpl> Input::* cinder::audio::Input::unspecified_bool_type

Emulates shared_ptr-like behavior.


Constructor & Destructor Documentation

cinder::audio::Input::Input (  ) 
cinder::audio::Input::Input ( InputDeviceRef  aDevice  ) 
cinder::audio::Input::~Input (  ) 

Member Function Documentation

void cinder::audio::Input::start (  ) 

Starts capturing audio data from the input.

void cinder::audio::Input::stop (  ) 

Stops capturing audio data from the input.

PcmBuffer32fRef cinder::audio::Input::getPcmBuffer (  ) 

Returns a copy of the buffer of the most recently captured audio data.

bool cinder::audio::Input::isCapturing (  )  const

Returns whether or not the input is currently capturing audio data.

uint32_t cinder::audio::Input::getSampleRate (  ) 

Returns the sample rate of the captured audio data.

uint16_t cinder::audio::Input::getChannelCount (  ) 

Returns the number of channels of the captured audio data.

const std::vector< InputDeviceRef > & cinder::audio::Input::getDevices ( bool  forceRefresh = false  )  [static]

Returns a vector of all Devices connected to the system. If forceRefresh then the system will be polled for connected devices.

InputDeviceRef cinder::audio::Input::getDefaultDevice (  )  [static]

Gets the default audio input device.

InputDeviceRef cinder::audio::Input::findDeviceByName ( const std::string &  name  )  [static]

Finds a particular device based on its name.

InputDeviceRef cinder::audio::Input::findDeviceByNameContains ( const std::string &  nameFragment  )  [static]

Finds the first device whose name contains the string nameFragment.

cinder::audio::Input::operator unspecified_bool_type (  )  const

Emulates shared_ptr-like behavior.

void cinder::audio::Input::reset (  ) 

Emulates shared_ptr-like behavior.


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