Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | List of all members
sf::SoundRecorder Class Referenceabstract

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

Public Member Functions

virtual ~SoundRecorder ()
 Virtual destructor. More...
 
void Start (unsigned int SampleRate=44100)
 Start the capture. More...
 
void Stop ()
 Stop the capture. More...
 
unsigned int GetSampleRate () const
 Get the sample rate. More...
 

Static Public Member Functions

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

Protected Member Functions

 SoundRecorder ()
 Default constructor. More...
 

Private Types

typedef void(* FuncType) (void *)
 

Private Member Functions

void Launch ()
 Create and run the thread. More...
 
void Wait ()
 Wait until the thread finishes. More...
 
void Terminate ()
 Terminate the thread Terminating a thread with this function is not safe, you should rather try to make the thread function terminate by itself. More...
 

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

◆ ~SoundRecorder()

sf::SoundRecorder::~SoundRecorder ( )
virtual

Virtual destructor.

Definition at line 59 of file SoundRecorder.cpp.

◆ SoundRecorder()

sf::SoundRecorder::SoundRecorder ( )
protected

Default constructor.

Definition at line 48 of file SoundRecorder.cpp.

Member Function Documentation

◆ CanCapture()

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

If not, this class won't be usable

Definition at line 136 of file SoundRecorder.cpp.

◆ GetSampleRate()

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

Get the sample rate.

Returns
Frequency, in samples per second

Definition at line 126 of file SoundRecorder.cpp.

◆ Start()

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)

Warning : only one capture can happen at the same time

Definition at line 69 of file SoundRecorder.cpp.

◆ Stop()

void sf::SoundRecorder::Stop ( )

Stop the capture.

Definition at line 115 of file SoundRecorder.cpp.


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