.. _api_camera:

========================
API - The PiCamera Class
========================

.. module:: picamera

The picamera library contains numerous classes, but the primary one that all
users are likely to interact with is :class:`PiCamera`, documented below.
With the exception of the contents of the :mod:`picamera.array` module, all
classes in picamera are accessible from the package's top level namespace.
In other words, the following import is sufficient to import everything in
the library (excepting the contents of :mod:`picamera.array`)::

    import picamera

PiCamera
========

.. autoclass:: PiCamera


PiVideoFrameType
================

.. autoclass:: PiVideoFrameType


PiVideoFrame
============

.. autoclass:: PiVideoFrame(index, frame_type, frame_size, video_size, split_size, timestamp)


PiResolution
============

.. autoclass:: PiResolution(width, height)


PiFramerateRange
================

.. autoclass:: PiFramerateRange(low, high)
