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 Member Functions

 SoundRecorder ()
 Default constructor.
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.

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 (  ) 

Default constructor.

Definition at line 48 of file SoundRecorder.cpp.

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

Virtual destructor.

Definition at line 59 of file SoundRecorder.cpp.


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)

Definition at line 69 of file SoundRecorder.cpp.

void sf::SoundRecorder::Stop (  ) 

Stop the capture.

Definition at line 111 of file SoundRecorder.cpp.

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

Get the sample rate.

Returns:
Frequency, in samples per second

Definition at line 129 of file SoundRecorder.cpp.

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

Definition at line 139 of file SoundRecorder.cpp.


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