ONVIF:...aStream(3pm)

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

✨ ONVIF::Analytics::Types::MetadataStream πŸ’…

okay bestie, so this is a page from the User Contributed Perl Documentation, and it's the manpage for ONVIF:...aStream(3pm) β€” that's the abbreviated name the man system shows for it, because apparently manpage headers have a character limit and decided to vibe-check us. The full class name is in NAME, scroll down. 🫢


🌸 NAME 🌸

ONVIF::Analytics::Types::MetadataStream


πŸŽ€ DESCRIPTION πŸŽ€

So basically it's a Perl data type class. It represents the XML Schema complexType MetadataStream, and that complexType lives in the namespace http://www.onvif.org/ver10/schema. That's the whole thing. It's a type wrapper. It is doing its little job and it is doing it fabulously. ✨

πŸ’– PROPERTIES πŸ’–

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

  • VideoAnalytics
  • PTZ
  • Event
  • Extension

🌈 METHODS 🌈

⭐ new

Constructor, queen. And here's the data structure you may pass to new() β€” full thing, verbatim, do not come for me about the length, every single nested key is here and it's staying here:

        { # ONVIF::Analytics::Types::MetadataStream
          # One of the following elements.
          # No occurrence checks yet, so be sure to pass just one...
          VideoAnalytics =>    { # ONVIF::Analytics::Types::VideoAnalyticsStream
            # One of the following elements.
            # No occurrence checks yet, so be sure to pass just one...
            Frame =>  { # ONVIF::Analytics::Types::Frame
              PTZStatus =>  { # ONVIF::Analytics::Types::PTZStatus
                Position =>  { # ONVIF::Analytics::Types::PTZVector
                  PanTilt => ,
                  Zoom => ,
                },
                MoveStatus =>  { # ONVIF::Analytics::Types::PTZMoveStatus
                  PanTilt => $some_value, # MoveStatus
                  Zoom => $some_value, # MoveStatus
                },
                Error =>  $some_value, # string
                UtcTime =>  $some_value, # dateTime
              },
              Transformation =>  { # ONVIF::Analytics::Types::Transformation
                Translate => ,
                Scale => ,
                Extension =>  { # ONVIF::Analytics::Types::TransformationExtension
                },
              },
              Object =>  { # ONVIF::Analytics::Types::Object
                Appearance =>  { # ONVIF::Analytics::Types::Appearance
                  Transformation =>  { # ONVIF::Analytics::Types::Transformation
                    Translate => ,
                    Scale => ,
                    Extension =>  { # ONVIF::Analytics::Types::TransformationExtension
                    },
                  },
                  Shape =>  { # ONVIF::Analytics::Types::ShapeDescriptor
                    BoundingBox => ,
                    CenterOfGravity => ,
                    Polygon =>  { # ONVIF::Analytics::Types::Polygon
                      Point => ,
                    },
                    Extension =>  { # ONVIF::Analytics::Types::ShapeDescriptorExtension
                    },
                  },
                  Color =>  { # ONVIF::Analytics::Types::ColorDescriptor
                    ColorCluster =>  {
                      Color => ,
                      Weight =>  $some_value, # float
                      Covariance => ,
                    },
                    Extension =>  { # ONVIF::Analytics::Types::ColorDescriptorExtension
                    },
                  },
                  Class =>  { # ONVIF::Analytics::Types::ClassDescriptor
                    ClassCandidate =>  {
                      Type => $some_value, # ClassType
                      Likelihood =>  $some_value, # float
                    },
                    Extension =>  { # ONVIF::Analytics::Types::ClassDescriptorExtension
                      OtherTypes =>  { # ONVIF::Analytics::Types::OtherType
                        Type =>  $some_value, # string
                        Likelihood =>  $some_value, # float
                      },
                      Extension =>  { # ONVIF::Analytics::Types::ClassDescriptorExtension2
                      },
                    },
                  },
                  Extension =>  { # ONVIF::Analytics::Types::AppearanceExtension
                  },
                },
                Behaviour =>  { # ONVIF::Analytics::Types::Behaviour
                  Removed =>  {
                  },
                  Idle =>  {
                  },
                  Extension =>  { # ONVIF::Analytics::Types::BehaviourExtension
                  },
                },
                Extension =>  { # ONVIF::Analytics::Types::ObjectExtension
                },
              },
              ObjectTree =>  { # ONVIF::Analytics::Types::ObjectTree
                Rename =>  { # ONVIF::Analytics::Types::Rename
                  from => ,
                  to => ,
                },
                Split =>  { # ONVIF::Analytics::Types::Split
                  from => ,
                  to => ,
                },
                Merge =>  { # ONVIF::Analytics::Types::Merge
                  from => ,
                  to => ,
                },
                Delete => ,
                Extension =>  { # ONVIF::Analytics::Types::ObjectTreeExtension
                },
              },
              Extension =>  { # ONVIF::Analytics::Types::FrameExtension
                MotionInCells =>  { # ONVIF::Analytics::Types::MotionInCells
                },
                Extension =>  { # ONVIF::Analytics::Types::FrameExtension2
                },
              },
            },
            Extension =>  { # ONVIF::Analytics::Types::VideoAnalyticsStreamExtension
            },
          },
          PTZ =>    { # ONVIF::Analytics::Types::PTZStream
            # One of the following elements.
            # No occurrence checks yet, so be sure to pass just one...
            PTZStatus =>  { # ONVIF::Analytics::Types::PTZStatus
              Position =>  { # ONVIF::Analytics::Types::PTZVector
                PanTilt => ,
                Zoom => ,
              },
              MoveStatus =>  { # ONVIF::Analytics::Types::PTZMoveStatus
                PanTilt => $some_value, # MoveStatus
                Zoom => $some_value, # MoveStatus
              },
              Error =>  $some_value, # string
              UtcTime =>  $some_value, # dateTime
            },
            Extension =>  { # ONVIF::Analytics::Types::PTZStreamExtension
            },
          },
          Event =>  $some_value, # anyType
          Extension =>  { # ONVIF::Analytics::Types::MetadataStreamExtension
            AudioAnalyticsStream =>  { # ONVIF::Analytics::Types::AudioAnalyticsStream
              AudioDescriptor =>  { # ONVIF::Analytics::Types::AudioDescriptor
              },
              Extension =>  { # ONVIF::Analytics::Types::AudioAnalyticsStreamExtension
              },
            },
            Extension =>  { # ONVIF::Analytics::Types::MetadataStreamExtension2
            },
          },
        },
⚠️ bestie, listen. See the comments that say "One of the following elements. No occurrence checks yet, so be sure to pass just one..."? That's not decoration, that's a genuine heads-up. There are no occurrence checks yet, so if you pass more than one, nobody's gonna stop you and nobody's gonna warn you. Be sure to pass just one. πŸ™ˆ

πŸ‘‘ AUTHOR πŸ‘‘

Generated by SOAP::WSDL


and that's the whole page, no notes, we ate. this doc shipped with perl v5.40.1 and is dated 2026-02-01 β€” so go forth, pass exactly one element, and slay. πŸ’œπŸ¦‹β­

πŸ“¦ where this page comes from