ONVIF:...:Frame(3pm)

💖 ONVIF::...:Frame — the glow-up edition 💖

okay bestie, so this is ONVIF:...:Frame, and it lives in section 3pm of the manual (yes, that's the "perl user-contributed" section, iykyk). It's one of those User Contributed Perl Documentation pages. Sit down, grab a strawberry 🍓, we're doing XML schema things.

---

✨ NAME ✨

ONVIF::PTZ::Types::Frame — that's the whole name, that's the whole vibe. 👑

---

🌸 DESCRIPTION 🌸

It's a Perl data type class, periodt. Specifically it's for the XML Schema defined complexType Frame, and that type comes from the namespace http://www.onvif.org/ver10/schema. That's it, that's the description, no notes. 💅

---

🎀 PROPERTIES 🎀

These are the properties you can get at with the get_PROPERTY / set_PROPERTY methods. Slay.

• PTZStatus
• Transformation
• Object
• ObjectTree
• Extension

---

🦋 METHODS 🦋

⭐ new ⭐

It's the constructor, bestie. The following data structure may be passed to new():

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

like… look at that nesting. it's giving ✨structural engineering✨. that's your whole constructor right there, no cap. 🔥

---

👑 attr 👑

NOTE: Attribute documentation is experimental, and may be inaccurate. See the correspondent WSDL/XML Schema if in question.

🚨 bestie, read that again — experimental, may be inaccurate. If something looks sus, go check the actual WSDL/XML Schema. Don't come for me, I'm just the messenger. 🙈

So this class has additional attributes, and you reach them through the attr() method. Very demure, very mindful.

attr() hands you back an object of the class ONVIF::PTZ::Types::Frame::_Frame::XmlAttr. Yes that's the real name. Yes there are a lot of colons. We love her. 💅

On that object, you can access the following attributes via the matching get_ / set_ methods:

• UtcTime — this attribute is of type SOAP::WSDL::XSD::Typelib::Builtin::dateTime.

and that's the whole attribute list. one (1) attribute. she's lowkey iconic for that. 🌈

---

💜 AUTHOR 💜

Generated by SOAP::WSDL — it wrote itself, honestly. main character energy from a code generator, we stan. 🫶

---

okay and for the cute sign-off bestie: this page is from perl v5.40.1, dated 2026-02-01, filed under User Contributed Perl Documentation, and it's the ONVIF:...:Frame page in section 3pm. now go forth and set some properties, you absolute legend 💖✨🎀🦋🌸💅