ONVIF::PTZ::Types::Frame (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/ONVIF::PTZ::Types::Frame.3pm".)

NAME

ONVIF::PTZ::Types::Frame

DESCRIPTION

Perl data type class for the Schema defined complexType Frame from the namespace www.onvif.org/ver10/schema

PROPERTIES

The following properties may be accessed using get_PROPERTY / set_PROPERTY methods:

*

PTZStatus

*

Transformation

*

Object

*

ObjectTree

*

Extension

METHODS

new

Constructor. The following data structure may be passed to new():

 { # 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
     },
   },
 },

attr

Attribute documentation is experimental, and may be inaccurate. See the correspondent Schema if in question.

This class has additional attributes, accessibly via the "attr()" method.

attr() returns an object of the class ONVIF::PTZ::Types::Frame::_Frame::XmlAttr.

The following attributes can be accessed on this object via the corresponding get_/set_ methods:

*

UtcTime

This attribute is of type SOAP::WSDL::XSD::Typelib::Builtin::dateTime.

AUTHOR

Generated by