End User Licenses Agreement (EULA)

Orientation API

Description

VAPIX® Orientation API is used to retrieve information about the camera lens orientation. The API is available in products with built-in orientation devices such as gyroscopes and accelerometers.

Supported functionality:

  • Get the longitudinal angle.

  • Get the lateral angle.

Longitudinal angle. The longitudinal angle (0 to 359 degrees) is the lens’ rotation around its longitudinal axis.

Lateral angle. The lateral angle (0 to 180 degrees) is the angle between the lens’ longitudinal axis and a line perpendicular to the ground surface. 0 degrees represents a lens pointing straight downwards. 180 degrees represents a lens pointing straight upwards.

Identification

VAPIX® Orientation API is available if:

Property

Properties.Orientation.Reporting=yes

Common examples

Retrieve supported XML schema versions.

Request:
http://<servername>/axis-cgi/orientation/getschemaversions.cgi
Response:
HTTP/1.0 200 OK
Content-Type: text/xml
 
<?xml version="1.0" encoding="utf-8"?>
<OrientationResponse xmlns="http://www.axis.com/vapix/http_cgi/orientation1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.axis.com/vapix/http_cgi/orientation1 http://www.axis.com/vapix/http_cgi/orientation1" SchemaVersion="1.0">
  <Success>
    <GetSchemaVersionsSuccess>
      <SchemaVersion>
        <VersionNumber>1.0</VersionNumber>
        <Deprecated>false</Deprecated>
      </SchemaVersion>
    </GetSchemaVersionsSuccess>
  </Success>
</OrientationResponse>

Get the longitudinal angle.

Request:
http://<servername>/axis-cgi/orientation/getlongitudinalvalue.cgi?schemaversion=1
Response:
HTTP/1.0 200 OK
Content-Type: text/xml
 
<?xml version="1.0" encoding="utf-8"?>
<OrientationResponse xmlns="http://www.axis.com/vapix/http_cgi/orientation1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.axis.com/vapix/http_cgi/orientation1 http://www.axis.com/vapix/http_cgi/orientation1" SchemaVersion="1.0">
  <Success>
    <GetLongitudinalValueSuccess>
      <LongitudinalValue>
        <Value>180</Value>
      </LongitudinalValue>
    </GetLongitudinalValueSuccess>
  </Success>
</OrientationResponse>

Get the lateral angle.

Request:
http://<servername>/axis-cgi/orientation/getlateralvalue.cgi?schemaversion=1
Response:
HTTP/1.0 200 OK
Content-Type: text/xml
 
<?xml version="1.0" encoding="utf-8"?>
<OrientationResponse xmlns="http://www.axis.com/vapix/http_cgi/orientation1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.axis.com/vapix/http_cgi/orientation1 http://www.axis.com/vapix/http_cgi/orientation1" SchemaVersion="1.0">
  <Success>
    <GetLateralValueSuccess>
      <LateralValue>
        <Value>72</Value>
      </LateralValue>
    </GetLateralValueSuccess>
  </Success>
</OrientationResponse>

Get schema versions

Use orientation/getschemaversions.cgi to retrieve the supported XML schema versions.

Request

Access control

admin, operator

Method

GET

Syntax:
http://<servername>/axis-cgi/orientation/getschemaversions.cgi

This CGI has no arguments

Response

Responses from orientation/getschemaversions.cgi

Success

A successful request returns the supported schema version.

HTTP code

200 OK

Content-type

text/xml

Body:
<?xml version="1.0" encoding="utf-8"?>
<OrientationResponse xmlns="http://www.axis.com/vapix/http_cgi/orientation1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.axis.com/vapix/http_cgi/orientation1 http://www.axis.com/vapix/http_cgi/orientation1" SchemaVersion="1.0">
  <Success>
    <GetSchemaVersionsSuccess>
      <SchemaVersion>
        <VersionNumber>[major.minor]</VersionNumber>
        <Deprecated>[true/false]</Deprecated>
      </SchemaVersion>
      [...]
    </GetSchemaVersionsSuccess>
  </Success>
</OrientationResponse>

Supported elements, attributes and values:

ElementDescription
OrientationResponseContains the response. For information about XML schema versions, see XML schemas.
SuccessSuccessful request.
GetSchemaVersionsSuccessSuccessful response from getschemaversions.cgi.
SchemaVersionContains one schema version.
VersionNumber

Schema version. See XML schemas.

Deprecated

If true, this version of the XML Schema is deprecated and should not be used.

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40

Get longitudinal angle

Use orientation/getlongitudinalvalue.cgi to retrieve the longitudinal angle.

Request

Access control

admin, operator

Method

GET

Syntax:
http://<servername>/axis-cgi/orientation/getlongitudinalvalue.cgi?<argument>=<value>

with the following arguments and values:

ArgumentValid valuesDescription
schemaversion=<integer>Integer

Required. The major version of the XML Schema to use for the response. See XML schemas.

Response

Responses from orientation/getlongitudinalvalue.cgi

Success

A successful request returns the lateral angle.

HTTP code

200 OK

Content-type

text/xml

Body:
<?xml version="1.0" encoding="utf-8"?>
<OrientationResponse xmlns="http://www.axis.com/vapix/http_cgi/orientation1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.axis.com/vapix/http_cgi/orientation1 http://www.axis.com/vapix/http_cgi/orientation1" SchemaVersion="1.0">
  <Success>
    <GetLongitudinalValueSuccess>
      <LongitudinalValue>
        <Value>[angle]</Value>
      </LongitudinalValue>
    </GetLongitudinalValueSuccess>
  </Success>
</OrientationResponse>

Supported elements, attributes and values:

ElementDescription
OrientationResponseContains the response. For information about XML schema versions, see XML schemas.
SuccessSuccessful request.
GetLongitudinalValueSuccessSuccessful response from getlongitudinalvalue.cgi.
LongitudinalValueContains the longitudinal angle.
ValueThe angle in degrees.

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40

Get lateral angle

Use orientation/getlateralvalue.cgi to retrieve the lateral angle.

Request

Access control

admin, operator

Method

GET

Syntax:
http://<servername>/axis-cgi/orientation/getlateralvalue.cgi?<argument>=<value>

with the following arguments and values:

ArgumentValid valuesDescription
schemaversion=<integer>Integer

Required. The major version of the XML Schema to use for the response. See XML schemas.

Response

Responses from orientation/getlateralvalue.cgi

Success

A successful request returns the lateral angle.

HTTP code

200 OK

Content-type

text/xml

Body:
<?xml version="1.0" encoding="utf-8"?>
<OrientationResponse xmlns="http://www.axis.com/vapix/http_cgi/orientation1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.axis.com/vapix/http_cgi/orientation1 http://www.axis.com/vapix/http_cgi/orientation1" SchemaVersion="1.0">
  <Success>
    <GetLateralValueSuccess>
      <LateralValue>
        <Value>[angle]</Value>
      </LateralValue>
    </GetLateralValueSuccess>
  </Success>
</OrientationResponse>

Supported elements, attributes and values:

ElementDescription
OrientationResponseContains the response. For information about XML schema versions, see XML schemas.
SuccessSuccessful request.
GetLateralValueSuccessSuccessful response from getlateralvalue.cgi.
LateralValueContains the lateral angle.
ValueThe angle in degrees.

Error

If an error occurred, a GeneralError response is returned. See General error response.

Error codes: 10, 20, 40

General error response

General error response in the orientation API.

HTTP code

200 OK

Content-type

text/xml

Body:
<?xml version="1.0" encoding="utf-8"?>
<OrientationResponse xmlns="http://www.axis.com/vapix/http_cgi/orientation1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.axis.com/vapix/http_cgi/orientation1 http://www.axis.com/vapix/http_cgi/orientation1" SchemaVersion="1.0">
  <Error>
    <GeneralError>
      <ErrorCode>[error code]</ErrorCode>
      <ErrorDescription>[description]</ErrorDescription>
    </GeneralError>
  </Error>
</OrientationResponse>

Supported elements, attributes and values:

ElementDescription
OrientationResponseContains the response. For information about XML schema versions, see XML schemas.
ErrorThe request contains errors.
GeneralErrorGeneral error.
ErrorCodeA numeric error code. See table below.
ErrorDescriptionDescription of the error.
Error codeDescriptionCGI
10Error while processing the request.All
20Invalid request.All
40 Specified version is not supported.All
Optics Control
Overlay API
Cookie settings
 • 
My Axis
 • 
Developer community
 • 
About

©2008 - 2024 Axis Communications AB. AXIS COMMUNICATIONS, AXIS, ARTPEC and VAPIX are registered trademarks of Axis AB in various jurisdictions. All other trademarks are the property of their respective owners. We reserve the right to introduce modifications without notice.