uvc

GitHub main workflow codecov pub package GitHub Stars Buy me a coffee

A Dart package for controlling UVC compliant webcams.

You can find more information about UVC USB devices here on Wikipedia.

Platform Support

Android iOS MacOS Web Linux Windows
❌ ❌ ✅ ❌ ❌ ✅

Example

import 'package:uvc/uvc.dart';

void main() {
  final uvc = UvcLib(); // Load the libusb library

  final camera = UVCControl(vendorId: 0x1532, productId: 0x0E05);

  print('zoom: ${camera.zoom.current}');

  camera.zoom.current = 225;

  uvc.dispose();
}

Usage

First, add uvc as a dependency in your pubspec.yaml file. Then run dart pub get or flutter pub get.

Next, you need to instantiate the UvcLib class which will open and setup the libusb library for use in the app.

final uvc = UvcLib();

To open a camera and start controlling it, you must use UVCControl. Include the vendor ID and product ID of the camera to control.

final camera = UVCControl(vendorId: 0x1532, productId: 0x0E05);

To find a list of cameras with their IDs, you can use:

final uvcDevices = uvc.getDevices(onlyUvcDevices: true);
final device = uvcDevices.first;
final vendorId = device.deviceDescriptor.vendorId;
final productId = device.deviceDescriptor.productId;

To get the zoom current value:

print('zoom: ${camera.zoom.current}');

To set the zoom current value:

camera.zoom.current = 225;

It is always a good idea to unload the library when you are done using it.

uvc.dispose();

To get the range of valid values for zoom:

final min = camera.zoom.min;
final max = camera.zoom.max;

To use the pan or tilt values, just use the same code as zoom, but substitute the name pan and tilt for zoom:

camera.pan.current;
camera.pan.min;
camera.tilt.current;
camera.tilt.min;

Controls

Pan

camera.pan.current;

Tilt

camera.tilt.current;

Zoom

final camera = UVCControl(vendorId: 0x1532, productId: 0x0E05);

camera.zoom.current;
camera.zoom.defaultValue;
camera.zoom.max;
camera.zoom.min;
camera.zoom.resolution;

Focus

camera.zoom.current;

Focus (auto)

camera.focusAuto.current;

Debugging

You can enable logging in UvcLib for troubleshooting. Just pass true to debugLogging when creating UvcLib.

final uvc = UvcLib(debugLogging: true);

You can also enable libusb logging in UvcLib for troubleshooting. Just pass true to debugLoggingLibUsb when creating UvcLib.

final uvc = UvcLib(debugLoggingLibUsb: true);

libusb

This uvc package utilizes the libusb library via Dart FFI and it is included as a dependency with the libusb Dart package.

Contributing

All comments and pull requests are welcome.

Donations / Sponsor

Please sponsor or donate to the creator of uvc on Flattr or Patreon.

Libraries

uvc