ONVIF::...Options(3)

🌸 ONVIF::...Options(3) 🌸

okay bestie, so this page lives in the User Contributed Perl Documentation section of the man pages (iykyk, the (3) means it's a library/perl module page), and the file itself is literally called ONVIF::...Options(3). The actual module we're talking about? ONVIF::Device::Types::OSDTextOptions. Yes the abbreviation in the filename is doing a lot of heavy lifting. Slay.

---

✨ NAME ✨

ONVIF::Device::Types::OSDTextOptions — literally just that, that's the name, that's the whole vibe.

---

💖 DESCRIPTION 💖

So this one is a Perl data type class, right? It's the class for the XML Schema defined complexType called OSDTextOptions, and that type comes from the namespace http://www.onvif.org/ver10/schema. That's the whole description. Short. Iconic. No notes. 💅

🎀 PROPERTIES

These are the properties you can get at with the get_PROPERTY / set_PROPERTY methods. The way that get_ and set_ are right there in the name, so you already know the assignment:

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

seven of them, that's the whole list, no cap 🫶

---

🦋 METHODS 🦋

🌈 new

Constructor, bestie. Like every constructor ever. And here's the data structure you may pass to new() — and I do mean may, this is the shape it's expecting:

{ # ONVIF::Device::Types::OSDTextOptions
  Type =>  $some_value, # string
  FontSizeRange =>  { # ONVIF::Device::Types::IntRange
    Min =>  $some_value, # int
    Max =>  $some_value, # int
  },
  DateFormat =>  $some_value, # string
  TimeFormat =>  $some_value, # string
  FontColor =>  { # ONVIF::Device::Types::OSDColorOptions
    Color =>      { # ONVIF::Device::Types::ColorOptions
      # One of the following elements.
      # No occurrence checks yet, so be sure to pass just one...
      ColorList => ,
      ColorspaceRange =>  { # ONVIF::Device::Types::ColorspaceRange
        X =>  { # ONVIF::Device::Types::FloatRange
          Min =>  $some_value, # float
          Max =>  $some_value, # float
        },
        Y =>  { # ONVIF::Device::Types::FloatRange
          Min =>  $some_value, # float
          Max =>  $some_value, # float
        },
        Z =>  { # ONVIF::Device::Types::FloatRange
          Min =>  $some_value, # float
          Max =>  $some_value, # float
        },
        Colorspace =>  $some_value, # anyURI
      },
    },
    Transparent =>  { # ONVIF::Device::Types::IntRange
      Min =>  $some_value, # int
      Max =>  $some_value, # int
    },
    Extension =>  { # ONVIF::Device::Types::OSDColorOptionsExtension
    },
  },
  BackgroundColor =>  { # ONVIF::Device::Types::OSDColorOptions
    Color =>      { # ONVIF::Device::Types::ColorOptions
      # One of the following elements.
      # No occurrence checks yet, so be sure to pass just one...
      ColorList => ,
      ColorspaceRange =>  { # ONVIF::Device::Types::ColorspaceRange
        X =>  { # ONVIF::Device::Types::FloatRange
          Min =>  $some_value, # float
          Max =>  $some_value, # float
        },
        Y =>  { # ONVIF::Device::Types::FloatRange
          Min =>  $some_value, # float
          Max =>  $some_value, # float
        },
        Z =>  { # ONVIF::Device::Types::FloatRange
          Min =>  $some_value, # float
          Max =>  $some_value, # float
        },
        Colorspace =>  $some_value, # anyURI
      },
    },
    Transparent =>  { # ONVIF::Device::Types::IntRange
      Min =>  $some_value, # int
      Max =>  $some_value, # int
    },
    Extension =>  { # ONVIF::Device::Types::OSDColorOptionsExtension
    },
  },
  Extension =>  { # ONVIF::Device::Types::OSDTextOptionsExtension
  },
},

⚠️ okay lowkey important, bestie — see that # One of the following elements. with # No occurrence checks yet, so be sure to pass just one...? That's the manpage telling you it does not check how many occurrences you pass. So ColorList and ColorspaceRange are an either/or situation, and you gotta pass just one of them yourself, because nothing is stopping you from messing that up. Be the main character who reads the comments. 😭

---

👑 AUTHOR 👑

Generated by SOAP::WSDL. That's it, that's the author line. A generator did this. Respect to the machine fr fr 🫡

---

💖 and that's the page, bestie — this is perl v5.42.3, dated 1980-01-01, from the User Contributed Perl Documentation. yes, 1980, we love a timeless queen 🎀✨💜