sfSoundRecorder Class Reference

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

#include <SoundRecorder.hpp>

Inheritance diagram for sfSoundRecorder:

sfThread sfSoundBufferRecorder List of all members.

Public Member Functions

 sfSoundRecorder ()
 Default constructor.
virtual ~sfSoundRecorder ()
 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.

Detailed Description

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

Definition at line 39 of file SoundRecorder.hpp.


Constructor & Destructor Documentation

sfSoundRecorder::sfSoundRecorder (  ) 

Default constructor.

Definition at line 47 of file SoundRecorder.cpp.

sfSoundRecorder::~sfSoundRecorder (  )  [virtual]

Virtual destructor.

Definition at line 58 of file SoundRecorder.cpp.


Member Function Documentation

void sfSoundRecorder::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)

Definition at line 68 of file SoundRecorder.cpp.

void sfSoundRecorder::Stop (  ) 

Stop the capture.

Definition at line 110 of file SoundRecorder.cpp.

unsigned int sfSoundRecorder::GetSampleRate (  )  const

Get the sample rate.

Returns:
Frequency, in samples per second

Definition at line 128 of file SoundRecorder.cpp.

bool sfSoundRecorder::CanCapture (  )  [static]

Tell if the system supports sound capture.

If not, this class won't be usable

Returns:
True if audio capture is supported

Definition at line 138 of file SoundRecorder.cpp.


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