v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-02-1354131442.5 KB
v1
camera

Get Detailed Camera Information

Get comprehensive camera information including all detected devices and capabilities.

This endpoint provides detailed analysis of all available USB cameras including complete device enumeration via v4l2, hardware specifications with device names and drivers, format capabilities for supported video formats and resolutions, and primary camera selection with system recommendations.

Information Categories

When camera is currently streaming, the system provides active camera status with current device and format information plus all detected cameras for complete device reference. When no camera is actively streaming, the system returns all cameras with complete device enumeration, primary camera selection with system recommendations, and capability analysis with detailed format and resolution support.

This endpoint is essential for applications requiring detailed camera analysis or multi-camera management.

get/api/v1/camera/info

Response

Camera information retrieved successfully

connectedboolean required

Whether any camera is connected

messagestring required

Information message

total_camerasinteger nullable

Total number of cameras detected

Example response

{
  "cameras": [
    {
      "best_format": {
        "format": "MJPG",
        "fps": 30,
        "height": 720,
        "width": 1280
      },
      "bus_info": "usb-xhci-hcd.1-2",
      "card_name": "Integrated_Webcam_HD: Integrate",
      "device_name": "Integrated_Webcam_HD: Integrate",
      "device_path": "/dev/video0",
      "driver_name": "uvcvideo",
      "supported_formats": []
    }
  ],
  "connected": true,
  "message": "Found 1 USB camera(s)",
  "primary_camera": {},
  "total_cameras": 1
}