---
name: "ONVIF::PTZ::Types::Frame"
section: "3pm"
platform: "linux"
package: "zoneminder"
version: "1.36.35+dfsg1-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/ONVIF::PTZ::Types::Frame"
---

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

## NAME

ONVIF::PTZ::Types::Frame

## DESCRIPTION

Perl data type class for the XML Schema defined complexType Frame from the namespace http://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

NOTE: Attribute documentation is experimental, and may be inaccurate. See the correspondent WSDL/XML 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 SOAP::WSDL