ONVIF:...:Frame(3pm)

πŸ“¦
version 1.36.37 Β· 5 versions
, in ubuntu resolute, ubuntu stonking

πŸ’– NAME πŸ’–

ONVIF::Media::Types::Frame β€” like, that's the whole name bestie, it's a Perl thing from the ONVIF:...:Frame(3pm) corner of the user-contributed Perl documentation universe ✨


🌸 DESCRIPTION 🌸

Okay so. This is a Perl data type class for the XML Schema defined complexType called Frame, and it comes straight outta the namespace http://www.onvif.org/ver10/schema. That's it, that's the vibe. It's a type class. It holds Frame data. Slay πŸ’…

✨ PROPERTIES ✨

These are the properties you can reach, and you get to them with the get_PROPERTY / set_PROPERTY methods. No cap, that's the whole access pattern:

  • PTZStatus
  • Transformation
  • Object
  • ObjectTree
  • Extension

πŸ› οΈ METHODS πŸ› οΈ

new

Constructor, bestie. The way this works is you hand it a data structure, and here's literally the shape it wants 🫢:

 { # ONVIF::Media::Types::Frame
   PTZStatus =>  { # ONVIF::Media::Types::PTZStatus
     Position =>  { # ONVIF::Media::Types::PTZVector
       PanTilt => ,
       Zoom => ,
     },
     MoveStatus =>  { # ONVIF::Media::Types::PTZMoveStatus
       PanTilt => $some_value, # MoveStatus
       Zoom => $some_value, # MoveStatus
     },
     Error =>  $some_value, # string
     UtcTime =>  $some_value, # dateTime
   },
   Transformation =>  { # ONVIF::Media::Types::Transformation
     Translate => ,
     Scale => ,
     Extension =>  { # ONVIF::Media::Types::TransformationExtension
     },
   },
   Object =>  { # ONVIF::Media::Types::Object
     Appearance =>  { # ONVIF::Media::Types::Appearance
       Transformation =>  { # ONVIF::Media::Types::Transformation
         Translate => ,
         Scale => ,
         Extension =>  { # ONVIF::Media::Types::TransformationExtension
         },
       },
       Shape =>  { # ONVIF::Media::Types::ShapeDescriptor
         BoundingBox => ,
         CenterOfGravity => ,
         Polygon =>  { # ONVIF::Media::Types::Polygon
           Point => ,
         },
         Extension =>  { # ONVIF::Media::Types::ShapeDescriptorExtension
         },
       },
       Color =>  { # ONVIF::Media::Types::ColorDescriptor
         ColorCluster =>  {
           Color => ,
           Weight =>  $some_value, # float
           Covariance => ,
         },
         Extension =>  { # ONVIF::Media::Types::ColorDescriptorExtension
         },
       },
       Class =>  { # ONVIF::Media::Types::ClassDescriptor
         ClassCandidate =>  {
           Type => $some_value, # ClassType
           Likelihood =>  $some_value, # float
         },
         Extension =>  { # ONVIF::Media::Types::ClassDescriptorExtension
           OtherTypes =>  { # ONVIF::Media::Types::OtherType
             Type =>  $some_value, # string
             Likelihood =>  $some_value, # float
           },
           Extension =>  { # ONVIF::Media::Types::ClassDescriptorExtension2
           },
         },
       },
       Extension =>  { # ONVIF::Media::Types::AppearanceExtension
       },
     },
     Behaviour =>  { # ONVIF::Media::Types::Behaviour
       Removed =>  {
       },
       Idle =>  {
       },
       Extension =>  { # ONVIF::Media::Types::BehaviourExtension
       },
     },
     Extension =>  { # ONVIF::Media::Types::ObjectExtension
     },
   },
   ObjectTree =>  { # ONVIF::Media::Types::ObjectTree
     Rename =>  { # ONVIF::Media::Types::Rename
       from => ,
       to => ,
     },
     Split =>  { # ONVIF::Media::Types::Split
       from => ,
       to => ,
     },
     Merge =>  { # ONVIF::Media::Types::Merge
       from => ,
       to => ,
     },
     Delete => ,
     Extension =>  { # ONVIF::Media::Types::ObjectTreeExtension
     },
   },
   Extension =>  { # ONVIF::Media::Types::FrameExtension
     MotionInCells =>  { # ONVIF::Media::Types::MotionInCells
     },
     Extension =>  { # ONVIF::Media::Types::FrameExtension2
     },
   },
 },

Like, it's giving nested hash refs, and every comment tells you which type is lurking in there. Iconic honestly.

attr

⚠️ NOTE: Attribute documentation is experimental, and may be inaccurate. See the correspondent WSDL/XML Schema if in question. (Translation: don't come for me if it's off, go check the source fr fr 😭)

So this class has additional attributes, and you get at them via the attr() method.

attr() hands you back an object of the class ONVIF::Media::Types::Frame::_Frame::XmlAttr. Very long name, very main-character.

On that object, these attributes are accessible through the corresponding get_/set_ methods:

  • UtcTime

This attribute is of type SOAP::WSDL::XSD::Typelib::Builtin::dateTime. πŸ’œ


πŸ‘‘ AUTHOR πŸ‘‘

Generated by SOAP::WSDL. That's the whole author line, bestie. The machine did it. πŸ€–βœ¨


And that's the tea πŸ“ β€” this page came to you from perl <code>v5.40.1</code>, dated <code>2026-02-01</code>, in the ONVIF:...:Frame(3pm) era. Go forth and build your Frame, you absolute icon πŸŽ€πŸ’–

πŸ“¦ where this page comes from