PtzConfiguration class

A specific PtzConfiguration from the device.

The default Position/Translation/Velocity Spaces are introduced to allow NVCs sending move requests without the need to specify a certain coordinate system. The default Speeds are introduced to control the speed of move requests (absolute, relative, preset), where no explicit speed has been set.

The allowed pan and tilt range for Pan/Tilt Limits is defined by a two-dimensional space range that is mapped to a specific Absolute Pan/Tilt Position Space. At least one Pan/Tilt Position Space is required by the PTZNode to support Pan/Tilt limits. The limits apply to all supported absolute, relative and continuous Pan/Tilt movements. The limits shall be checked within the coordinate system for which the limits have been specified. That means that even if movements are specified in a different coordinate system, the requested movements shall be transformed to the coordinate system of the limits where the limits can be checked. When a relative or continuous movements is specified, which would leave the specified limits, the PTZ unit has to move along the specified limits.

Annotations
  • @JsonSerializable()

Constructors

PtzConfiguration({required String token, required String name, required int useCount, int? moveRamp, int? presetRamp, int? presetTourRamp, required String nodeToken, Space? defaultAbsolutePantTiltPositionSpace, Space? defaultAbsoluteZoomPositionSpace, Space? defaultRelativePanTiltTranslationSpace, Space? defaultRelativeZoomTranslationSpace, Space? defaultContinuousPanTiltVelocitySpace, Space? defaultContinuousZoomVelocitySpace, PtzSpeed? defaultPtzSpeed, String? defaultPtzTimeout, PanTiltLimits? panTiltLimits, ZoomLimits? zoomLimits})
PtzConfiguration.fromJson(Map<String, dynamic> json)
factory

Properties

defaultAbsolutePantTiltPositionSpace Space?
If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default.
final
defaultAbsoluteZoomPositionSpace Space?
If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default.
final
defaultContinuousPanTiltVelocitySpace Space?
If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default.
final
defaultContinuousZoomVelocitySpace Space?
If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default.
final
defaultPtzSpeed PtzSpeed?
If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds.
final
defaultPtzTimeout String?
If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops.
final
defaultRelativePanTiltTranslationSpace Space?
If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default.
final
defaultRelativeZoomTranslationSpace Space?
If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default.
final
hashCode int
The hash code for this object.
no setterinherited
moveRamp int?
The optional acceleration ramp used by the device when moving.
final
name String
User readable name. Length up to 64 characters.
final
nodeToken String
A mandatory reference to the PTZ Node that the PTZ Configuration belongs to.
final
panTiltLimits PanTiltLimits?
The Pan/Tilt limits element should be present for a PTZ Node that supports an absolute Pan/Tilt. If the element is present it signals the support for configurable Pan/Tilt limits. If limits are enabled, the Pan/Tilt movements shall always stay within the specified range. The Pan/Tilt limits are disabled by setting the limits to –INF or +INF.
final
presetRamp int?
The optional acceleration ramp used by the device when recalling presets.
final
presetTourRamp int?
The optional acceleration ramp used by the device when executing PresetTours.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
token String
Token that uniquely references this configuration. Length up to 64 characters.
final
useCount int
Number of internal references currently using this configuration. This informational parameter is read-only. Deprecated for Media2 Service.
final
zoomLimits ZoomLimits?
The Zoom limits element should be present for a PTZ Node that supports absolute zoom. If the element is present it signals the supports for configurable Zoom limits. If limits are enabled the zoom movements shall always stay within the specified range. The Zoom limits are disabled by settings the limits to -INF and +INF.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
inherited