VideoGear API Usage Examples:¶
After going through following Usage Examples, Checkout more of its advanced configurations here ➶
Bare-Minimum Usage with CamGear backend¶
VideoGear by default provides direct internal access to CamGear API.
Following is the bare-minimum code you need to access CamGear API with VideoGear:
Bare-Minimum Usage with PiGear backend¶
VideoGear contains a special enablePiCamera
flag that when True
provides internal access to PiGear API.
Following is the bare-minimum code you need to access PiGear API with VideoGear:
Under the hood, PiGear API (version 0.3.3
onwards) prioritizes the new picamera2
API backend.
However, PiGear API seamlessly switches to the legacy picamera
backend, if the picamera2
library is unavailable or not installed.
It is advised to enable logging(logging=True
) to see which backend is being used.
The picamera
library is built on the legacy camera stack that is NOT (and never has been) supported on 64-bit OS builds.
You could also enforce the legacy picamera API backend in PiGear by using the enforce_legacy_picamera
user-defined optional parameter boolean attribute.
Make sure to complete Raspberry Pi Camera Hardware-specific settings prior using this API, otherwise nothing will work.
Using VideoGear with Video Stabilizer backend¶
VideoGear API provides a special internal wrapper around VidGear's Exclusive Video Stabilizer class and provides easy way of activating stabilization for various video-streams (real-time or not) with its stabilize
boolean parameter during initialization.
The usage example is as follows:
For a more detailed information on Video-Stabilizer Class, Read here ➶
The stabilizer might be slower for High-Quality/Resolution videos-frames.
Advanced VideoGear usage with CamGear Backend¶
VideoGear provides internal access to both CamGear and PiGear APIs, and thereby all additional parameters of PiGear API or CamGear API are also easily accessible within VideoGear API.
The usage example of VideoGear API with Variable Camera Properties is as follows:
This example demonstrates how to use the VideoGear API in a similar manner to the CamGear's example for controlling variable source properties. Any CamGear usage example can be implemented using the VideoGear API in a similar way.
All the supported Source Tweak Parameters can be found here ➶
Advanced VideoGear usage with PiGear Backend¶
VideoGear provides internal access to both CamGear and PiGear APIs, and thereby all additional parameters of PiGear API or CamGear API are also easily accessible within VideoGear API.
The usage example of VideoGear API with Variable Camera Properties is as follows:
This example demonstrates how to use the VideoGear API in a similar manner to the PiGear's example for using variable camera properties. Any PiGear usage example can be implemented using the VideoGear API in a similar way.
Backend PiGear API now fully supports the newer picamera2
python library under the hood for Raspberry Pi camera modules. Follow this guide ➶ for its installation.
Make sure to complete Raspberry Pi Camera Hardware-specific settings prior using this backend, otherwise nothing will work.
Under the hood, Backend PiGear API (version 0.3.3
onwards) prioritizes the new picamera2
API backend.
However, the API seamlessly switches to the legacy picamera
backend, if the picamera2
library is unavailable or not installed.
It is advised to enable logging(logging=True
) to see which backend is being used.
The picamera
library is built on the legacy camera stack that is NOT (and never has been) supported on 64-bit OS builds.
You could also enforce the legacy picamera API backend in PiGear by using the enforce_legacy_picamera
user-defined optional parameter boolean attribute.
Using VideoGear with Colorspace Manipulation¶
VideoGear API also supports Colorspace Manipulation but NOT Direct like other VideoCapture Gears.
Important: color_space
global variable is NOT Supported in VideoGear API
color_space
global variable is NOT Supported in VideoGear API, calling it will result inAttribueError
. More details can be found here ➶- Any incorrect or None-type value on
colorspace
parameter will be skipped automatically.
In following example code, we will convert source colorspace to HSV on initialization:
Bonus Examples¶
Checkout more advanced VideoGear examples with unusual configuration here ➶