ONVIF::...Options(3)

πŸ“¦ version 1.38.6, in nixpkgs unstable

πŸ’– ONVIF::...Options(3) πŸ’–

okay so bestie, we're looking at the ONVIF::...Options(3) page today β€” a Perl manpage, yes, but lowkey a whole vibe ✨. It's a User Contributed Perl Documentation situation, and the actual class you're here for is ONVIF::Device::Types::ImagingOptions, so let's get into it πŸ’…


πŸŽ€ NAME πŸŽ€

ONVIF::Device::Types::ImagingOptions β€” that's the whole name, no cap. That's literally the star of the show 🌟


πŸ¦‹ DESCRIPTION πŸ¦‹

So. This is a Perl data type class for the XML Schema–defined complexType ImagingOptions, and it lives in the namespace http://www.onvif.org/ver10/schema. That's the whole description fr fr β€” it's giving "I'm just a little type class, I contain multitudes" 🫢

🌸 PROPERTIES 🌸

These are the properties you can get at, and the way you touch them is with get_PROPERTY / set_PROPERTY methods β€” that's the whole access pattern, iykyk. Here's the full list, no skips, no "etc." energy πŸ‘‘

  • BacklightCompensation
  • Brightness
  • ColorSaturation
  • Contrast
  • Exposure
  • Focus
  • IrCutFilterModes
  • Sharpness
  • WideDynamicRange
  • WhiteBalance

That's all ten of them, periodt πŸ’œ


✨ METHODS ✨

πŸ’« new

Constructor time, bestie πŸŽ€. The following data structure may be passed to new(). Copy it exactly, don't get creative with it, the nesting is the moment:

 { # ONVIF::Device::Types::ImagingOptions
   BacklightCompensation =>  { # ONVIF::Device::Types::BacklightCompensationOptions
     Mode => $some_value, # WideDynamicMode
     Level =>  { # ONVIF::Device::Types::FloatRange
       Min =>  $some_value, # float
       Max =>  $some_value, # float
     },
   },
   Brightness =>  { # ONVIF::Device::Types::FloatRange
     Min =>  $some_value, # float
     Max =>  $some_value, # float
   },
   ColorSaturation =>  { # ONVIF::Device::Types::FloatRange
     Min =>  $some_value, # float
     Max =>  $some_value, # float
   },
   Contrast =>  { # ONVIF::Device::Types::FloatRange
     Min =>  $some_value, # float
     Max =>  $some_value, # float
   },
   Exposure =>  { # ONVIF::Device::Types::ExposureOptions
     Mode => $some_value, # ExposureMode
     Priority => $some_value, # ExposurePriority
     MinExposureTime =>  { # ONVIF::Device::Types::FloatRange
       Min =>  $some_value, # float
       Max =>  $some_value, # float
     },
     MaxExposureTime =>  { # ONVIF::Device::Types::FloatRange
       Min =>  $some_value, # float
       Max =>  $some_value, # float
     },
     MinGain =>  { # ONVIF::Device::Types::FloatRange
       Min =>  $some_value, # float
       Max =>  $some_value, # float
     },
     MaxGain =>  { # ONVIF::Device::Types::FloatRange
       Min =>  $some_value, # float
       Max =>  $some_value, # float
     },
     MinIris =>  { # ONVIF::Device::Types::FloatRange
       Min =>  $some_value, # float
       Max =>  $some_value, # float
     },
     MaxIris =>  { # ONVIF::Device::Types::FloatRange
       Min =>  $some_value, # float
       Max =>  $some_value, # float
     },
     ExposureTime =>  { # ONVIF::Device::Types::FloatRange
       Min =>  $some_value, # float
       Max =>  $some_value, # float
     },
     Gain =>  { # ONVIF::Device::Types::FloatRange
       Min =>  $some_value, # float
       Max =>  $some_value, # float
     },
     Iris =>  { # ONVIF::Device::Types::FloatRange
       Min =>  $some_value, # float
       Max =>  $some_value, # float
     },
   },
   Focus =>  { # ONVIF::Device::Types::FocusOptions
     AutoFocusModes => $some_value, # AutoFocusMode
     DefaultSpeed =>  { # ONVIF::Device::Types::FloatRange
       Min =>  $some_value, # float
       Max =>  $some_value, # float
     },
     NearLimit =>  { # ONVIF::Device::Types::FloatRange
       Min =>  $some_value, # float
       Max =>  $some_value, # float
     },
     FarLimit =>  { # ONVIF::Device::Types::FloatRange
       Min =>  $some_value, # float
       Max =>  $some_value, # float
     },
   },
   IrCutFilterModes => $some_value, # IrCutFilterMode
   Sharpness =>  { # ONVIF::Device::Types::FloatRange
     Min =>  $some_value, # float
     Max =>  $some_value, # float
   },
   WideDynamicRange =>  { # ONVIF::Device::Types::WideDynamicRangeOptions
     Mode => $some_value, # WideDynamicMode
     Level =>  { # ONVIF::Device::Types::FloatRange
       Min =>  $some_value, # float
       Max =>  $some_value, # float
     },
   },
   WhiteBalance =>  { # ONVIF::Device::Types::WhiteBalanceOptions
     Mode => $some_value, # WhiteBalanceMode
     YrGain =>  { # ONVIF::Device::Types::FloatRange
       Min =>  $some_value, # float
       Max =>  $some_value, # float
     },
     YbGain =>  { # ONVIF::Device::Types::FloatRange
       Min =>  $some_value, # float
       Max =>  $some_value, # float
     },
   },
 },

quick vibe check on that structure: BacklightCompensation is a BacklightCompensationOptions with a Mode (a WideDynamicMode) and a Level (FloatRange), Brightness / ColorSaturation / Contrast / Sharpness are all straight-up FloatRange (just Min and Max, both float), Exposure is an ExposureOptions with Mode (ExposureMode), Priority (ExposurePriority) and a whole little family of FloatRanges β€” MinExposureTime, MaxExposureTime, MinGain, MaxGain, MinIris, MaxIris, ExposureTime, Gain, Iris β€” and Focus is a FocusOptions with AutoFocusModes (AutoFocusMode) plus DefaultSpeed, NearLimit and FarLimit (FloatRange each) 🌈. Then IrCutFilterModes is a plain IrCutFilterMode, WideDynamicRange is a WideDynamicRangeOptions (Mode = WideDynamicMode, Level = FloatRange), and WhiteBalance is a WhiteBalanceOptions with Mode (WhiteBalanceMode), YrGain and YbGain (FloatRange each). Every Min and Max in sight is a float and every leaf value is $some_value. That's the whole shape of it πŸ’…


πŸ‘‘ AUTHOR πŸ‘‘

Generated by SOAP::WSDL. That's the author, bestie β€” the machine wrote it, we just vibe with it πŸ€–πŸ’–


okay that's the page, hope it slayed for you πŸŽ€ sign-off time: this one's perl v5.42.3, dated 1980-01-01 (yes, literally 1980, iconic timestamp behavior 😭), and it closed out as ONVIF::...Options(3). bye bestie, go write some XML πŸ¦‹βœ¨

πŸ“¦ where this page comes from