ONVIF::...tPayload(3)

πŸ“¦ version 1.38.6, in nixpkgs unstable

🫢 ONVIF::PTZ::Types::ActionEngineEventPayload 🫢

okay bestie, so this one is a page from the User Contributed Perl Documentation (yes that's the manual name, iykyk) and the man page itself is titled ONVIF::...tPayload(3) β€” truncated like a text message that got cut off, iconic honestly. anyway let's get into it πŸ’…


✨ NAME ✨

ONVIF::PTZ::Types::ActionEngineEventPayload β€” say it three times fast, I dare you. it's a whole mouthful but she's worth it πŸŽ€


🌸 DESCRIPTION 🌸

So basically this is a Perl data type class for the XML Schema defined complexType ActionEngineEventPayload, and she comes from the namespace http://www.onvif.org/ver10/schema. periodt.

And what does an Action Engine Event Payload actually do? bestie, she's the data structure holding all the info about ONVIF command invocations πŸ‘‘ and here's the important part β€” since this event could be generated by other or proprietary actions, the command-invocation-specific fields are defined as optional, and there's an additional extension mechanism provided for future or additional action definitions. so she's flexible, she's future-proof, she's giving adaptable main character energy ✨


πŸ¦‹ PROPERTIES πŸ¦‹

these are the properties you can get at with get_PROPERTY / set_PROPERTY methods:

  • RequestInfo β€” the request side of things πŸ’Œ
  • ResponseInfo β€” the response side πŸ’¬
  • Fault β€” when things go wrong 😭
  • Extension β€” the extra credit section 🌈

πŸ’œ METHODS πŸ’œ

🌟 new 🌟

Constructor, obviously. and here's the data structure you can pass to new() β€” literally exactly this, don't come for me:

 { # ONVIF::PTZ::Types::ActionEngineEventPayload
   RequestInfo =>  { # ONVIF::PTZ::Types::Envelope
     Header =>  { # ONVIF::PTZ::Types::Header
     },
     Body =>  { # ONVIF::PTZ::Types::Body
     },
   },
   ResponseInfo =>  { # ONVIF::PTZ::Types::Envelope
     Header =>  { # ONVIF::PTZ::Types::Header
     },
     Body =>  { # ONVIF::PTZ::Types::Body
     },
   },
   Fault =>  { # ONVIF::PTZ::Types::Fault
     faultcode =>  $some_value, # QName
     faultstring =>  $some_value, # string
     faultactor =>  $some_value, # anyURI
     detail =>  { # ONVIF::PTZ::Types::detail
     },
   },
   Extension =>  { # ONVIF::PTZ::Types::ActionEngineEventPayloadExtension
   },
 },

like, look at her go β€” RequestInfo and ResponseInfo both take an Envelope (with Header and Body nesting inside, very matryoshka doll of them πŸͺ†), Fault takes a Fault with faultcode (a QName), faultstring (a string), faultactor (an anyURI) and detail, and Extension takes an ActionEngineEventPayloadExtension. slay πŸ’…


πŸ‘‘ AUTHOR πŸ‘‘

Generated by SOAP::WSDL β€” no cap, that's the whole author section, the machine did it 🧚


ngl the original footer says perl v5.42.3 with a date of 1980-01-01 β€” so yeah, version v5.42.3, dated 1980-01-01, that's the whole vibe check πŸ’€ love that for us, a timestamp from before most of us existed πŸ“

anyway that's the page bestie, go forth and invoke your actions πŸ«ΆπŸ’–

πŸ“¦ where this page comes from