ONVIF::...setTour(3)

πŸ“¦ version 1.38.6, in nixpkgs unstable

πŸ’– NAME

okay so this page is ONVIF::...setTour(3) from the User Contributed Perl Documentation, and the actual class it's about is ONVIF::Device::Types::PresetTour β€” that's the name, bestie, no cap. πŸ’…

🌸 DESCRIPTION

It's a Perl data type class for the XML Schema defined complexType PresetTour from the namespace http://www.onvif.org/ver10/schema β€” literally what it says on the tin. πŸ¦‹

✨ 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

NOTE: Attribute documentation is experimental, and may be inaccurate. See the correspondent WSDL/XML 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 SOAP::WSDL β€” slay. πŸ’–

mwah πŸ’‹ bestie, that's the whole page β€” it's from perl v5.42.3, dated 1980-01-01, and the manual is ONVIF::...setTour(3). 🫢✨

πŸ“¦ where this page comes from