Ptz class

The PTZ model groups the possible movements of the PTZ unit into a pan/tilt component and into a Zoom component. To steer the PTZ unit, the service provides absolute move, relative move and continuous move operations. Different coordinate systems and units are used to feed these operations.

Default Access Policy Definition | | Administrator | Operator | User | Anonymous | | PRE_AUTH | X | X | X | X | | READ_SYSTEM | X | X | X | | | READ_SYSTEM_SENSITIVE | X | X | | | | READ_SYSTEM_SECRET | X | | | | | WRITE_SYSTEM | X | | | | | UNRECOVERABLE | X | | | | | READ_MEDIA | X | X | X | | | ACTUATE | X | X | | |

Constructors

Ptz({required Transport transport, required Uri uri})

Properties

configurationCache → Map<String, PtzConfiguration>

final

defaultPanTiltLimits ↔ PanTiltLimits?

getter/setter pair

defaultSpeed ↔ PtzSpeed?

getter/setter pair

defaultZoomLimits ↔ ZoomLimits?

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

loggy → Loggy<UiLoggy>

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transport → Transport

final, inherited

uri → Uri

final, inherited

Methods

absoluteMove(String profileToken, {required PtzVector position, PtzSpeed? speed}) → Future<bool>

Operation to move pan,tilt or zoom to a absolute destination.

continuousMove(String profileToken, {required PtzSpeed velocity, int? timeout}) → Future<bool>

Operation for continuous Pan/Tilt and Zoom movements. The operation is supported if the PTZNode supports at least one continuous Pan/Tilt or Zoom space. If the space argument is omitted, the default space set by the PtzConfiguration will be used.

getCompatibleConfigurations(String profileToken) → Future<List<PtzConfiguration>>

Operation to get all available PTZConfigurations that can be added to the referenced media profile. A device providing more than one PTZConfiguration or more than one VideoSourceConfiguration or which has any other resource interdependency between PtzConfiguration entities and other resources listable in a media profile should implement this operation. PTZConfiguration entities returned by this operation shall not fail on adding them to the referenced media profile.

getConfiguration(String referenceToken) → Future<PtzConfiguration>

Get a specific PTZconfiguration from the device, identified by its reference token or name.

getConfigurationOptions(String configurationToken) → Future<PtzConfigurationOptions>

List supported coordinate systems including their range limitations. Therefore, the options MAY differ depending on whether the PTZ Configuration is assigned to a Profile containing a Video Source Configuration. In that case, the options may additionally contain coordinate systems referring to the image coordinate system described by the Video Source Configuration. If the PTZ Node supports continuous movements, it shall return a Timeout Range within which Timeouts are accepted by the PTZ Node.

getConfigurations() → Future<List<PtzConfiguration>>

Get all the existing PTZConfigurations from the device.

getCurrentPreset(String profileToken) → Future<Preset?>

getPresets(String profileToken, {int? limit = 100}) → Future<List<Preset>>

Operation to request all PTZ presets for the Preset in the selected profile. The operation is supported if there is support for at least one PTZ preset by the Preset.

getPresetsMap(String profileToken) → Future<Map<String, Preset>>

Helper method

getPresetTour(String profileToken, {required String presetTourToken}) → Future<PresetTour>

Operation to request a specific PTZ preset tour in the selected media profile.

getPresetTours(String profileToken) → Future<List<PresetTour>>

Operation to request PTZ preset tours in the selected media profiles.

getServiceCapabilities() → Future<Capabilities>

Returns the capabilities of the PTZ service. The result is returned in a typed answer.

getStatus(String profileToken) → Future<PtzStatus>

Operation to request PTZ status for the Node in the selected profile.

gotoHomePosition(String profileToken, {PtzSpeed? speed}) → Future<bool>

Operation to move the PTZ device to it's "home" position. The operation is supported if the HomeSupported element in the PTZNode is true.

gotoPreset(String profileToken, {required String presetToken, PtzSpeed? speed}) → Future<bool>

Operation to go to a saved preset position for the Preset in the selected profile. The operation is supported if there is support for at least one PTZ preset by the Preset.

move(String profileToken, {required Vector2D direction, Vector1D? zoom}) → Future<void>

Helper method

moveDown(String profileToken, [double step = -0.025]) → Future<void>

A helper method to perform a single step of a relativeMove on the negative y axis (down)

moveLeft(String profileToken, [double step = -0.025]) → Future<void>

A helper method to perform a single step of a relativeMove on the negative x axis (left)

moveRight(String profileToken, [double step = 0.025]) → Future<void>

A helper method to perform a single step of a relativeMove on the positive x axis (right)

moveUp(String profileToken, [double step = 0.025]) → Future<void>

A helper method to perform a single step of a relativeMove on the positive y axis (up)

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

relativeMove(String profileToken, PtzVector translation, PtzSpeed? speed) → Future<bool>

Operation for Relative Pan/Tilt and Zoom Move. The operation is supported if the PTZNode supports at least one relative Pan/Tilt or Zoom space.

removePreset(String profileToken, {required Preset preset}) → Future<bool>

Operation to remove a PTZ preset for the Node in the selected profile. The operation is supported if the PresetPosition capability exists for the Node in the selected profile.

setHomePosition(String profileToken) → Future<bool>

Operation to save current position as the home position. The SetHomePosition command returns with a failure if the “home” position is fixed and cannot be overwritten. If the SetHomePosition is successful, it is possible to recall the Home Position with the GotoHomePosition command.

setPreset(String profileToken, {String? presetName, String? presetToken}) → Future<String>

The setPreset command saves the current device position parameters so that the device can move to the saved preset position through the gotoPreset operation. In order to create a new Preset, the SetPresetRequest contains no PresetToken. If creation is successful, the Response contains the PresetToken which uniquely identifies the Preset. An existing Preset can be overwritten by specifying the PresetToken of the corresponding Preset. In both cases (overwriting or creation) an optional PresetName can be specified. The operation fails if the PTZ device is moving during the setPreset operation. The device may internally save additional states such as imaging properties in the PTZ Preset which then should be recalled in the gotoPreset operation.

stop(String profileToken, {bool panTilt = true, bool zoom = true}) → Future<bool>

Operation to stop ongoing pan, tilt and zoom movements of absolute relative and continuous type. If no stop argument for pan, tilt or zoom is set, the device will stop all ongoing pan, tilt and zoom movements.

toString() → String

A string representation of this object.

inherited

zoom(String profileToken, Vector1D zoom) → Future<void>

Helper method

zoomIn(String profileToken, [double step = 0.025]) → Future<void>

A helper method to perform a single step of a relativeMove on the positive z axis (closer)

zoomOut(String profileToken, [double step = 0.025]) → Future<void>

A helper method to perform a single step of a relativeMove on the negative y axis (farther)

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

ptzConfigurationConverter(dynamic json) → List<PtzConfiguration>