CL_SoundProvider_Recorder Class Reference
[clanSound Sound Providers]

Sound provider getting data from a recording device (microphone). More...

#include <soundprovider_recorder.h>

Inheritance diagram for CL_SoundProvider_Recorder:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Construction

 CL_SoundProvider_Recorder (int frequency=22050)
 Constructs a sound provider getting data from a recording device.
virtual ~CL_SoundProvider_Recorder ()
Operations

virtual CL_SoundProvider_Sessionbegin_session ()
 Called by CL_SoundBuffer when a new session starts.
virtual void end_session (CL_SoundProvider_Session *session)
 Called by CL_SoundBuffer when a session has finished. After this call,.

Detailed Description

Sound provider getting data from a recording device (microphone).


Constructor & Destructor Documentation

CL_SoundProvider_Recorder::CL_SoundProvider_Recorder ( int  frequency = 22050  ) 

Constructs a sound provider getting data from a recording device.

Parameters:
frequency Recording frequency for sample data.
virtual CL_SoundProvider_Recorder::~CL_SoundProvider_Recorder (  )  [virtual]

Member Function Documentation

virtual CL_SoundProvider_Session* CL_SoundProvider_Recorder::begin_session (  )  [virtual]

Called by CL_SoundBuffer when a new session starts.

Returns:
The soundbuffer session to be attached to the newly started session.

Implements CL_SoundProvider.

virtual void CL_SoundProvider_Recorder::end_session ( CL_SoundProvider_Session session  )  [virtual]

Called by CL_SoundBuffer when a session has finished. After this call,.

CL_SoundBuffer will not access the session anymore. It can safely be deleted here (and in most cases should be delete here).

Implements CL_SoundProvider.


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