OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
hardware_io.camera.camera_if.CameraIf Class Reference

Interface for a source capable of producing camera frames. More...

Inheritance diagram for hardware_io.camera.camera_if.CameraIf:
hardware_io.camera.v4l2_camera.V4L2Camera

Public Member Functions

bool is_open (self)
 Return whether the camera device is currently open.
 
None open (self)
 Open and configure the camera device.
 
CameraFrame read (self)
 Capture and return the next frame.
 
None close (self)
 Release the camera device.
 

Detailed Description

Interface for a source capable of producing camera frames.

Member Function Documentation

◆ is_open()

bool hardware_io.camera.camera_if.CameraIf.is_open (   self)

Return whether the camera device is currently open.

Returns
True when capture is open and ready.

Reimplemented in hardware_io.camera.v4l2_camera.V4L2Camera.

◆ read()

CameraFrame hardware_io.camera.camera_if.CameraIf.read (   self)

Capture and return the next frame.

Returns
Next captured frame and its source metadata.

Reimplemented in hardware_io.camera.v4l2_camera.V4L2Camera.


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