ONVIF::...taStream(3)

💖 NAME 💖

okay so bestie, welcome to ONVIF::PTZ::Types::MetadataStream — yes that's a whole mouthful, we know 💅 — and this little icon lives in the User Contributed Perl Documentation section, which is giving "community-made, main character energy" fr fr.

---

✨ DESCRIPTION ✨

so basically this is a Perl data type class for the XML Schema defined complexType MetadataStream, and it comes straight out of the namespace http://www.onvif.org/ver10/schema. that's the whole vibe. it's a type class, it holds data, it slays in a very specific XML-schema way 🎀

---

🌸 PROPERTIES 🌸

these are the properties you can get at with the get_PROPERTY / set_PROPERTY methods — literally just call those and you're in:

• VideoAnalytics
• PTZ
• Event
• Extension

that's the list, no cap 🫶

---

🔥 METHODS 🔥

🦋 new

constructor bestie!! it builds the thing. and here's the data structure you may pass to new() — full thing, every nested type, every comment, we are not skimming 👑

        { # ONVIF::PTZ::Types::MetadataStream
          # One of the following elements.
          # No occurrence checks yet, so be sure to pass just one...
          VideoAnalytics =>    { # ONVIF::PTZ::Types::VideoAnalyticsStream
            # One of the following elements.
            # No occurrence checks yet, so be sure to pass just one...
            Frame =>  { # 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
                },
              },
            },
            Extension =>  { # ONVIF::PTZ::Types::VideoAnalyticsStreamExtension
            },
          },
          PTZ =>    { # ONVIF::PTZ::Types::PTZStream
            # One of the following elements.
            # No occurrence checks yet, so be sure to pass just one...
            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
            },
            Extension =>  { # ONVIF::PTZ::Types::PTZStreamExtension
            },
          },
          Event =>  $some_value, # anyType
          Extension =>  { # ONVIF::PTZ::Types::MetadataStreamExtension
            AudioAnalyticsStream =>  { # ONVIF::PTZ::Types::AudioAnalyticsStream
              AudioDescriptor =>  { # ONVIF::PTZ::Types::AudioDescriptor
              },
              Extension =>  { # ONVIF::PTZ::Types::AudioAnalyticsStreamExtension
              },
            },
            Extension =>  { # ONVIF::PTZ::Types::MetadataStreamExtension2
            },
          },
        },

okay important bestie: see those comments saying "One of the following elements. No occurrence checks yet, so be sure to pass just one..."? that's literally in the structure, and it means what it says — no occurrence checks yet, so be sure to pass just one 😭 don't be out here passing multiple and acting surprised.

---

🧚 AUTHOR 🧚

Generated by SOAP::WSDL — that's the whole author situation, it was generated, we respect the generator 💜

---

aaaand that's the page!! this was ONVIF::...taStream(3), documented under perl v5.42.3, dated the extremely iconic 1980-01-01 🌈 stay hydrated, pass exactly one element, and go get that MetadataStream 🍓✨