pupil_recording_interface.VideoReader.load_frame

VideoReader.load_frame(idx=None, return_timestamp=False)

Load a single processed video frame.

Parameters

• idx (int or Timestamp, optional) – The index of the frame. If not specified, will load the next frame. If Timestamp, will load the frame with the closest timestamp.

• return_timestamp (bool, default False) – If True, also return the timestamp of the frame.

Returns

• frame (numpy.ndarray) – The loaded frame.

• timestamp (Timestamp) – The timestamp of the frame.