ONVIF::Device::Types::PresetTour (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/ONVIF::Device::Types::PresetTour.3pm".)

NAME

ONVIF::Device::Types::PresetTour

DESCRIPTION

Perl data type class for the Schema defined complexType PresetTour from the namespace www.onvif.org/ver10/schema

PROPERTIES

The following properties may be accessed using get_PROPERTY / set_PROPERTY methods:

*

Name

*

Status

*

AutoStart

*

StartingCondition

*

TourSpot

*

Extension

METHODS

new

Constructor. The following data structure may be passed to new():

 { # ONVIF::Device::Types::PresetTour
   Name => $some_value, # Name
   Status =>  { # ONVIF::Device::Types::PTZPresetTourStatus
     State => $some_value, # PTZPresetTourState
     CurrentTourSpot =>  { # ONVIF::Device::Types::PTZPresetTourSpot
       PresetDetail =>        { # ONVIF::Device::Types::PTZPresetTourPresetDetail
         # One of the following elements.
         # No occurrence checks yet, so be sure to pass just one...
         PresetToken => $some_value, # ReferenceToken
         Home =>  $some_value, # boolean
         PTZPosition =>  { # ONVIF::Device::Types::PTZVector
           PanTilt => ,
           Zoom => ,
         },
         TypeExtension =>  { # ONVIF::Device::Types::PTZPresetTourTypeExtension
         },
       },
       Speed =>  { # ONVIF::Device::Types::PTZSpeed
         PanTilt => ,
         Zoom => ,
       },
       StayTime =>  $some_value, # duration
       Extension =>  { # ONVIF::Device::Types::PTZPresetTourSpotExtension
       },
     },
     Extension =>  { # ONVIF::Device::Types::PTZPresetTourStatusExtension
     },
   },
   AutoStart =>  $some_value, # boolean
   StartingCondition =>  { # ONVIF::Device::Types::PTZPresetTourStartingCondition
     RecurringTime =>  $some_value, # int
     RecurringDuration =>  $some_value, # duration
     Direction => $some_value, # PTZPresetTourDirection
     Extension =>  { # ONVIF::Device::Types::PTZPresetTourStartingConditionExtension
     },
   },
   TourSpot =>  { # ONVIF::Device::Types::PTZPresetTourSpot
     PresetDetail =>      { # ONVIF::Device::Types::PTZPresetTourPresetDetail
       # One of the following elements.
       # No occurrence checks yet, so be sure to pass just one...
       PresetToken => $some_value, # ReferenceToken
       Home =>  $some_value, # boolean
       PTZPosition =>  { # ONVIF::Device::Types::PTZVector
         PanTilt => ,
         Zoom => ,
       },
       TypeExtension =>  { # ONVIF::Device::Types::PTZPresetTourTypeExtension
       },
     },
     Speed =>  { # ONVIF::Device::Types::PTZSpeed
       PanTilt => ,
       Zoom => ,
     },
     StayTime =>  $some_value, # duration
     Extension =>  { # ONVIF::Device::Types::PTZPresetTourSpotExtension
     },
   },
   Extension =>  { # ONVIF::Device::Types::PTZPresetTourExtension
   },
 },

attr

Attribute documentation is experimental, and may be inaccurate. See the correspondent Schema if in question.

This class has additional attributes, accessibly via the "attr()" method.

attr() returns an object of the class ONVIF::Device::Types::PresetTour::_PresetTour::XmlAttr.

The following attributes can be accessed on this object via the corresponding get_/set_ methods:

*

token

 Unique identifier of this preset tour.

This attribute is of type ONVIF::Device::Types::ReferenceToken.

AUTHOR

Generated by