ONVIF::...esetTour(3)

πŸ“¦ version 1.38.6, in nixpkgs unstable

πŸ’… ONVIF::PTZ::Types::PresetTour β€” the manual, but make it make sense ✨

okay so bestie, this is the ONVIF::...esetTour(3) page from the User Contributed Perl Documentation, and honestly? it's giving "generated by a machine that has never known love" 😭 but don't worry, I'm gonna walk you through it πŸ’–


🫢 NAME 🫢

ONVIF::PTZ::Types::PresetTour β€” that's the whole name, no notes, periodt πŸ‘‘


🌸 DESCRIPTION 🌸

So this is a Perl data type class for the XML Schema defined complexType PresetTour from the namespace http://www.onvif.org/ver10/schema. That's it, that's the vibe β€” it's a little Perl wrapper around an XML Schema type, and it's lowkey just here to hold your data for you πŸŽ€

πŸ’œ PROPERTIES πŸ’œ

The following properties may be accessed using the get_PROPERTY / set_PROPERTY methods β€” yup, that's the pattern, learn it, love it:

  • Name
  • Status
  • AutoStart
  • StartingCondition
  • TourSpot
  • Extension

That's six properties, all accounted for, no cap ✨


πŸ¦‹ METHODS πŸ¦‹

🌟 new 🌟

Constructor, bestie! The following data structure may be passed to new() β€” and I'm putting it here exactly as it appears, because the details are the whole point πŸ‘‡

 { # ONVIF::PTZ::Types::PresetTour
   Name => $some_value, # Name
   Status =>  { # ONVIF::PTZ::Types::PTZPresetTourStatus
     State => $some_value, # PTZPresetTourState
     CurrentTourSpot =>  { # ONVIF::PTZ::Types::PTZPresetTourSpot
       PresetDetail =>        { # ONVIF::PTZ::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::PTZ::Types::PTZVector
           PanTilt => ,
           Zoom => ,
         },
         TypeExtension =>  { # ONVIF::PTZ::Types::PTZPresetTourTypeExtension
         },
       },
       Speed =>  { # ONVIF::PTZ::Types::PTZSpeed
         PanTilt => ,
         Zoom => ,
       },
       StayTime =>  $some_value, # duration
       Extension =>  { # ONVIF::PTZ::Types::PTZPresetTourSpotExtension
       },
     },
     Extension =>  { # ONVIF::PTZ::Types::PTZPresetTourStatusExtension
     },
   },
   AutoStart =>  $some_value, # boolean
   StartingCondition =>  { # ONVIF::PTZ::Types::PTZPresetTourStartingCondition
     RecurringTime =>  $some_value, # int
     RecurringDuration =>  $some_value, # duration
     Direction => $some_value, # PTZPresetTourDirection
     Extension =>  { # ONVIF::PTZ::Types::PTZPresetTourStartingConditionExtension
     },
   },
   TourSpot =>  { # ONVIF::PTZ::Types::PTZPresetTourSpot
     PresetDetail =>      { # ONVIF::PTZ::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::PTZ::Types::PTZVector
         PanTilt => ,
         Zoom => ,
       },
       TypeExtension =>  { # ONVIF::PTZ::Types::PTZPresetTourTypeExtension
       },
     },
     Speed =>  { # ONVIF::PTZ::Types::PTZSpeed
       PanTilt => ,
       Zoom => ,
     },
     StayTime =>  $some_value, # duration
     Extension =>  { # ONVIF::PTZ::Types::PTZPresetTourSpotExtension
     },
   },
   Extension =>  { # ONVIF::PTZ::Types::PTZPresetTourExtension
   },
 },
πŸ‘€ okay important thing though: see where it says # No occurrence checks yet, so be sure to pass just one...? That's inside PresetDetail, and it appears twice in the structure above. That means there are no occurrence checks yet, so you gotta be sure to pass just one of those elements. Don't be chaotic, bestie, the code will not stop you but it's not gonna be happy either πŸ’€

πŸŽ€ attr πŸŽ€

⚠️ NOTE: Attribute documentation is experimental, and may be inaccurate. See the correspondent WSDL/XML Schema if in question. (i.e. if you need the real truth, go read the source, this section is literally in its experimental era πŸ™ˆ)

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

attr() returns an object of the class ONVIF::PTZ::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::PTZ::Types::ReferenceToken.


πŸ‘‘ AUTHOR πŸ‘‘

Generated by SOAP::WSDL β€” that's the whole author line, it's a tool, not a person, and honestly? iconic behavior πŸ€–βœ¨


πŸŒΈπŸ’– and that's the page!! so cute, so thorough, so many nested types!! fr fr you now know everything this manpage wanted to tell you and nothing it didn't 🫢

β€” with love, your bestie who reads WSDL for fun πŸ’…

πŸŽ€ this little sign-off is the footer shoutout: source/version is perl v5.42.3 and the date on it is 1980-01-01 β€” yeah, that date is weird, but it's literally what's printed, so we're keeping it, periodt πŸ˜­πŸ’–
πŸ“¦ where this page comes from