Skip to content

Provisioning

Provisioning service implementation.

Provisioning

Bases: ONVIFService

0.0.1 16.12

Provisioning service client.

Property Details
First introduced ONVIF 16.12 (December 2016)
Binding name ProvisioningBinding (ver10/provisioning/wsdl/provisioning.wsdl)
Operations provisioning.wsdl
Spec Provisioning

GetServiceCapabilities 

GetServiceCapabilities()

Returns the capabilities of the provisioning service.

Output
  • Capabilities [Capabilities]
    The capabilities for the provisioning service on this device.
    • DefaultTimeout [duration]
      Maximum time before stopping movement after a move operation.
    • Source - optional, unbounded; [SourceCapabilities]
      Capabilities per video source.
      • VideoSourceToken - required; [ReferenceToken]
        Unique identifier of a video source.
      • MaximumPanMoves - optional; [positiveInteger]
        Lifetime limit of pan moves for this video source. Presence of this attribute indicates support of pan move.
      • MaximumTiltMoves - optional; [positiveInteger]
        Lifetime limit of tilt moves for this video source. Presence of this attribute indicates support of tilt move.
      • MaximumZoomMoves - optional; [positiveInteger]
        Lifetime limit of zoom moves for this video source. Presence of this attribute indicates support of zoom move.
      • MaximumRollMoves - optional; [positiveInteger]
        Lifetime limit of roll moves for this video source. Presence of this attribute indicates support of roll move.
      • AutoLevel - optional; [boolean]
        Indicates "auto" as a valid enum for Direction in RollMove.
      • MaximumFocusMoves - optional; [positiveInteger]
        Lifetime limit of focus moves for this video source. Presence of this attribute indicates support of focus move.
      • AutoFocus - optional; [boolean]
        Indicates "auto" as a valid enum for Direction in FocusMove.

PanMove 

PanMove(VideoSource, Direction, Timeout=None)

Moves device on the pan axis.

Input
  • VideoSource [ReferenceToken]
    The video source associated with the provisioning.
    Maximum length: 64
  • Direction [PanDirection]
    "left" or "right".
    Enum Value Enum Description
    Left Move left in relation to the video source image.
    Right Move right in relation to the video source image.
  • Timeout - optional; [duration]
    "Operation timeout, if less than default timeout.

TiltMove 

TiltMove(VideoSource, Direction, Timeout=None)

Moves device on the tilt axis.

Input
  • VideoSource [ReferenceToken]
    The video source associated with the provisioning.
    Maximum length: 64
  • Direction [TiltDirection]
    "up" or "down".
    Enum Value Enum Description
    Up Move up in relation to the video source image.
    Down Move down in relation to the video source image.
  • Timeout - optional; [duration]
    "Operation timeout, if less than default timeout.

ZoomMove 

ZoomMove(VideoSource, Direction, Timeout=None)

Moves device on the zoom axis.

Input
  • VideoSource [ReferenceToken]
    The video source associated with the provisioning.
    Maximum length: 64
  • Direction [ZoomDirection]
    "wide" or "telephoto".
    Enum Value Enum Description
    Wide Move video source lens toward a wider field of view.
    Telephoto Move video source lens toward a narrower field of view.
  • Timeout - optional; [duration]
    "Operation timeout, if less than default timeout.

RollMove 

RollMove(VideoSource, Direction, Timeout=None)

Moves device on the roll axis.

Input
  • VideoSource [ReferenceToken]
    The video source associated with the provisioning.
    Maximum length: 64
  • Direction [RollDirection]
    "clockwise", "counterclockwise", or "auto".
    Enum Value Enum Description
    Clockwise Move clockwise in relation to the video source image.
    Counterclockwise Move counterclockwise in relation to the video source image.
    Auto Automatically level the device in relation to the video source image.
  • Timeout - optional; [duration]
    "Operation timeout, if less than default timeout.

FocusMove 

FocusMove(VideoSource, Direction, Timeout=None)

Moves device on the focus axis.

Input
  • VideoSource [ReferenceToken]
    The video source associated with the provisioning.
    Maximum length: 64
  • Direction [FocusDirection]
    "near", "far", or "auto".
    Enum Value Enum Description
    Near Move to focus on close objects.
    Far Move to focus on distant objects.
    Auto Automatically focus for the sharpest video source image.
  • Timeout - optional; [duration]
    "Operation timeout, if less than default timeout.

Stop 

Stop(VideoSource)

Stops device motion on all axes.

Input
  • VideoSource [ReferenceToken]
    The video source associated with the provisioning.
    Maximum length: 64

GetUsage 

GetUsage(VideoSource)

Returns the lifetime move counts.

Input
  • VideoSource [ReferenceToken]
    The video source associated with the provisioning.
    Maximum length: 64
Output
  • Usage [Usage]
    The set of lifetime usage values for the provisioning associated with the video source.
    • Pan - optional; [positiveInteger]
      The quantity of pan movement events over the life of the device.
    • Tilt - optional; [positiveInteger]
      The quantity of tilt movement events over the life of the device.
    • Zoom - optional; [positiveInteger]
      The quantity of zoom movement events over the life of the device.
    • Roll - optional; [positiveInteger]
      The quantity of roll movement events over the life of the device.
    • Focus - optional; [positiveInteger]
      The quantity of focus movement events over the life of the device.