PySpin API Reference¶
API Version
This reference covers PySpin v4.4.0.246. See Release Notes for differences from previous versions.
PySpin provides Python bindings for the Spinnaker SDK exposing the full C++ API surface with Pythonic conventions to control and acquire images from Teledyne USB 3.0, GigE, USB 2.0 cameras, and optional NumPy integration for image data.
For native performance-critical paths, see the C++ API or C API. For .NET/Windows desktop integration, see the C# API.
Programmer's Guide
The PySpin SDK ships with a comprehensive programmer's guide covering installation and compatibility information, design conventions, quick reference, events, QuickSpin properties, and advanced usage patterns. See the Python Programmer's Guide for the full content ported to this site.
Modules/Class & Groups Reference¶
The PySpin modules and class reference is built with Sphinx autodoc from the live PySpin module. Each class has its own dedicated page with all methods and properties rendered from docstrings.
Deprecated API¶
Deprecated PySpin members are marked with a deprecated notice in their
individual class pages. To find all deprecated items, search for
"Deprecated" in the search bar or browse the class reference pages.
For known issues and limitations, see the Getting Started guide.