sf::SoundBufferRecorder

sf::SoundBufferRecorder Class Reference

Specialized sfSoundRecorder which saves the captured audio data into a sound buffer. More...

#include <SoundBufferRecorder.hpp>

Inheritance diagram for sf::SoundBufferRecorder:

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

Public Types

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

Public Member Functions

const SoundBuffer & GetBuffer ()
 Get the sound buffer containing the captured audio data.
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

Specialized sfSoundRecorder which saves the captured audio data into a sound buffer.

Definition at line 42 of file SoundBufferRecorder.hpp.

Member Function Documentation

const SoundBuffer& sf::SoundBufferRecorder::GetBuffer (  ) 

Get the sound buffer containing the captured audio data.

Returns:
Constant reference to the sound buffer

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

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 (  )  [inherited]

Stop the capture.

unsigned int sf::SoundRecorder::GetSampleRate (  )  const [inherited]

Get the sample rate.

Returns:
Frequency, in samples per second

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

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: