NDEVR
API Documentation
StepsRecorder

If available, records user interactions using Windows Steps Recorder. More...

Collaboration diagram for StepsRecorder:
[legend]

Public Member Functions

 StepsRecorder ()
 Constructs a StepsRecorder instance.
void begin ()
 Begins recording user interactions to the default output location.
void begin (const File &file)
 Begins recording user interactions to the specified output file.
void end ()
 Stops the current recording session.
bool isRunning () const
 Returns whether a recording session is currently active.

Static Public Member Functions

static StepsRecorder & DefaultInstance ()
 Returns the singleton StepsRecorder instance.

Static Public Attributes

static ApplicationOption< bool > default_launch_recorder
 Application option controlling whether the recorder launches by default.

Protected Attributes

bool m_is_running
 Whether a recording session is currently active.

Detailed Description

If available, records user interactions using Windows Steps Recorder.

Definition at line 10 of file StepsRecorder.h.

Member Function Documentation

◆ begin()

void StepsRecorder::begin ( const File & file)

Begins recording user interactions to the specified output file.

Parameters
[in]fileThe file to save the recording to.

◆ DefaultInstance()

StepsRecorder & StepsRecorder::DefaultInstance ( )
static

Returns the singleton StepsRecorder instance.

Returns
A reference to the default StepsRecorder.

References StepsRecorder().

◆ isRunning()

bool StepsRecorder::isRunning ( ) const
inline

Returns whether a recording session is currently active.

Returns
True if recording is in progress.

Definition at line 34 of file StepsRecorder.h.

References m_is_running.

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