Recorder#
- class pycanape.recorder.Recorder(asap3_handle: LP_tAsap3Hdl, recorder_id: LP_c_ulong)#
The
Recorder
class is not meant to be instantiated by the user.Recorder
instances are returned bydefine_recorder()
,get_recorder_by_index()
andget_selected_recorder()
.- Parameters:
asap3_handle –
recorder_id –
- disable() None #
Disable Recorder.
- enable() None #
Enable Recorder.
- get_mdf_filename() str #
Retrieve the MDF Filename of a Recorder.
- get_name() str #
Get the name of the recorder.
- get_state() RecorderState #
Return the state of a Recorder
- is_enabled() bool #
Check if Recorder is enabled.
- Returns:
True if recorder is enabled
- pause(pause: bool) None #
Pause or unpause recorder.
- set_mdf_filename(filename: str) None #
Set the MDF Filename for a Recorder.
- Parameters:
filename – new recorder filename e.g. ‘{RECORDER}_{YEAR}-{MONTH}-{DAY}_{HOUR}-{MINUTE}-{SECOND}.MF4’
- start() None #
Starts the recording into the mdf file.
- stop(save_to_mdf: bool = True) None #
Stops the recording and writes an MDF File.
- Parameters:
save_to_mdf – save recorded data to a file if True