Aravis Reference Manual: Aravis Reference Manual

For Aravis 0.8.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You may obtain a copy of the GNU Free Documentation License from the Free Software Foundation by visiting their Web site or by writing to:

  The Free Software Foundation, Inc.,
  59 Temple Place - Fifth Floor,
  Boston, MA 02110-1301,
  USA

I. Overview

Introduction
Thread Safety
Building and Debugging Aravis

II. Aravis API reference

Arv — Device discovery and instantiation
ArvCamera — Class for generic camera control
ArvInterface — Abstract base class for camera discovery
ArvDevice — Abstract base class for device handling
ArvStream — Abstract base class for video stream reception
ArvBuffer — Buffer for storage of video frames
ArvChunkParser — Parser for extraction of chunk data from buffers

ArvGc — Genicam root document class
ArvGcNode — Base class for all Genicam nodes
ArvGcPropertyNode — Base class for Genicam property nodes
ArvGcIndexNode — Class for Index nodes
ArvGcValueIndexedNode — Class for Index nodes
ArvGcInvalidatorNode — Class for Invalidator nodes
ArvGcFeatureNode — Base class for Genicam feature nodes
ArvGcRegisterDescriptionNode — Class for RegisterDescription nodes
ArvGcGroupNode — Class for Group nodes
ArvGcRegister — Register interface
ArvGcInteger — Integer interface
ArvGcFloat — Float interface
ArvGcString — String interface
ArvGcCategory — Class for Category nodes
ArvGcCommand — Class for Command nodes
ArvGcBoolean — Class for Boolean nodes
ArvGcIntegerNode — Class for Integer nodes
ArvGcFloatNode — Class for Float nodes
ArvGcRegisterNode — Class for Register nodes
ArvGcStringNode — Class for String nodes
ArvGcStructEntryNode — Class for StructEntry nodes
ArvGcEnumeration — Class for Enumeration nodes
ArvGcEnumEntry — Class for EnumEntry nodes
ArvGcConverter — Class for Converter and IntConverter nodes
ArvGcConverterNode — Converter node class
ArvGcIntConverterNode — IntConverter node class
ArvGcSwissKnife — Class for SwissKnife and IntSwissKnife nodes
ArvGcSelector — Selector interface
ArvGcPort — Class for Port nodes

Ethernet cameras

ArvGvInterface — GigEVision interface
ArvGvDevice — GigEVision device
ArvGvStream — GigEVision stream
ArvGvFakeCamera — GigE Vision Simulator

USB cameras

ArvUvInterface — USB3Vision interface
ArvUvDevice — USB3Vision device
ArvUvStream — USB3Vision video stream

Fake cameras

ArvFakeInterface — Fake interface
ArvFakeDevice — Fake device
ArvFakeStream — Fake stream
ArvFakeCamera — Fake camera internals

ArvDomNode — Base class for DOM nodes
ArvDomNodeList
ArvDomNodeChildList — Class for DOM node child lists
ArvDomNamedNodeMap
ArvDomDocument — Base class for DOM document nodes
ArvDomDocumentFragment — Base class for DOM document fragments
ArvDomElement — Base class for DOM element nodes
ArvDomCharacterData — Base class for DOM character data nodes
ArvDomText — Base class for DOM text nodes

ArvDebug — Debugging tools
ArvEvaluator — A math expression evaluator with Genicam syntax
ArvGst — Gstreamer utilities
ArvStr — String utilities
ArvZip — A simple zip extractor
ArvXmlSchema — XML Schema storage

Object Hierarchy

Index of new symbols in 0.2.0

Index of new symbols in 0.2.3

Index of new symbols in 0.4.0

Index of new symbols in 0.6.0

Index of new symbols in 0.6.2

Index of new symbols in 0.8.0

Index of new symbols in 0.8.3

Index of new symbols in 0.8.6

Index of new symbols in 0.8.8

Index of new symbols in 0.8.11

Index of new symbols in 0.8.15

Index of new symbols in 0.8.16

Index of new symbols in 0.8.17

Index of new symbols in 0.8.19

Index of new symbols in 0.8.20

Annotation Glossary

III. Ethernet protocol (GV)

Introduction
GVCP packets
GVSP packets