DepthAI v2 has been superseded by DepthAI v3. You are viewing legacy documentation.
CloudSoftwareHardware
DepthAI Components
DepthAI Tutorials
DepthAI Perception
ROS
Neural Networks
DepthAI API References

ON THIS PAGE

  • UVC
  • What is UVC?
  • How Does the UVC Node Work?
  • Examples of UVC Node Usage
  • Reference

UVC

The DepthAI UVC (USB Video Class) node allows OAK devices to function as standard webcams. This feature is particularly useful for integrating OAK devices into applications that require video input, such as video conferencing tools or custom video processing applications.

What is UVC?

UVC refers to the USB Video Class standard, which is a USB device class that describes devices capable of streaming video. This standard allows video devices to interface with computers and other devices without needing specific drivers, making them immediately compatible with a wide range of systems and software.

How Does the UVC Node Work?

The UVC node in DepthAI leverages this standard to stream video from OAK devices. When the UVC node is enabled, the OAK device is recognized as a standard webcam by the host system. This allows the device to be used in any application that supports webcam input, such as Zoom, Skype, or custom video processing software.The UVC node streams video data over a USB connection. It is important to use a USB3 cable for this purpose, as USB2 may not provide the necessary bandwidth for stable video streaming.

Examples of UVC Node Usage

Custom Python Script: A custom Python script can be written to enable the UVC node and configure the video stream parameters. Here are some pre-written examples:OBS Forwarding: For applications where direct UVC node usage is not possible, OBS Studio can be used to forward the UVC stream.

Reference

class

depthai.node.UVC(depthai.Node)

method
setGpiosOnInit(self, list: dict [ int , int ])
Set GPIO list <gpio_number, value> for GPIOs to set (on/off) at init
method
setGpiosOnStreamOff(self, list: dict [ int , int ])
Set GPIO list <gpio_number, value> for GPIOs to set when streaming is disabled
method
setGpiosOnStreamOn(self, list: dict [ int , int ])
Set GPIO list <gpio_number, value> for GPIOs to set when streaming is enabled
property
input
Input for image frames to be streamed over UVC  Default queue is blocking with size 8

Need assistance?

Head over to Discussion Forum for technical support or any other questions you might have.