Conventions
This documentation uses a consistent set of badges to identify version requirements, implementation details, feature availability, parameter constraints, and related resources.
Each badge conveys a specific meaning, helping readers quickly understand the compatibility, behavior, or purpose of a component or operation. Refer to the conventions below for the meaning of each badge and the information it communicates.
Version requirements
0.0 → Package version
Indicates the minimum onvif-python package version required to use a feature, parameter, class, or operation. The badge links to the corresponding release documentation.
0.0 → ONVIF version
Indicates the minimum ONVIF version required for device compatibility. The badge links to the relevant ONVIF specification.
Implementation details
→ Internal
Identifies an internal implementation detail that is not intended for direct public use.
Internal components may change without following the same compatibility guarantees as the public API.
→ Entry point
Identifies the entry point of an ONVIF service or operation, helping readers locate where a particular interaction begins.
→ Exception
Identifies an exception type associated with an operation, indicating the kind of error that may be raised.
→ Error handler
Identifies a function or mechanism responsible for handling errors during an operation.
Features and extensions
→ Plugin
A Zeep plugin that intercepts and processes SOAP messages exchanged by the client.
→ Utility
Identifies a supporting utility that provides reusable functionality for common tasks.
→ Feature
Indicates an optional feature that provides additional functionality or behavior. Availability may depend on configuration, device capabilities, or the operation being performed.
→ Experimental
Marks a feature that is experimental and may undergo changes in behavior, implementation, or API before becoming stable.
Examples and references
→ Example view
Links directly to the example source code for inspection.
logger.py → Example file
Links to the example file so readers can inspect or download it.
→ Module
Links to the corresponding Python module in the repository, allowing readers to inspect its implementation.
nirsimetri/onvif-python → Demo
Links to an external repository containing a demonstration or related implementation.
Parameters and properties
→ Default value
Displays the default value of a parameter, setting, or property when no explicit value is provided.
→ Empty default
Indicates that the default value is None, meaning no value is assigned by default.
→ Computed default
Indicates that the default value is computed dynamically at runtime rather than being a fixed, explicitly defined value.
→ Required
Indicates that a parameter, value, or property is required for the relevant operation or configuration.
→ Metadata
Identifies a property that provides metadata about a component, object, or resource.