Skip to content

PTZ

PTZ service implementation.

PTZ

Bases: ONVIFService

0.0.1 1.0 check_ptz.py

PTZ service client.

Property Details
First introduced ONVIF 1.0 (November 2008)
Binding name PTZBinding (ver20/ptz/wsdl/ptz.wsdl)
Operations ptz.wsdl
Spec PTZ

GetServiceCapabilities 

GetServiceCapabilities()

Returns the capabilities of the PTZ service.

The result is returned in a typed answer.

Output
  • Capabilities [Capabilities]
    The capabilities for the PTZ service is returned in the Capabilities element.
    • EFlip - optional; [boolean]
      Indicates whether or not EFlip is supported.
    • Reverse - optional; [boolean]
      Indicates whether or not reversing of PT control direction is supported.
    • GetCompatibleConfigurations - optional; [boolean]
      Indicates support for the GetCompatibleConfigurations command.
    • MoveStatus - optional; [boolean]
      Indicates that the PTZStatus includes MoveStatus information.
    • StatusPosition - optional; [boolean]
      Indicates that the PTZStatus includes Position information.
    • MoveAndTrack - optional; [StringList]
      Indication of the methods of MoveAndTrack that are supported, acceptable values are defined in tt:MoveAndTrackMethod.

GetConfigurations 

GetConfigurations()

Get all the existing PTZConfigurations 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. The Zoom Limits have to be interpreted accordingly.

Output
  • PTZConfiguration - optional, unbounded; [PTZConfiguration]
    A list of all existing PTZConfigurations on the device.
    • MoveRamp - optional; [int]
      The optional acceleration ramp used by the device when moving.
    • PresetRamp - optional; [int]
      The optional acceleration ramp used by the device when recalling presets.
    • PresetTourRamp - optional; [int]
      The optional acceleration ramp used by the device when executing PresetTours.
    • Name [Name]
      User readable name. Length up to 64 characters.
      Maximum length: 64
    • UseCount [int]
      Number of internal references currently using this configuration.

      This informational parameter is read-only. Deprecated for Media2 Service.

    • NodeToken [ReferenceToken]
      A mandatory reference to the PTZ Node that the PTZ Configuration belongs to.
      Maximum length: 64
    • DefaultAbsolutePantTiltPositionSpace - optional; [anyURI]
      If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default.
    • DefaultAbsoluteZoomPositionSpace - optional; [anyURI]
      If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default.
    • DefaultRelativePanTiltTranslationSpace - optional; [anyURI]
      If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default.
    • DefaultRelativeZoomTranslationSpace - optional; [anyURI]
      If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default.
    • DefaultContinuousPanTiltVelocitySpace - optional; [anyURI]
      If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default.
    • DefaultContinuousZoomVelocitySpace - optional; [anyURI]
      If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default.
    • DefaultPTZSpeed - optional; [PTZSpeed]
      If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds.
      • PanTilt - optional; [Vector2D]
        Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
        • x - required; [float]
        • y - required; [float]
        • space - optional; [anyURI]
          Pan/tilt coordinate space selector. The following options are defined:
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
      • Zoom - optional; [Vector1D]
        A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
        • x - required; [float]
        • space - optional; [anyURI]
          Zoom coordinate space selector. The following options are defined:
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • DefaultPTZTimeout - optional; [duration]
      If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops.
    • PanTiltLimits - optional; [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.
      • Range [Space2DDescription]
        A range of pan tilt limits.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
        • YRange [FloatRange]
          A range of y-axis.
          • Min [float]
          • Max [float]
    • ZoomLimits - optional; [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.
      • Range [Space1DDescription]
        A range of zoom limit
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
    • Extension - optional; [PTZConfigurationExtension]
      • PTControlDirection - optional; [PTControlDirection]
        Optional element to configure PT Control Direction related features.
        • EFlip - optional; [EFlip]
          Optional element to configure related parameters for E-Flip.
          • Mode [EFlipMode]
            Parameter to enable/disable E-Flip feature.
            Enum Value Enum Description
            OFF —
            ON —
            Extended —
        • Reverse - optional; [Reverse]
          Optional element to configure related parameters for reversing of PT Control Direction.
          • Mode [ReverseMode]
            Parameter to enable/disable Reverse feature.
            Enum Value Enum Description
            OFF —
            ON —
            AUTO —
            Extended —
        • Extension - optional; [PTControlDirectionExtension]
      • Extension - optional; [PTZConfigurationExtension2]

GetPresets 

GetPresets(ProfileToken)

Operation to request all PTZ presets for the PTZNode in the selected profile.

The operation is supported if there is support for at least on PTZ preset by the PTZNode.

Input
  • ProfileToken [ReferenceToken]
    A reference to the MediaProfile where the operation should take place.
    Maximum length: 64
Output
  • Preset - optional, unbounded; [PTZPreset]
    A list of presets which are available for the requested MediaProfile.
    • token - optional; [ReferenceToken]
    • Name - optional; [Name]
      A list of preset position name.
      Maximum length: 64
    • PTZPosition - optional; [PTZVector]
      A list of preset position.
      • PanTilt - optional; [Vector2D]
        Pan and tilt position. The x component corresponds to pan and the y component to tilt.
        • x - required; [float]
        • y - required; [float]
        • space - optional; [anyURI]
          Pan/tilt coordinate space selector. The following options are defined:
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
      • Zoom - optional; [Vector1D]
        A zoom position.
        • x - required; [float]
        • space - optional; [anyURI]
          Zoom coordinate space selector. The following options are defined:
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace

SetPreset 

SetPreset(ProfileToken, PresetName=None, PresetToken=None)

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.

Input
  • ProfileToken [ReferenceToken]
    A reference to the MediaProfile where the operation should take place.
    Maximum length: 64
  • PresetName - optional; [string]
    A requested preset name.
  • PresetToken - optional; [ReferenceToken]
    A requested preset token.
    Maximum length: 64
Output
  • PresetToken [ReferenceToken]
    A token to the Preset which has been set.
    Maximum length: 64

RemovePreset 

RemovePreset(ProfileToken, PresetToken)

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.

Input
  • ProfileToken [ReferenceToken]
    A reference to the MediaProfile where the operation should take place.
    Maximum length: 64
  • PresetToken [ReferenceToken]
    A requested preset token.
    Maximum length: 64

GotoPreset 

GotoPreset(ProfileToken, PresetToken, Speed=None)

Operation to go to a saved preset position for the PTZNode in the selected profile.

The operation is supported if there is support for at least on PTZ preset by the PTZNode.

Input
  • ProfileToken [ReferenceToken]
    A reference to the MediaProfile where the operation should take place.
    Maximum length: 64
  • PresetToken [ReferenceToken]
    A requested preset token.
    Maximum length: 64
  • Speed - optional; [PTZSpeed]
    A requested speed.The speed parameter can only be specified when Speed Spaces are available for the PTZ Node.
    • PanTilt - optional; [Vector2D]
      Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
      • x - required; [float]
      • y - required; [float]
      • space - optional; [anyURI]
        Pan/tilt coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • Zoom - optional; [Vector1D]
      A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
      • x - required; [float]
      • space - optional; [anyURI]
        Zoom coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace

GetStatus 

GetStatus(ProfileToken)

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

Input
  • ProfileToken [ReferenceToken]
    A reference to the MediaProfile where the PTZStatus should be requested.
    Maximum length: 64
Output
  • PTZStatus [PTZStatus]
    The PTZStatus for the requested MediaProfile.
    • Position - optional; [PTZVector]
      Specifies the absolute position of the PTZ unit together with the Space references. The default absolute spaces of the corresponding PTZ configuration MUST be referenced within the Position element.
      • PanTilt - optional; [Vector2D]
        Pan and tilt position. The x component corresponds to pan and the y component to tilt.
        • x - required; [float]
        • y - required; [float]
        • space - optional; [anyURI]
          Pan/tilt coordinate space selector. The following options are defined:
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
      • Zoom - optional; [Vector1D]
        A zoom position.
        • x - required; [float]
        • space - optional; [anyURI]
          Zoom coordinate space selector. The following options are defined:
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • MoveStatus - optional; [PTZMoveStatus]
      Indicates if the Pan/Tilt/Zoom device unit is currently moving, idle or in an unknown state.
      • PanTilt - optional; [MoveStatus]
        Enum Value Enum Description
        IDLE —
        MOVING —
        UNKNOWN —
      • Zoom - optional; [MoveStatus]
        Enum Value Enum Description
        IDLE —
        MOVING —
        UNKNOWN —
    • Error - optional; [string]
      States a current PTZ error.
    • UtcTime [dateTime]
      Specifies the UTC time when this status was generated.
    • FieldOfView - optional; [FieldOfView]
      States the current field of view of the video stream.
      • hfov - required; [float]
        Horizontal field-of-view in degrees.
      • vfov - required; [float]
        Vertical field-of-view in degrees.

GetConfiguration 

GetConfiguration(PTZConfigurationToken)

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

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. The Zoom Limits have to be interpreted accordingly.

Input
  • PTZConfigurationToken [ReferenceToken]
    Token of the requested PTZConfiguration.
    Maximum length: 64
Output
  • PTZConfiguration [PTZConfiguration]
    A requested PTZConfiguration.
    • MoveRamp - optional; [int]
      The optional acceleration ramp used by the device when moving.
    • PresetRamp - optional; [int]
      The optional acceleration ramp used by the device when recalling presets.
    • PresetTourRamp - optional; [int]
      The optional acceleration ramp used by the device when executing PresetTours.
    • Name [Name]
      User readable name. Length up to 64 characters.
      Maximum length: 64
    • UseCount [int]
      Number of internal references currently using this configuration.

      This informational parameter is read-only. Deprecated for Media2 Service.

    • NodeToken [ReferenceToken]
      A mandatory reference to the PTZ Node that the PTZ Configuration belongs to.
      Maximum length: 64
    • DefaultAbsolutePantTiltPositionSpace - optional; [anyURI]
      If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default.
    • DefaultAbsoluteZoomPositionSpace - optional; [anyURI]
      If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default.
    • DefaultRelativePanTiltTranslationSpace - optional; [anyURI]
      If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default.
    • DefaultRelativeZoomTranslationSpace - optional; [anyURI]
      If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default.
    • DefaultContinuousPanTiltVelocitySpace - optional; [anyURI]
      If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default.
    • DefaultContinuousZoomVelocitySpace - optional; [anyURI]
      If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default.
    • DefaultPTZSpeed - optional; [PTZSpeed]
      If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds.
      • PanTilt - optional; [Vector2D]
        Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
        • x - required; [float]
        • y - required; [float]
        • space - optional; [anyURI]
          Pan/tilt coordinate space selector. The following options are defined:
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
      • Zoom - optional; [Vector1D]
        A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
        • x - required; [float]
        • space - optional; [anyURI]
          Zoom coordinate space selector. The following options are defined:
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • DefaultPTZTimeout - optional; [duration]
      If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops.
    • PanTiltLimits - optional; [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.
      • Range [Space2DDescription]
        A range of pan tilt limits.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
        • YRange [FloatRange]
          A range of y-axis.
          • Min [float]
          • Max [float]
    • ZoomLimits - optional; [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.
      • Range [Space1DDescription]
        A range of zoom limit
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
    • Extension - optional; [PTZConfigurationExtension]
      • PTControlDirection - optional; [PTControlDirection]
        Optional element to configure PT Control Direction related features.
        • EFlip - optional; [EFlip]
          Optional element to configure related parameters for E-Flip.
          • Mode [EFlipMode]
            Parameter to enable/disable E-Flip feature.
            Enum Value Enum Description
            OFF —
            ON —
            Extended —
        • Reverse - optional; [Reverse]
          Optional element to configure related parameters for reversing of PT Control Direction.
          • Mode [ReverseMode]
            Parameter to enable/disable Reverse feature.
            Enum Value Enum Description
            OFF —
            ON —
            AUTO —
            Extended —
        • Extension - optional; [PTControlDirectionExtension]
      • Extension - optional; [PTZConfigurationExtension2]

GetNodes 

GetNodes()

Get the descriptions of the available PTZ Nodes.

A PTZ-capable device may have multiple PTZ Nodes. The PTZ Nodes may represent mechanical PTZ drivers, uploaded PTZ drivers or digital PTZ drivers. PTZ Nodes are the lowest level entities in the PTZ control API and reflect the supported PTZ capabilities. The PTZ Node is referenced either by its name or by its reference token.

Output
  • PTZNode - optional, unbounded; [PTZNode]
    A list of the existing PTZ Nodes on the device.
    • FixedHomePosition - optional; [boolean]
      Indication whether the HomePosition of a Node is fixed or it can be changed via the SetHomePosition command.
    • GeoMove - optional; [boolean]
      Indication whether the Node supports the geo-referenced move command.
    • Name - optional; [Name]
      A unique identifier that is used to reference PTZ Nodes.
      Maximum length: 64
    • SupportedPTZSpaces [PTZSpaces]
      A list of Coordinate Systems available for the PTZ Node. For each Coordinate System, the PTZ Node MUST specify its allowed range.
      • AbsolutePanTiltPositionSpace - optional, unbounded; [Space2DDescription]
        The Generic Pan/Tilt Position space is provided by every PTZ node that supports absolute Pan/Tilt, since it does not relate to a specific physical range. Instead, the range should be defined as the full range of the PTZ unit normalized to the range -1 to 1 resulting in the following space description.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
        • YRange [FloatRange]
          A range of y-axis.
          • Min [float]
          • Max [float]
      • AbsoluteZoomPositionSpace - optional, unbounded; [Space1DDescription]
        The Generic Zoom Position Space is provided by every PTZ node that supports absolute Zoom, since it does not relate to a specific physical range. Instead, the range should be defined as the full range of the Zoom normalized to the range 0 (wide) to 1 (tele). There is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
      • RelativePanTiltTranslationSpace - optional, unbounded; [Space2DDescription]
        The Generic Pan/Tilt translation space is provided by every PTZ node that supports relative Pan/Tilt, since it does not relate to a specific physical range. Instead, the range should be defined as the full positive and negative translation range of the PTZ unit normalized to the range -1 to 1, where positive translation would mean clockwise rotation or movement in right/up direction resulting in the following space description.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
        • YRange [FloatRange]
          A range of y-axis.
          • Min [float]
          • Max [float]
      • RelativeZoomTranslationSpace - optional, unbounded; [Space1DDescription]
        The Generic Zoom Translation Space is provided by every PTZ node that supports relative Zoom, since it does not relate to a specific physical range. Instead, the corresponding absolute range should be defined as the full positive and negative translation range of the Zoom normalized to the range -1 to1, where a positive translation maps to a movement in TELE direction. The translation is signed to indicate direction (negative is to wide, positive is to tele). There is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension. This results in the following space description.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
      • ContinuousPanTiltVelocitySpace - optional, unbounded; [Space2DDescription]
        The generic Pan/Tilt velocity space shall be provided by every PTZ node, since it does not relate to a specific physical range. Instead, the range should be defined as a range of the PTZ unit's speed normalized to the range -1 to 1, where a positive velocity would map to clockwise rotation or movement in the right/up direction. A signed speed can be independently specified for the pan and tilt component resulting in the following space description.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
        • YRange [FloatRange]
          A range of y-axis.
          • Min [float]
          • Max [float]
      • ContinuousZoomVelocitySpace - optional, unbounded; [Space1DDescription]
        The generic zoom velocity space specifies a zoom factor velocity without knowing the underlying physical model. The range should be normalized from -1 to 1, where a positive velocity would map to TELE direction. A generic zoom velocity space description resembles the following.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
      • PanTiltSpeedSpace - optional, unbounded; [Space1DDescription]
        The speed space specifies the speed for a Pan/Tilt movement when moving to an absolute position or to a relative translation. In contrast to the velocity spaces, speed spaces do not contain any directional information. The speed of a combined Pan/Tilt movement is represented by a single non-negative scalar value.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
      • ZoomSpeedSpace - optional, unbounded; [Space1DDescription]
        The speed space specifies the speed for a Zoom movement when moving to an absolute position or to a relative translation. In contrast to the velocity spaces, speed spaces do not contain any directional information.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
      • Extension - optional; [PTZSpacesExtension]
    • MaximumNumberOfPresets [int]
      All preset operations MUST be available for this PTZ Node if one preset is supported.
    • HomeSupported [boolean]
      A boolean operator specifying the availability of a home position. If set to true, the Home Position Operations MUST be available for this PTZ Node.
    • AuxiliaryCommands - optional, unbounded; [AuxiliaryData]
      A list of supported Auxiliary commands. If the list is not empty, the Auxiliary Operations MUST be available for this PTZ Node.
      Maximum length: 128
    • Extension - optional; [PTZNodeExtension]
      • SupportedPresetTour - optional; [PTZPresetTourSupported]
        Detail of supported Preset Tour feature.
        • MaximumNumberOfPresetTours [int]
          Indicates number of preset tours that can be created. Required preset tour operations shall be available for this PTZ Node if one or more preset tour is supported.
        • PTZPresetTourOperation - optional, unbounded; [PTZPresetTourOperation]
          Indicates which preset tour operations are available for this PTZ Node.
          Enum Value Enum Description
          Start —
          Stop —
          Pause —
          Extended —
        • Extension - optional; [PTZPresetTourSupportedExtension]
      • Extension - optional; [PTZNodeExtension2]

GetNode 

GetNode(NodeToken)

Get a specific PTZ Node identified by a reference token or a name.

Input
  • NodeToken [ReferenceToken]
    Token of the requested PTZNode.
    Maximum length: 64
Output
  • PTZNode [PTZNode]
    A requested PTZNode.
    • FixedHomePosition - optional; [boolean]
      Indication whether the HomePosition of a Node is fixed or it can be changed via the SetHomePosition command.
    • GeoMove - optional; [boolean]
      Indication whether the Node supports the geo-referenced move command.
    • Name - optional; [Name]
      A unique identifier that is used to reference PTZ Nodes.
      Maximum length: 64
    • SupportedPTZSpaces [PTZSpaces]
      A list of Coordinate Systems available for the PTZ Node. For each Coordinate System, the PTZ Node MUST specify its allowed range.
      • AbsolutePanTiltPositionSpace - optional, unbounded; [Space2DDescription]
        The Generic Pan/Tilt Position space is provided by every PTZ node that supports absolute Pan/Tilt, since it does not relate to a specific physical range. Instead, the range should be defined as the full range of the PTZ unit normalized to the range -1 to 1 resulting in the following space description.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
        • YRange [FloatRange]
          A range of y-axis.
          • Min [float]
          • Max [float]
      • AbsoluteZoomPositionSpace - optional, unbounded; [Space1DDescription]
        The Generic Zoom Position Space is provided by every PTZ node that supports absolute Zoom, since it does not relate to a specific physical range. Instead, the range should be defined as the full range of the Zoom normalized to the range 0 (wide) to 1 (tele). There is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
      • RelativePanTiltTranslationSpace - optional, unbounded; [Space2DDescription]
        The Generic Pan/Tilt translation space is provided by every PTZ node that supports relative Pan/Tilt, since it does not relate to a specific physical range. Instead, the range should be defined as the full positive and negative translation range of the PTZ unit normalized to the range -1 to 1, where positive translation would mean clockwise rotation or movement in right/up direction resulting in the following space description.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
        • YRange [FloatRange]
          A range of y-axis.
          • Min [float]
          • Max [float]
      • RelativeZoomTranslationSpace - optional, unbounded; [Space1DDescription]
        The Generic Zoom Translation Space is provided by every PTZ node that supports relative Zoom, since it does not relate to a specific physical range. Instead, the corresponding absolute range should be defined as the full positive and negative translation range of the Zoom normalized to the range -1 to1, where a positive translation maps to a movement in TELE direction. The translation is signed to indicate direction (negative is to wide, positive is to tele). There is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension. This results in the following space description.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
      • ContinuousPanTiltVelocitySpace - optional, unbounded; [Space2DDescription]
        The generic Pan/Tilt velocity space shall be provided by every PTZ node, since it does not relate to a specific physical range. Instead, the range should be defined as a range of the PTZ unit's speed normalized to the range -1 to 1, where a positive velocity would map to clockwise rotation or movement in the right/up direction. A signed speed can be independently specified for the pan and tilt component resulting in the following space description.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
        • YRange [FloatRange]
          A range of y-axis.
          • Min [float]
          • Max [float]
      • ContinuousZoomVelocitySpace - optional, unbounded; [Space1DDescription]
        The generic zoom velocity space specifies a zoom factor velocity without knowing the underlying physical model. The range should be normalized from -1 to 1, where a positive velocity would map to TELE direction. A generic zoom velocity space description resembles the following.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
      • PanTiltSpeedSpace - optional, unbounded; [Space1DDescription]
        The speed space specifies the speed for a Pan/Tilt movement when moving to an absolute position or to a relative translation. In contrast to the velocity spaces, speed spaces do not contain any directional information. The speed of a combined Pan/Tilt movement is represented by a single non-negative scalar value.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
      • ZoomSpeedSpace - optional, unbounded; [Space1DDescription]
        The speed space specifies the speed for a Zoom movement when moving to an absolute position or to a relative translation. In contrast to the velocity spaces, speed spaces do not contain any directional information.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
      • Extension - optional; [PTZSpacesExtension]
    • MaximumNumberOfPresets [int]
      All preset operations MUST be available for this PTZ Node if one preset is supported.
    • HomeSupported [boolean]
      A boolean operator specifying the availability of a home position. If set to true, the Home Position Operations MUST be available for this PTZ Node.
    • AuxiliaryCommands - optional, unbounded; [AuxiliaryData]
      A list of supported Auxiliary commands. If the list is not empty, the Auxiliary Operations MUST be available for this PTZ Node.
      Maximum length: 128
    • Extension - optional; [PTZNodeExtension]
      • SupportedPresetTour - optional; [PTZPresetTourSupported]
        Detail of supported Preset Tour feature.
        • MaximumNumberOfPresetTours [int]
          Indicates number of preset tours that can be created. Required preset tour operations shall be available for this PTZ Node if one or more preset tour is supported.
        • PTZPresetTourOperation - optional, unbounded; [PTZPresetTourOperation]
          Indicates which preset tour operations are available for this PTZ Node.
          Enum Value Enum Description
          Start —
          Stop —
          Pause —
          Extended —
        • Extension - optional; [PTZPresetTourSupportedExtension]
      • Extension - optional; [PTZNodeExtension2]

SetConfiguration 

SetConfiguration(PTZConfiguration, ForcePersistence)

Set/update a existing PTZConfiguration on the device.

Input
  • PTZConfiguration [PTZConfiguration]
    • MoveRamp - optional; [int]
      The optional acceleration ramp used by the device when moving.
    • PresetRamp - optional; [int]
      The optional acceleration ramp used by the device when recalling presets.
    • PresetTourRamp - optional; [int]
      The optional acceleration ramp used by the device when executing PresetTours.
    • Name [Name]
      User readable name. Length up to 64 characters.
      Maximum length: 64
    • UseCount [int]
      Number of internal references currently using this configuration.

      This informational parameter is read-only. Deprecated for Media2 Service.

    • NodeToken [ReferenceToken]
      A mandatory reference to the PTZ Node that the PTZ Configuration belongs to.
      Maximum length: 64
    • DefaultAbsolutePantTiltPositionSpace - optional; [anyURI]
      If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default.
    • DefaultAbsoluteZoomPositionSpace - optional; [anyURI]
      If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default.
    • DefaultRelativePanTiltTranslationSpace - optional; [anyURI]
      If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default.
    • DefaultRelativeZoomTranslationSpace - optional; [anyURI]
      If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default.
    • DefaultContinuousPanTiltVelocitySpace - optional; [anyURI]
      If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default.
    • DefaultContinuousZoomVelocitySpace - optional; [anyURI]
      If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default.
    • DefaultPTZSpeed - optional; [PTZSpeed]
      If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds.
      • PanTilt - optional; [Vector2D]
        Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
        • x - required; [float]
        • y - required; [float]
        • space - optional; [anyURI]
          Pan/tilt coordinate space selector. The following options are defined:
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
      • Zoom - optional; [Vector1D]
        A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
        • x - required; [float]
        • space - optional; [anyURI]
          Zoom coordinate space selector. The following options are defined:
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • DefaultPTZTimeout - optional; [duration]
      If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops.
    • PanTiltLimits - optional; [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.
      • Range [Space2DDescription]
        A range of pan tilt limits.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
        • YRange [FloatRange]
          A range of y-axis.
          • Min [float]
          • Max [float]
    • ZoomLimits - optional; [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.
      • Range [Space1DDescription]
        A range of zoom limit
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
    • Extension - optional; [PTZConfigurationExtension]
      • PTControlDirection - optional; [PTControlDirection]
        Optional element to configure PT Control Direction related features.
        • EFlip - optional; [EFlip]
          Optional element to configure related parameters for E-Flip.
          • Mode [EFlipMode]
            Parameter to enable/disable E-Flip feature.
            Enum Value Enum Description
            OFF —
            ON —
            Extended —
        • Reverse - optional; [Reverse]
          Optional element to configure related parameters for reversing of PT Control Direction.
          • Mode [ReverseMode]
            Parameter to enable/disable Reverse feature.
            Enum Value Enum Description
            OFF —
            ON —
            AUTO —
            Extended —
        • Extension - optional; [PTControlDirectionExtension]
      • Extension - optional; [PTZConfigurationExtension2]
  • ForcePersistence [boolean]
    Flag that makes configuration persistent. Example: User wants the configuration to exist after reboot.

GetConfigurationOptions 

GetConfigurationOptions(ConfigurationToken)

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.

Input
  • ConfigurationToken [ReferenceToken]
    Token of an existing configuration that the options are intended for.
    Maximum length: 64
Output
  • PTZConfigurationOptions [PTZConfigurationOptions]
    The requested PTZ configuration options.
    • PTZRamps - optional; [IntList]
      The list of acceleration ramps supported by the device. The smallest acceleration value corresponds to the minimal index, the highest acceleration corresponds to the maximum index.
    • Spaces [PTZSpaces]
      A list of supported coordinate systems including their range limitations.
      • AbsolutePanTiltPositionSpace - optional, unbounded; [Space2DDescription]
        The Generic Pan/Tilt Position space is provided by every PTZ node that supports absolute Pan/Tilt, since it does not relate to a specific physical range. Instead, the range should be defined as the full range of the PTZ unit normalized to the range -1 to 1 resulting in the following space description.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
        • YRange [FloatRange]
          A range of y-axis.
          • Min [float]
          • Max [float]
      • AbsoluteZoomPositionSpace - optional, unbounded; [Space1DDescription]
        The Generic Zoom Position Space is provided by every PTZ node that supports absolute Zoom, since it does not relate to a specific physical range. Instead, the range should be defined as the full range of the Zoom normalized to the range 0 (wide) to 1 (tele). There is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
      • RelativePanTiltTranslationSpace - optional, unbounded; [Space2DDescription]
        The Generic Pan/Tilt translation space is provided by every PTZ node that supports relative Pan/Tilt, since it does not relate to a specific physical range. Instead, the range should be defined as the full positive and negative translation range of the PTZ unit normalized to the range -1 to 1, where positive translation would mean clockwise rotation or movement in right/up direction resulting in the following space description.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
        • YRange [FloatRange]
          A range of y-axis.
          • Min [float]
          • Max [float]
      • RelativeZoomTranslationSpace - optional, unbounded; [Space1DDescription]
        The Generic Zoom Translation Space is provided by every PTZ node that supports relative Zoom, since it does not relate to a specific physical range. Instead, the corresponding absolute range should be defined as the full positive and negative translation range of the Zoom normalized to the range -1 to1, where a positive translation maps to a movement in TELE direction. The translation is signed to indicate direction (negative is to wide, positive is to tele). There is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension. This results in the following space description.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
      • ContinuousPanTiltVelocitySpace - optional, unbounded; [Space2DDescription]
        The generic Pan/Tilt velocity space shall be provided by every PTZ node, since it does not relate to a specific physical range. Instead, the range should be defined as a range of the PTZ unit's speed normalized to the range -1 to 1, where a positive velocity would map to clockwise rotation or movement in the right/up direction. A signed speed can be independently specified for the pan and tilt component resulting in the following space description.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
        • YRange [FloatRange]
          A range of y-axis.
          • Min [float]
          • Max [float]
      • ContinuousZoomVelocitySpace - optional, unbounded; [Space1DDescription]
        The generic zoom velocity space specifies a zoom factor velocity without knowing the underlying physical model. The range should be normalized from -1 to 1, where a positive velocity would map to TELE direction. A generic zoom velocity space description resembles the following.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
      • PanTiltSpeedSpace - optional, unbounded; [Space1DDescription]
        The speed space specifies the speed for a Pan/Tilt movement when moving to an absolute position or to a relative translation. In contrast to the velocity spaces, speed spaces do not contain any directional information. The speed of a combined Pan/Tilt movement is represented by a single non-negative scalar value.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
      • ZoomSpeedSpace - optional, unbounded; [Space1DDescription]
        The speed space specifies the speed for a Zoom movement when moving to an absolute position or to a relative translation. In contrast to the velocity spaces, speed spaces do not contain any directional information.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
      • Extension - optional; [PTZSpacesExtension]
    • PTZTimeout [DurationRange]
      A timeout Range within which Timeouts are accepted by the PTZ Node.
      • Min [duration]
      • Max [duration]
    • PTControlDirection - optional; [PTControlDirectionOptions]
      Supported options for PT Direction Control.
      • EFlip - optional; [EFlipOptions]
        Supported options for EFlip feature.
        • Mode - optional, unbounded; [EFlipMode]
          Options of EFlip mode parameter.
          Enum Value Enum Description
          OFF —
          ON —
          Extended —
        • Extension - optional; [EFlipOptionsExtension]
      • Reverse - optional; [ReverseOptions]
        Supported options for Reverse feature.
        • Mode - optional, unbounded; [ReverseMode]
          Options of Reverse mode parameter.
          Enum Value Enum Description
          OFF —
          ON —
          AUTO —
          Extended —
        • Extension - optional; [ReverseOptionsExtension]
      • Extension - optional; [PTControlDirectionOptionsExtension]
    • Extension - optional; [PTZConfigurationOptions2]

GotoHomePosition 

GotoHomePosition(ProfileToken, Speed=None)

Operation to move the PTZ device to it's "home" position.

The operation is supported if the HomeSupported element in the PTZNode is true.

Input
  • ProfileToken [ReferenceToken]
    A reference to the MediaProfile where the operation should take place.
    Maximum length: 64
  • Speed - optional; [PTZSpeed]
    A requested speed.The speed parameter can only be specified when Speed Spaces are available for the PTZ Node.
    • PanTilt - optional; [Vector2D]
      Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
      • x - required; [float]
      • y - required; [float]
      • space - optional; [anyURI]
        Pan/tilt coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • Zoom - optional; [Vector1D]
      A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
      • x - required; [float]
      • space - optional; [anyURI]
        Zoom coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace

SetHomePosition 

SetHomePosition(ProfileToken)

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.

Input
  • ProfileToken [ReferenceToken]
    A reference to the MediaProfile where the home position should be set.
    Maximum length: 64

ContinuousMove 

ContinuousMove(ProfileToken, Velocity, Timeout=None)

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.

Input
  • ProfileToken [ReferenceToken]
    A reference to the MediaProfile.
    Maximum length: 64
  • Velocity [PTZSpeed]
    A Velocity vector specifying the velocity of pan, tilt and zoom.
    • PanTilt - optional; [Vector2D]
      Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
      • x - required; [float]
      • y - required; [float]
      • space - optional; [anyURI]
        Pan/tilt coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • Zoom - optional; [Vector1D]
      A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
      • x - required; [float]
      • space - optional; [anyURI]
        Zoom coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
  • Timeout - optional; [duration]
    An optional Timeout parameter.

RelativeMove 

RelativeMove(ProfileToken, Translation, Speed=None)

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.

The speed argument is optional. If an x/y speed value is given it is up to the device to either use the x value as absolute resoluting speed vector or to map x and y to the component speed. If the speed argument is omitted, the default speed set by the PTZConfiguration will be used.

Input
  • ProfileToken [ReferenceToken]
    A reference to the MediaProfile.
    Maximum length: 64
  • Translation [PTZVector]
    A positional Translation relative to the current position
    • PanTilt - optional; [Vector2D]
      Pan and tilt position. The x component corresponds to pan and the y component to tilt.
      • x - required; [float]
      • y - required; [float]
      • space - optional; [anyURI]
        Pan/tilt coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • Zoom - optional; [Vector1D]
      A zoom position.
      • x - required; [float]
      • space - optional; [anyURI]
        Zoom coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
  • Speed - optional; [PTZSpeed]
    An optional Speed parameter.
    • PanTilt - optional; [Vector2D]
      Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
      • x - required; [float]
      • y - required; [float]
      • space - optional; [anyURI]
        Pan/tilt coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • Zoom - optional; [Vector1D]
      A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
      • x - required; [float]
      • space - optional; [anyURI]
        Zoom coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace

AbsoluteMove 

AbsoluteMove(ProfileToken, Position, Speed=None)

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

The speed argument is optional. If an x/y speed value is given it is up to the device to either use the x value as absolute resoluting speed vector or to map x and y to the component speed. If the speed argument is omitted, the default speed set by the PTZConfiguration will be used.

Input
  • ProfileToken [ReferenceToken]
    A reference to the MediaProfile.
    Maximum length: 64
  • Position [PTZVector]
    A Position vector specifying the absolute target position.
    • PanTilt - optional; [Vector2D]
      Pan and tilt position. The x component corresponds to pan and the y component to tilt.
      • x - required; [float]
      • y - required; [float]
      • space - optional; [anyURI]
        Pan/tilt coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • Zoom - optional; [Vector1D]
      A zoom position.
      • x - required; [float]
      • space - optional; [anyURI]
        Zoom coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
  • Speed - optional; [PTZSpeed]
    An optional Speed.
    • PanTilt - optional; [Vector2D]
      Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
      • x - required; [float]
      • y - required; [float]
      • space - optional; [anyURI]
        Pan/tilt coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • Zoom - optional; [Vector1D]
      A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
      • x - required; [float]
      • space - optional; [anyURI]
        Zoom coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace

GeoMove 

GeoMove(
    ProfileToken,
    Target,
    Speed=None,
    AreaHeight=None,
    AreaWidth=None,
)

Operation to move pan,tilt or zoom to point to a destination based on the geolocation of the target.

The speed argument is optional. If an x/y speed value is given it is up to the device to either use the x value as absolute resoluting speed vector or to map x and y to the component speed. If the speed argument is omitted, the default speed set by the PTZConfiguration will be used. The area height and area dwidth parameters are optional, they can be used independently and may be used by the device to automatically determine the best zoom level to show the target.

Input
  • ProfileToken [ReferenceToken]
    A reference to the MediaProfile.
    Maximum length: 64
  • Target [GeoLocation]
    The geolocation of the target position.
    • lon - optional; [double]
      East west location as angle.
    • lat - optional; [double]
      North south location as angle.
    • elevation - optional; [float]
      Height in meters above sea level.
  • Speed - optional; [PTZSpeed]
    An optional Speed.
    • PanTilt - optional; [Vector2D]
      Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
      • x - required; [float]
      • y - required; [float]
      • space - optional; [anyURI]
        Pan/tilt coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • Zoom - optional; [Vector1D]
      A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
      • x - required; [float]
      • space - optional; [anyURI]
        Zoom coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
  • AreaHeight - optional; [float]
    An optional indication of the height of the target/area.
  • AreaWidth - optional; [float]
    An optional indication of the width of the target/area.

Stop 

Stop(ProfileToken, PanTilt=None, Zoom=None)

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.

Input
  • ProfileToken [ReferenceToken]
    A reference to the MediaProfile that indicate what should be stopped.
    Maximum length: 64
  • PanTilt - optional; [boolean]
    Set true when we want to stop ongoing pan and tilt movements.If PanTilt arguments are not present, this command stops these movements.
  • Zoom - optional; [boolean]
    Set true when we want to stop ongoing zoom movement.If Zoom arguments are not present, this command stops ongoing zoom movement.

SendAuxiliaryCommand 

SendAuxiliaryCommand(ProfileToken, AuxiliaryData)

Operation to send auxiliary commands to the PTZ device mapped by the PTZNode in the selected profile.

The operation is supported if the AuxiliarySupported element of the PTZNode is true

Input
  • ProfileToken [ReferenceToken]
    A reference to the MediaProfile where the operation should take place.
    Maximum length: 64
  • AuxiliaryData [AuxiliaryData]
    The Auxiliary request data.
    Maximum length: 128
Output
  • AuxiliaryResponse [AuxiliaryData]
    The response contains the auxiliary response.
    Maximum length: 128

GetPresetTours 

GetPresetTours(ProfileToken)

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

Input
  • ProfileToken [ReferenceToken]
    Maximum length: 64
Output
  • PresetTour - optional, unbounded; [PresetTour]
    • token - optional; [ReferenceToken]
      Unique identifier of this preset tour.
    • Name - optional; [Name]
      Readable name of the preset tour.
      Maximum length: 64
    • Status [PTZPresetTourStatus]
      Read only parameters to indicate the status of the preset tour.
      • State [PTZPresetTourState]
        Indicates state of this preset tour by Idle/Touring/Paused.
        Enum Value Enum Description
        Idle —
        Touring —
        Paused —
        Extended —
      • CurrentTourSpot - optional; [PTZPresetTourSpot]
        Indicates a tour spot currently staying.
        • PresetDetail [PTZPresetTourPresetDetail]
          Detail definition of preset position of the tour spot.
          • PresetToken [ReferenceToken]
            Option to specify the preset position with Preset Token defined in advance.
            Maximum length: 64
          • Home [boolean]
            Option to specify the preset position with the home position of this PTZ Node. "False" to this parameter shall be treated as an invalid argument.
          • PTZPosition [PTZVector]
            Option to specify the preset position with vector of PTZ node directly.
            • PanTilt - optional; [Vector2D]
              Pan and tilt position. The x component corresponds to pan and the y component to tilt.
              • x - required; [float]
              • y - required; [float]
              • space - optional; [anyURI]
                Pan/tilt coordinate space selector. The following options are defined:
                • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
                • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
                • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
                • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
            • Zoom - optional; [Vector1D]
              A zoom position.
              • x - required; [float]
              • space - optional; [anyURI]
                Zoom coordinate space selector. The following options are defined:
                • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
                • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
                • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
                • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
          • TypeExtension [PTZPresetTourTypeExtension]
        • Speed - optional; [PTZSpeed]
          Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot.
          • PanTilt - optional; [Vector2D]
            Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
            • x - required; [float]
            • y - required; [float]
            • space - optional; [anyURI]
              Pan/tilt coordinate space selector. The following options are defined:
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
          • Zoom - optional; [Vector1D]
            A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
            • x - required; [float]
            • space - optional; [anyURI]
              Zoom coordinate space selector. The following options are defined:
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
        • StayTime - optional; [duration]
          Optional parameter to specify time duration of staying on this tour sport.
        • Extension - optional; [PTZPresetTourSpotExtension]
      • Extension - optional; [PTZPresetTourStatusExtension]
    • AutoStart [boolean]
      Auto Start flag of the preset tour. True allows the preset tour to be activated always.
    • StartingCondition [PTZPresetTourStartingCondition]
      Parameters to specify the detail behavior of the preset tour.
      • RandomPresetOrder - optional; [boolean]
        Execute presets in random order. If set to true and Direction is also present, Direction will be ignored and presets of the Tour will be recalled randomly.
      • RecurringTime - optional; [int]
        Optional parameter to specify how many times the preset tour is recurred.
      • RecurringDuration - optional; [duration]
        Optional parameter to specify how long time duration the preset tour is recurred.
      • Direction - optional; [PTZPresetTourDirection]
        Optional parameter to choose which direction the preset tour goes. Forward shall be chosen in case it is omitted.
        Enum Value Enum Description
        Forward —
        Backward —
        Extended —
      • Extension - optional; [PTZPresetTourStartingConditionExtension]
    • TourSpot - optional, unbounded; [PTZPresetTourSpot]
      A list of detail of touring spots including preset positions.
      • PresetDetail [PTZPresetTourPresetDetail]
        Detail definition of preset position of the tour spot.
        • PresetToken [ReferenceToken]
          Option to specify the preset position with Preset Token defined in advance.
          Maximum length: 64
        • Home [boolean]
          Option to specify the preset position with the home position of this PTZ Node. "False" to this parameter shall be treated as an invalid argument.
        • PTZPosition [PTZVector]
          Option to specify the preset position with vector of PTZ node directly.
          • PanTilt - optional; [Vector2D]
            Pan and tilt position. The x component corresponds to pan and the y component to tilt.
            • x - required; [float]
            • y - required; [float]
            • space - optional; [anyURI]
              Pan/tilt coordinate space selector. The following options are defined:
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
          • Zoom - optional; [Vector1D]
            A zoom position.
            • x - required; [float]
            • space - optional; [anyURI]
              Zoom coordinate space selector. The following options are defined:
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
        • TypeExtension [PTZPresetTourTypeExtension]
      • Speed - optional; [PTZSpeed]
        Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot.
        • PanTilt - optional; [Vector2D]
          Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
          • x - required; [float]
          • y - required; [float]
          • space - optional; [anyURI]
            Pan/tilt coordinate space selector. The following options are defined:
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
        • Zoom - optional; [Vector1D]
          A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
          • x - required; [float]
          • space - optional; [anyURI]
            Zoom coordinate space selector. The following options are defined:
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
      • StayTime - optional; [duration]
        Optional parameter to specify time duration of staying on this tour sport.
      • Extension - optional; [PTZPresetTourSpotExtension]
    • Extension - optional; [PTZPresetTourExtension]

GetPresetTour 

GetPresetTour(ProfileToken, PresetTourToken)

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

Input
  • ProfileToken [ReferenceToken]
    Maximum length: 64
  • PresetTourToken [ReferenceToken]
    Maximum length: 64
Output
  • PresetTour [PresetTour]
    • token - optional; [ReferenceToken]
      Unique identifier of this preset tour.
    • Name - optional; [Name]
      Readable name of the preset tour.
      Maximum length: 64
    • Status [PTZPresetTourStatus]
      Read only parameters to indicate the status of the preset tour.
      • State [PTZPresetTourState]
        Indicates state of this preset tour by Idle/Touring/Paused.
        Enum Value Enum Description
        Idle —
        Touring —
        Paused —
        Extended —
      • CurrentTourSpot - optional; [PTZPresetTourSpot]
        Indicates a tour spot currently staying.
        • PresetDetail [PTZPresetTourPresetDetail]
          Detail definition of preset position of the tour spot.
          • PresetToken [ReferenceToken]
            Option to specify the preset position with Preset Token defined in advance.
            Maximum length: 64
          • Home [boolean]
            Option to specify the preset position with the home position of this PTZ Node. "False" to this parameter shall be treated as an invalid argument.
          • PTZPosition [PTZVector]
            Option to specify the preset position with vector of PTZ node directly.
            • PanTilt - optional; [Vector2D]
              Pan and tilt position. The x component corresponds to pan and the y component to tilt.
              • x - required; [float]
              • y - required; [float]
              • space - optional; [anyURI]
                Pan/tilt coordinate space selector. The following options are defined:
                • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
                • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
                • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
                • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
            • Zoom - optional; [Vector1D]
              A zoom position.
              • x - required; [float]
              • space - optional; [anyURI]
                Zoom coordinate space selector. The following options are defined:
                • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
                • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
                • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
                • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
          • TypeExtension [PTZPresetTourTypeExtension]
        • Speed - optional; [PTZSpeed]
          Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot.
          • PanTilt - optional; [Vector2D]
            Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
            • x - required; [float]
            • y - required; [float]
            • space - optional; [anyURI]
              Pan/tilt coordinate space selector. The following options are defined:
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
          • Zoom - optional; [Vector1D]
            A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
            • x - required; [float]
            • space - optional; [anyURI]
              Zoom coordinate space selector. The following options are defined:
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
        • StayTime - optional; [duration]
          Optional parameter to specify time duration of staying on this tour sport.
        • Extension - optional; [PTZPresetTourSpotExtension]
      • Extension - optional; [PTZPresetTourStatusExtension]
    • AutoStart [boolean]
      Auto Start flag of the preset tour. True allows the preset tour to be activated always.
    • StartingCondition [PTZPresetTourStartingCondition]
      Parameters to specify the detail behavior of the preset tour.
      • RandomPresetOrder - optional; [boolean]
        Execute presets in random order. If set to true and Direction is also present, Direction will be ignored and presets of the Tour will be recalled randomly.
      • RecurringTime - optional; [int]
        Optional parameter to specify how many times the preset tour is recurred.
      • RecurringDuration - optional; [duration]
        Optional parameter to specify how long time duration the preset tour is recurred.
      • Direction - optional; [PTZPresetTourDirection]
        Optional parameter to choose which direction the preset tour goes. Forward shall be chosen in case it is omitted.
        Enum Value Enum Description
        Forward —
        Backward —
        Extended —
      • Extension - optional; [PTZPresetTourStartingConditionExtension]
    • TourSpot - optional, unbounded; [PTZPresetTourSpot]
      A list of detail of touring spots including preset positions.
      • PresetDetail [PTZPresetTourPresetDetail]
        Detail definition of preset position of the tour spot.
        • PresetToken [ReferenceToken]
          Option to specify the preset position with Preset Token defined in advance.
          Maximum length: 64
        • Home [boolean]
          Option to specify the preset position with the home position of this PTZ Node. "False" to this parameter shall be treated as an invalid argument.
        • PTZPosition [PTZVector]
          Option to specify the preset position with vector of PTZ node directly.
          • PanTilt - optional; [Vector2D]
            Pan and tilt position. The x component corresponds to pan and the y component to tilt.
            • x - required; [float]
            • y - required; [float]
            • space - optional; [anyURI]
              Pan/tilt coordinate space selector. The following options are defined:
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
          • Zoom - optional; [Vector1D]
            A zoom position.
            • x - required; [float]
            • space - optional; [anyURI]
              Zoom coordinate space selector. The following options are defined:
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
        • TypeExtension [PTZPresetTourTypeExtension]
      • Speed - optional; [PTZSpeed]
        Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot.
        • PanTilt - optional; [Vector2D]
          Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
          • x - required; [float]
          • y - required; [float]
          • space - optional; [anyURI]
            Pan/tilt coordinate space selector. The following options are defined:
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
        • Zoom - optional; [Vector1D]
          A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
          • x - required; [float]
          • space - optional; [anyURI]
            Zoom coordinate space selector. The following options are defined:
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
      • StayTime - optional; [duration]
        Optional parameter to specify time duration of staying on this tour sport.
      • Extension - optional; [PTZPresetTourSpotExtension]
    • Extension - optional; [PTZPresetTourExtension]

GetPresetTourOptions 

GetPresetTourOptions(ProfileToken, PresetTourToken=None)

Operation to request available options to configure PTZ preset tour.

Input
  • ProfileToken [ReferenceToken]
    Maximum length: 64
  • PresetTourToken - optional; [ReferenceToken]
    Maximum length: 64
Output
  • Options [PTZPresetTourOptions]
    • AutoStart [boolean]
      Indicates whether or not the AutoStart is supported.
    • StartingCondition [PTZPresetTourStartingConditionOptions]
      Supported options for Preset Tour Starting Condition.
      • RecurringTime - optional; [IntRange]
        Supported range of Recurring Time.
        • Min [int]
        • Max [int]
      • RecurringDuration - optional; [DurationRange]
        Supported range of Recurring Duration.
        • Min [duration]
        • Max [duration]
      • Direction - optional, unbounded; [PTZPresetTourDirection]
        Supported options for Direction of Preset Tour.
        Enum Value Enum Description
        Forward —
        Backward —
        Extended —
      • Extension - optional; [PTZPresetTourStartingConditionOptionsExtension]
    • TourSpot [PTZPresetTourSpotOptions]
      Supported options for Preset Tour Spot.
      • PresetDetail [PTZPresetTourPresetDetailOptions]
        Supported options for detail definition of preset position of the tour spot.
        • PresetToken - optional, unbounded; [ReferenceToken]
          A list of available Preset Tokens for tour spots.
          Maximum length: 64
        • Home - optional; [boolean]
          An option to indicate Home position for tour spots.
        • PanTiltPositionSpace - optional; [Space2DDescription]
          Supported range of Pan and Tilt for tour spots.
          • URI [anyURI]
            A URI of coordinate systems.
          • XRange [FloatRange]
            A range of x-axis.
            • Min [float]
            • Max [float]
          • YRange [FloatRange]
            A range of y-axis.
            • Min [float]
            • Max [float]
        • ZoomPositionSpace - optional; [Space1DDescription]
          Supported range of Zoom for a tour spot.
          • URI [anyURI]
            A URI of coordinate systems.
          • XRange [FloatRange]
            A range of x-axis.
            • Min [float]
            • Max [float]
        • Extension - optional; [PTZPresetTourPresetDetailOptionsExtension]
      • StayTime [DurationRange]
        Supported range of stay time for a tour spot.
        • Min [duration]
        • Max [duration]

CreatePresetTour 

CreatePresetTour(ProfileToken)

Operation to create a preset tour for the selected media profile.

Input
  • ProfileToken [ReferenceToken]
    Maximum length: 64
Output
  • PresetTourToken [ReferenceToken]
    Maximum length: 64

ModifyPresetTour 

ModifyPresetTour(ProfileToken, PresetTour)

Operation to modify a preset tour for the selected media profile.

Input
  • ProfileToken [ReferenceToken]
    Maximum length: 64
  • PresetTour [PresetTour]
    • token - optional; [ReferenceToken]
      Unique identifier of this preset tour.
    • Name - optional; [Name]
      Readable name of the preset tour.
      Maximum length: 64
    • Status [PTZPresetTourStatus]
      Read only parameters to indicate the status of the preset tour.
      • State [PTZPresetTourState]
        Indicates state of this preset tour by Idle/Touring/Paused.
        Enum Value Enum Description
        Idle —
        Touring —
        Paused —
        Extended —
      • CurrentTourSpot - optional; [PTZPresetTourSpot]
        Indicates a tour spot currently staying.
        • PresetDetail [PTZPresetTourPresetDetail]
          Detail definition of preset position of the tour spot.
          • PresetToken [ReferenceToken]
            Option to specify the preset position with Preset Token defined in advance.
            Maximum length: 64
          • Home [boolean]
            Option to specify the preset position with the home position of this PTZ Node. "False" to this parameter shall be treated as an invalid argument.
          • PTZPosition [PTZVector]
            Option to specify the preset position with vector of PTZ node directly.
            • PanTilt - optional; [Vector2D]
              Pan and tilt position. The x component corresponds to pan and the y component to tilt.
              • x - required; [float]
              • y - required; [float]
              • space - optional; [anyURI]
                Pan/tilt coordinate space selector. The following options are defined:
                • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
                • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
                • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
                • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
            • Zoom - optional; [Vector1D]
              A zoom position.
              • x - required; [float]
              • space - optional; [anyURI]
                Zoom coordinate space selector. The following options are defined:
                • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
                • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
                • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
                • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
          • TypeExtension [PTZPresetTourTypeExtension]
        • Speed - optional; [PTZSpeed]
          Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot.
          • PanTilt - optional; [Vector2D]
            Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
            • x - required; [float]
            • y - required; [float]
            • space - optional; [anyURI]
              Pan/tilt coordinate space selector. The following options are defined:
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
          • Zoom - optional; [Vector1D]
            A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
            • x - required; [float]
            • space - optional; [anyURI]
              Zoom coordinate space selector. The following options are defined:
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
        • StayTime - optional; [duration]
          Optional parameter to specify time duration of staying on this tour sport.
        • Extension - optional; [PTZPresetTourSpotExtension]
      • Extension - optional; [PTZPresetTourStatusExtension]
    • AutoStart [boolean]
      Auto Start flag of the preset tour. True allows the preset tour to be activated always.
    • StartingCondition [PTZPresetTourStartingCondition]
      Parameters to specify the detail behavior of the preset tour.
      • RandomPresetOrder - optional; [boolean]
        Execute presets in random order. If set to true and Direction is also present, Direction will be ignored and presets of the Tour will be recalled randomly.
      • RecurringTime - optional; [int]
        Optional parameter to specify how many times the preset tour is recurred.
      • RecurringDuration - optional; [duration]
        Optional parameter to specify how long time duration the preset tour is recurred.
      • Direction - optional; [PTZPresetTourDirection]
        Optional parameter to choose which direction the preset tour goes. Forward shall be chosen in case it is omitted.
        Enum Value Enum Description
        Forward —
        Backward —
        Extended —
      • Extension - optional; [PTZPresetTourStartingConditionExtension]
    • TourSpot - optional, unbounded; [PTZPresetTourSpot]
      A list of detail of touring spots including preset positions.
      • PresetDetail [PTZPresetTourPresetDetail]
        Detail definition of preset position of the tour spot.
        • PresetToken [ReferenceToken]
          Option to specify the preset position with Preset Token defined in advance.
          Maximum length: 64
        • Home [boolean]
          Option to specify the preset position with the home position of this PTZ Node. "False" to this parameter shall be treated as an invalid argument.
        • PTZPosition [PTZVector]
          Option to specify the preset position with vector of PTZ node directly.
          • PanTilt - optional; [Vector2D]
            Pan and tilt position. The x component corresponds to pan and the y component to tilt.
            • x - required; [float]
            • y - required; [float]
            • space - optional; [anyURI]
              Pan/tilt coordinate space selector. The following options are defined:
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
              • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
          • Zoom - optional; [Vector1D]
            A zoom position.
            • x - required; [float]
            • space - optional; [anyURI]
              Zoom coordinate space selector. The following options are defined:
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
              • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
        • TypeExtension [PTZPresetTourTypeExtension]
      • Speed - optional; [PTZSpeed]
        Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot.
        • PanTilt - optional; [Vector2D]
          Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
          • x - required; [float]
          • y - required; [float]
          • space - optional; [anyURI]
            Pan/tilt coordinate space selector. The following options are defined:
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
            • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
        • Zoom - optional; [Vector1D]
          A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
          • x - required; [float]
          • space - optional; [anyURI]
            Zoom coordinate space selector. The following options are defined:
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
            • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
      • StayTime - optional; [duration]
        Optional parameter to specify time duration of staying on this tour sport.
      • Extension - optional; [PTZPresetTourSpotExtension]
    • Extension - optional; [PTZPresetTourExtension]

OperatePresetTour 

OperatePresetTour(ProfileToken, PresetTourToken, Operation)

Operation to perform specific operation on the preset tour in selected media profile.

Input
  • ProfileToken [ReferenceToken]
    Maximum length: 64
  • PresetTourToken [ReferenceToken]
    Maximum length: 64
  • Operation [PTZPresetTourOperation]
    Enum Value Enum Description
    Start —
    Stop —
    Pause —
    Extended —

RemovePresetTour 

RemovePresetTour(ProfileToken, PresetTourToken)

Operation to delete a specific preset tour from the media profile.

Input
  • ProfileToken [ReferenceToken]
    Maximum length: 64
  • PresetTourToken [ReferenceToken]
    Maximum length: 64

GetCompatibleConfigurations 

GetCompatibleConfigurations(ProfileToken)

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.

Input
  • ProfileToken [ReferenceToken]
    Contains the token of an existing media profile the configurations shall be compatible with.
    Maximum length: 64
Output
  • PTZConfiguration - optional, unbounded; [PTZConfiguration]
    A list of all existing PTZConfigurations on the NVT that is suitable to be added to the addressed media profile.
    • MoveRamp - optional; [int]
      The optional acceleration ramp used by the device when moving.
    • PresetRamp - optional; [int]
      The optional acceleration ramp used by the device when recalling presets.
    • PresetTourRamp - optional; [int]
      The optional acceleration ramp used by the device when executing PresetTours.
    • Name [Name]
      User readable name. Length up to 64 characters.
      Maximum length: 64
    • UseCount [int]
      Number of internal references currently using this configuration.

      This informational parameter is read-only. Deprecated for Media2 Service.

    • NodeToken [ReferenceToken]
      A mandatory reference to the PTZ Node that the PTZ Configuration belongs to.
      Maximum length: 64
    • DefaultAbsolutePantTiltPositionSpace - optional; [anyURI]
      If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default.
    • DefaultAbsoluteZoomPositionSpace - optional; [anyURI]
      If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default.
    • DefaultRelativePanTiltTranslationSpace - optional; [anyURI]
      If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default.
    • DefaultRelativeZoomTranslationSpace - optional; [anyURI]
      If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default.
    • DefaultContinuousPanTiltVelocitySpace - optional; [anyURI]
      If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default.
    • DefaultContinuousZoomVelocitySpace - optional; [anyURI]
      If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default.
    • DefaultPTZSpeed - optional; [PTZSpeed]
      If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds.
      • PanTilt - optional; [Vector2D]
        Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
        • x - required; [float]
        • y - required; [float]
        • space - optional; [anyURI]
          Pan/tilt coordinate space selector. The following options are defined:
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
          • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
      • Zoom - optional; [Vector1D]
        A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
        • x - required; [float]
        • space - optional; [anyURI]
          Zoom coordinate space selector. The following options are defined:
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
          • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
    • DefaultPTZTimeout - optional; [duration]
      If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops.
    • PanTiltLimits - optional; [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.
      • Range [Space2DDescription]
        A range of pan tilt limits.
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
        • YRange [FloatRange]
          A range of y-axis.
          • Min [float]
          • Max [float]
    • ZoomLimits - optional; [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.
      • Range [Space1DDescription]
        A range of zoom limit
        • URI [anyURI]
          A URI of coordinate systems.
        • XRange [FloatRange]
          A range of x-axis.
          • Min [float]
          • Max [float]
    • Extension - optional; [PTZConfigurationExtension]
      • PTControlDirection - optional; [PTControlDirection]
        Optional element to configure PT Control Direction related features.
        • EFlip - optional; [EFlip]
          Optional element to configure related parameters for E-Flip.
          • Mode [EFlipMode]
            Parameter to enable/disable E-Flip feature.
            Enum Value Enum Description
            OFF —
            ON —
            Extended —
        • Reverse - optional; [Reverse]
          Optional element to configure related parameters for reversing of PT Control Direction.
          • Mode [ReverseMode]
            Parameter to enable/disable Reverse feature.
            Enum Value Enum Description
            OFF —
            ON —
            AUTO —
            Extended —
        • Extension - optional; [PTControlDirectionExtension]
      • Extension - optional; [PTZConfigurationExtension2]

MoveAndStartTracking 

MoveAndStartTracking(
    ProfileToken,
    ObjectID,
    PresetToken=None,
    GeoLocation=None,
    TargetPosition=None,
    Speed=None,
)

Operation to send an an atomic command to the device: move the camera to a wanted position and then delegate the PTZ control to the tracking algorithm.

An existing Speed argument overrides DefaultSpeed of the corresponding PTZ configuration during movement to the requested position. If spaces are referenced within the Speed argument, they shall be speed spaces supported by the PTZ node.

If the detection and the tracking are done in the same device, an ObjectID reference can be passed as an argument, in order to specify which object should be tracked.

The operation shall fail if the requested absolute position is not reachable.

Input
  • ProfileToken [ReferenceToken]
    A reference to the MediaProfile where the operation should take place.
    Maximum length: 64
  • PresetToken - optional; [ReferenceToken]
    A preset token.
    Maximum length: 64
  • GeoLocation - optional; [GeoLocation]
    The geolocation of the target position.
    • lon - optional; [double]
      East west location as angle.
    • lat - optional; [double]
      North south location as angle.
    • elevation - optional; [float]
      Height in meters above sea level.
  • TargetPosition - optional; [PTZVector]
    A Position vector specifying the absolute target position.
    • PanTilt - optional; [Vector2D]
      Pan and tilt position. The x component corresponds to pan and the y component to tilt.
      • x - required; [float]
      • y - required; [float]
      • space - optional; [anyURI]
        Pan/tilt coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • Zoom - optional; [Vector1D]
      A zoom position.
      • x - required; [float]
      • space - optional; [anyURI]
        Zoom coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
  • Speed - optional; [PTZSpeed]
    Speed vector specifying the velocity of pan, tilt and zoom.
    • PanTilt - optional; [Vector2D]
      Pan and tilt speed. The x component corresponds to pan and the y component to tilt. If omitted in a request, the current (if any) PanTilt movement should not be affected.
      • x - required; [float]
      • y - required; [float]
      • space - optional; [anyURI]
        Pan/tilt coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace
    • Zoom - optional; [Vector1D]
      A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected.
      • x - required; [float]
      • space - optional; [anyURI]
        Zoom coordinate space selector. The following options are defined:
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace
        • http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace
  • ObjectID - optional; [integer]
    Object ID of the object to track.