ONVIF:...Options(3pm)

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

πŸ’– ONVIF::Analytics::Types::OSDTextOptions πŸ’–

okay bestie, so this is a page from the User Contributed Perl Documentation, manual section 3pm, and it's literally all about ONVIF::Analytics::Types::OSDTextOptions. come sit with me 🫢


🌸 NAME 🌸

ONVIF::Analytics::Types::OSDTextOptions β€” that's the whole name, no notes, she's just her πŸ’…


✨ DESCRIPTION ✨

So basically: this is a Perl data type class for the XML Schema defined complexType OSDTextOptions, and that complexType lives in the namespace http://www.onvif.org/ver10/schema. it's giving "auto-generated glue code that just wants to hold your XML data for you" and honestly? relatable. 😌

πŸŽ€ PROPERTIES πŸŽ€

These are the properties you can get to, and you reach them with the get_PROPERTY / set_PROPERTY methods (yes, that naming convention, periodt):

  • Type
  • FontSizeRange
  • DateFormat
  • TimeFormat
  • FontColor
  • BackgroundColor
  • Extension

seven of them, count 'em, we don't skip a single one πŸ’–


πŸ”₯ METHODS πŸ”₯

πŸ¦‹ new πŸ¦‹

Constructor, bestie. the main character. and here's the data structure you're allowed to pass to new() β€” look at her go, she's nested:

{ # ONVIF::Analytics::Types::OSDTextOptions
  Type =>  $some_value, # string
  FontSizeRange =>  { # ONVIF::Analytics::Types::IntRange
    Min =>  $some_value, # int
    Max =>  $some_value, # int
  },
  DateFormat =>  $some_value, # string
  TimeFormat =>  $some_value, # string
  FontColor =>  { # ONVIF::Analytics::Types::OSDColorOptions
    Color =>      { # ONVIF::Analytics::Types::ColorOptions
      # One of the following elements.
      # No occurrence checks yet, so be sure to pass just one...
      ColorList => ,
      ColorspaceRange =>  { # ONVIF::Analytics::Types::ColorspaceRange
        X =>  { # ONVIF::Analytics::Types::FloatRange
          Min =>  $some_value, # float
          Max =>  $some_value, # float
        },
        Y =>  { # ONVIF::Analytics::Types::FloatRange
          Min =>  $some_value, # float
          Max =>  $some_value, # float
        },
        Z =>  { # ONVIF::Analytics::Types::FloatRange
          Min =>  $some_value, # float
          Max =>  $some_value, # float
        },
        Colorspace =>  $some_value, # anyURI
      },
    },
    Transparent =>  { # ONVIF::Analytics::Types::IntRange
      Min =>  $some_value, # int
      Max =>  $some_value, # int
    },
    Extension =>  { # ONVIF::Analytics::Types::OSDColorOptionsExtension
    },
  },
  BackgroundColor =>  { # ONVIF::Analytics::Types::OSDColorOptions
    Color =>      { # ONVIF::Analytics::Types::ColorOptions
      # One of the following elements.
      # No occurrence checks yet, so be sure to pass just one...
      ColorList => ,
      ColorspaceRange =>  { # ONVIF::Analytics::Types::ColorspaceRange
        X =>  { # ONVIF::Analytics::Types::FloatRange
          Min =>  $some_value, # float
          Max =>  $some_value, # float
        },
        Y =>  { # ONVIF::Analytics::Types::FloatRange
          Min =>  $some_value, # float
          Max =>  $some_value, # float
        },
        Z =>  { # ONVIF::Analytics::Types::FloatRange
          Min =>  $some_value, # float
          Max =>  $some_value, # float
        },
        Colorspace =>  $some_value, # anyURI
      },
    },
    Transparent =>  { # ONVIF::Analytics::Types::IntRange
      Min =>  $some_value, # int
      Max =>  $some_value, # int
    },
    Extension =>  { # ONVIF::Analytics::Types::OSDColorOptionsExtension
    },
  },
  Extension =>  { # ONVIF::Analytics::Types::OSDTextOptionsExtension
  },
},
⚠️ okay listen, this is the important part: inside Color it literally says "One of the following elements. No occurrence checks yet, so be sure to pass just one..." β€” so ColorList and ColorspaceRange are an either/or, and nothing is stopping you from passing both. there's no validation gatekeeping you. the code is NOT checking. so be a good bestie and pass just one, okay? πŸ™ˆ

also peep that FontColor and BackgroundColor are the same shape β€” ONVIF::Analytics::Types::OSDColorOptions twice β€” and inside each one the Color is an ONVIF::Analytics::Types::ColorOptions, and inside that the ColorspaceRange is an ONVIF::Analytics::Types::ColorspaceRange with X, Y, Z all ONVIF::Analytics::Types::FloatRange (floats, bestie, Min and Max) plus a Colorspace that's an anyURI. and then Transparent is an ONVIF::Analytics::Types::IntRange (ints this time, Min and Max) and Extension is an ONVIF::Analytics::Types::OSDColorOptionsExtension. it's layers on layers, like an onion but make it XML 🌈

and the top-level Type, DateFormat and TimeFormat? just strings. simple. iconic. ✨


πŸ‘‘ AUTHOR πŸ‘‘

Generated by SOAP::WSDL β€” yeah, no human wrote this one, the machine did, and honestly she ate πŸ’…


and that's the whole page, bestie!! this was pulled from perl v5.40.1, dated 2026-02-01, and it's page ONVIF:...Options(3pm) from the User Contributed Perl Documentation. love u, go pass exactly one color element πŸ«ΆπŸ’–βœ¨

πŸ“¦ where this page comes from