sfSoundRecorder Class Reference

#include <SoundRecorder.hpp>

Inheritance diagram for sfSoundRecorder:

sfSoundBufferRecorder List of all members.

Public Member Functions

 sfSoundRecorder ()
virtual ~sfSoundRecorder ()
void Start (unsigned int Frequency=44100)
void Stop ()
unsigned int GetFrequency () const

Static Public Member Functions

static bool CanCapture ()

Detailed Description

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

Definition at line 40 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  Frequency = 44100  ) 

Start the capture Warning : only one capture can happen at the same time

Parameters:
Frequency : Sample rate (the more samples, the higher the quality) (44100 by default = CD quality)

Definition at line 68 of file SoundRecorder.cpp.

References CanCapture().

void sfSoundRecorder::Stop (  ) 

Stop the capture

Definition at line 110 of file SoundRecorder.cpp.

unsigned int sfSoundRecorder::GetFrequency (  )  const

Get the sample rate

Returns:
Frequency, in samples per second

Definition at line 128 of file SoundRecorder.cpp.

Referenced by sfSoundBufferRecorder::GetBuffer().

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.

Referenced by Start().


The documentation for this class was generated from the following files:
Generated for SFML by  doxygen 1.5.2