Public Member Functions

Recording Class Reference

Class that controls playback of peekabot recordings. More...

List of all members.

Public Member Functions

 Recording (boost::shared_ptr< RecordingImpl > impl)
void play ()
 Start playback.
void pause ()
 Pause playback.
bool is_paused () const
 Returns true if playback is currently paused.
bool is_finished () const
 Returns true if playback of the recording has finished.
void step (size_t n=1)
 Step n operations.
void step (const boost::posix_time::time_duration &td)
 Step the specified amount of time.
void set_playback_speed (double factor)
 Change the playback speed.
double get_playback_speed () const
 Get the current playback speed.
boost::posix_time::time_duration elapsed () const
 Returns the elapsed playback time.
boost::posix_time::time_duration duration () const
 Returns the recordings total duration.

Detailed Description

Class that controls playback of peekabot recordings.

Upon creation, playback is paused.


Member Function Documentation

void play (  ) 

Start playback.

If the recording is finished or already playing, this is a no-op.

void set_playback_speed ( double  factor  ) 

Change the playback speed.

Precondition:
factor > 0
void step ( const boost::posix_time::time_duration &  td  ) 

Step the specified amount of time.

If playback isn't paused, this is a no-op.

Precondition:
td is positive.
void step ( size_t  n = 1  ) 

Step n operations.

If playback isn't paused, this is a no-op.

Precondition:
n > 0
Remarks:
Note that bundles count as one operation, thus in combination with stepping they're a formidable tool.

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