startFrameRecording method

void startFrameRecording({
  1. bool clearExisting = true,
  2. bool captureCurrentFrame = false,
})

Starts recording deterministic frame snapshots after each synced render.

When clearExisting is true, previously captured frames are discarded.

When captureCurrentFrame is true, the current view is immediately recorded before any new input is sent.

Implementation

void startFrameRecording({
  bool clearExisting = true,
  bool captureCurrentFrame = false,
}) {
  if (clearExisting) {
    clearRecordedFrames();
  }
  _recordFrames = true;
  if (captureCurrentFrame) {
    captureFrame(trigger: 'startFrameRecording');
  }
}