sf::SoundRecorder Class Reference

SoundRecorder is an interface for capturing sound data, it is meant to be used as a base class. More...

#include <SoundRecorder.hpp>

Inheritance diagram for sf::SoundRecorder:

sf::Thread sf::SoundBufferRecorder List of all members.

Public Types

typedef bool(*) FuncType (const Int16 *, std::size_t, void *)

Public Member Functions

 SoundRecorder (FuncType Callback, void *UserData=NULL)
 Construct the sound recorder with a callback function for processing captured samples.
virtual ~SoundRecorder ()
 Virtual destructor.
void Start (unsigned int SampleRate=44100)
 Start the capture.
void Stop ()
 Stop the capture.
unsigned int GetSampleRate () const
 Get the sample rate.

Static Public Member Functions

static bool CanCapture ()
 Tell if the system supports sound capture.

Protected Member Functions

 SoundRecorder ()
 Default constructor.

Detailed Description

SoundRecorder is an interface for capturing sound data, it is meant to be used as a base class.

Definition at line 41 of file SoundRecorder.hpp.


Constructor & Destructor Documentation

sf::SoundRecorder::SoundRecorder ( FuncType  Callback,
void *  UserData = NULL 
)

Construct the sound recorder with a callback function for processing captured samples.

Parameters:
Callback : Callback for processing captured samples
UserData : Data to pass to the callback function (NULL by default)

virtual sf::SoundRecorder::~SoundRecorder (  )  [virtual]

Virtual destructor.

sf::SoundRecorder::SoundRecorder (  )  [protected]

Default constructor.


Member Function Documentation

void sf::SoundRecorder::Start ( unsigned int  SampleRate = 44100  ) 

Start the capture.

Warning : only one capture can happen at the same time

Parameters:
SampleRate : Sound frequency (the more samples, the higher the quality) (44100 by default = CD quality)

void sf::SoundRecorder::Stop (  ) 

Stop the capture.

unsigned int sf::SoundRecorder::GetSampleRate (  )  const

Get the sample rate.

Returns:
Frequency, in samples per second

static bool sf::SoundRecorder::CanCapture (  )  [static]

Tell if the system supports sound capture.

If not, this class won't be usable

Returns:
True if audio capture is supported


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