Stitching

Description

The Stitching API documentation introduces you to the steps that lets you set the blending amount and parallax compensation distance in order to reach optimized alignment in a panoramic video stream. By using this API you will also be able to align the sensor images in a panoramic view in the event that one or several sensors have been moved from their original position.

Model

The API implements stitching.cgi as its communications interface and supports the following methods:

Method	Description
`getSupportedVersions`	Retrieves API versions supported by your device.
`getCapabilities`	Retrieves stitching capabilities available on your device.
`getBlendingAmount`	Retrieves the current blending amount.
`setBlendingAmount`	Sets the blending amount.
`getParallaxCompensationDistance`	Retrieves the current distance to an object.
`setParallaxCompensationDistance`	Sets the distance to an object (in meters).
`rotateAngle`	Rotates a sensor ID.
`restore`	Restores a sensor ID to the factory default setting, i.e. removes all changes made with: `setBlendingAmount` `setParallaxCompensationDistance` `rotateAngle`

Identification

API Discovery: id=stitching

Use cases

Retrieve supported API versions and capabilities

Use these examples to retrieve a list of API versions and information about what parts of the stitching.cgi are supported by your device.

Retrieve supported API versions

1. Request a list containing the API versions supported by your device.

http://<servername>/axis-cgi/stitching.cgi

JSON input parameters

{
  "context": "abc",
  "method": "getSupportedVersions"
}

2. Parse the JSON response.

Successful response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "getSupportedVersions",
  "data": {
    "apiVersions": [
      "1.0",
      "2.1",
      "3.0"
    ]
  }
}

Error response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "getSupportedVersions",
  "error": {
    "code": 8000,
    "message": "Internal error, could not complete request."
  }
}

API references

getSupportedVersions

Retrieve supported capabilities

1. Request a list containing supported stitching.cgi capabilities.

http://<servername>/axis-cgi/stitching.cgi

JSON input parameters

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "getCapabilities"
}

2. Parse the JSON response, which should include a list containing the supported methods.

Successful response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "getCapabilities",
  "data": {
    "capabilities": {
      "getBlendingAmount": true,
      "setBlendingAmount": true,
      "getParallaxCompensationDistance": true,
      "setParallaxCompensationDistance": true,
      "rotateAngle": true,
      "restore": true
    }
    "limits": {
      "blendingAmountMin": 0.0,
      "blendingAmountMax": 100.0,
      "parallaxCompensationDistanceMin": 1.0,
      "parallaxCompensationDistanceMax": 50.0,
      "idMin": 0,
      "idMax": 3,
      "angleMin": -180,
      "angleMax": 180
    }
  }
}

Error response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "getCapabilities",
  "error": {
    "code": 2003,
    "message": "The requested API version is not supported."
  }
}

API references

getCapabilities

Change blending amount

Use these examples to change the blending amount, which makes seams between sensor images appear sharper or blurrier.

Retrieve blending amount

1. Request the current value of the blending amount.

http://<servername>/axis-cgi/stitching.cgi

JSON input parameters

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "getBlendingAmount"
}

2. Parse the JSON response, which should include the current value of the blending amount.

Successful response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "getBlendingAmount",
  "data": {
    "blendingAmount": 50.0
  }
}

Error response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "getBlendingAmount",
  "error": {
    "code": 2004,
    "message": "Method not supported."
  }
}

API references

getBlendingAmount

Set blending amount

1. Set a new blending amount value.

http://<servername>/axis-cgi/stitching.cgi

JSON input parameters

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "setBlendingAmount"
  "params": {
    "blendingAmount": 75.0
  }
}

2. Parse the JSON response.

Successful response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "setBlendingAmount",
  "data": {}
}

Error response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "setBlendingAmount",
  "error": {
    "code": 2004,
    "message": "Method not supported."
  }
}

API references

setBlendingAmount

Change parallax compensation distance

Use these examples to change the parallax compensation distance so that the most important object is aligned around the seams.

Retrieve parallax compensation distance

1. Request the current value of the parallax compensation distance.

http://<servername>/axis-cgi/stitching.cgi

JSON input parameters

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "getParallaxCompensationDistance"
}

2. Parse the JSON response.

Successful response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "getParallaxCompensationDistance",
  "data": {
    "parallaxCompensationDistance": 10.0
  }
}

Error response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "getParallaxCompensationDistance",
  "error": {
    "code": 2004,
    "message": "Method not supported."
  }
}

API references

getParallaxCompensationDistance

Set parallax compensation distance

1. Set the new value for the parallax compensation distance.

http://<servername>/axis-cgi/stitching.cgi

JSON input parameters

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "setParallaxCompensationDistance"
  "params": {
    "parallaxCompensationDistance": 20.0
  }
}

2. Parse the JSON response.

Successful response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "setParallaxCompensationDistance",
  "data": {}
}

Error response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "setParallaxCompensationDistance",
  "error": {
    "code": 2004,
    "message": "Method not supported."
  }
}

API references

setParallaxCompensationDistance

Align the sensor images in a panoramic view

Use these examples to align the sensor images in a panoramic view in the event that they have become unaligned.

Pan the sensor

1. Pan sensor 2 by 0.05 degrees.

http://<servername>/axis-cgi/stitching.cgi

JSON input parameters

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "rotateAngle"
  "params": {
    "id": 2,
    "axis": "pan",
    "angle": 0.05
  }
}

2. Parse the JSON response.

Successful response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "rotateAngle",
  "data": {}
}

Error response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "rotateAngle",
  "error": {
    "code": 1000,
    "message": "Invalid parameter value."
  }
}

Tilt the sensor

1. Tilt sensor 0 by 0.15 degrees.

http://<servername>/axis-cgi/stitching.cgi

JSON input parameters

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "rotateAngle"
  "params": {
    "id": 0,
    "axis": "tilt",
    "angle": 0.15
  }
}

2. Parse the JSON response.

Successful response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "rotateAngle",
  "data": {}
}

Error response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "rotateAngle",
  "error": {
    "code": 1000,
    "message": "Invalid parameter value."
  }
}

Roll the sensor

1. Roll sensor 3 by -0.2 degrees.

http://<servername>/axis-cgi/stitching.cgi

JSON input parameters

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "rotateAngle"
  "params": {
    "id": 3,
    "axis": "roll",
    "angle": -0.2
  }
}

2. Parse the JSON response.

Successful response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "rotateAngle",
  "data": {}
}

Error response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "rotateAngle",
  "error": {
    "code": 4001,
    "message": "Mandatory input parameter was not found in the input."
  }
}

API references

rotateAngle

Restore settings back to factory default

Use this example to restore the device settings to factory default. This is useful when you have made changes to either the blending amount, parallax compensation distance or alignment in the previous examples and want to return to the original settings.

1. Undo the current actions on sensor 0 with the restore method. This will restore the configuration back to factory default.

http://<servername>/axis-cgi/stitching.cgi

JSON input parameters

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "restore"
  "params": {
    "id": 0,
  }
}

2. Parse the JSON response.

Successful response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "restore",
  "data": {}
}

Error response example

{
  "apiVersion": "3.0",
  "context": "abc",
  "method": "restore",
  "error": {
    "code": 1000,
    "message": "Invalid parameter value."
  }
}

API references

restore

API specifications

getSupportedVersions

This method is used when you want to retrieve a list of API versions supported by your device. The list will consist of the major API versions along with their highest supported minor version. Please note that the version is for the API as a whole, i.e. all methods supported by stitching.cgi.

Request

Security level: Admin
Method: POST
Content-Type: application/json

http://<servername>/axis-cgi/stitching.cgi

{
  "context": <string>,
  "method": "getSupportedVersions"
}

Parameter	Description
`context=<string>`	The context set by the user and echoed in the response (optional).
`method=<"getSupportedVersions">`	The requested method.

Return value - Success

HTTP Code: 200 OK
Content-Type: application/json

Response body syntax

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "getSupportedVersions",
  "data": {
    "apiVersions": [
      <string>,
      <string>
    ]
  }
}

Parameter	Description
`apiVersion=<string>`	The API version returned from the request.
`context=<string>`	The context set by the user in the request (optional).
`method="getSupportedVersions"`	The requested method.
`data=<JSON object>`	Container for the response specific parameter listed below.
`apiVersions=<array>`	The supported API versions in the format "Major.Minor", i.e. `1.4` or `2.1`.

Return value - Failure

HTTP Code: 200 OK
Content-Type: application/json

Response body syntax

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "getSupportedVersions",
  "error": {
    "code": <number>,
    "message": <string>
  }
}

Parameter	Description
`apiVersion=<string>`	The API version returned from the request.
`context=<string>`	The context set by the user in the request (optional).
`method=<"getSupportedVersions">`	The requested method.
`error.code=<integer error code>`	The error code.
`error.message=<string>`	The error message for the corresponding error code.

Error codes

See General error codes for a complete list of potential errors.

getCapabilities

This method is used when you want to retrieve a list of stitching.cgi methods supported on your device.

Request

Security level: Admin
Method: POST
Content-Type: application/json

http://<servername>/axis-cgi/stitching.cgi

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "getCapabilities"
}

Parameter	Description
`apiVersion=<string>`	The API version that should be used.
`context=<string>`	The context set by the user and echoed in the response (optional).
`method=<"getCapabilities">`	The requested method.

Return value - Success

HTTP Code: 200 OK
Content-Type: application/json

Response body syntax

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "getCapabilities",
  "data": {
    "capabilities": {
      "getBlendingAmount": <boolean>,
      "setBlendingAmount": <boolean>,
      "getParallaxCompensationDistance": <boolean>,
      "setParallaxCompensationDistance": <boolean>,
      "rotateAngle": true,
      "restore": true
    },
    "limits": {
      "blendingAmountMin": <number>,
      "blendingAmountMax": <number>,
      "parallaxCompensationDistanceMin": <number>,
      "parallaxCompensationDistanceMax": <number>,
      "idMin": <number>,
      "idMax": <number>,
      "angleMin": <number>,
      "angleMax": <number>
    }
  }
}

Parameter	Description
`apiVersion=<string>`	The API version returned from the request.
`context=<string>`	The context set by the user in the request (optional).
`method="getCapabilities"`	The requested method.
`data=<JSON object>`	Container for the response specific parameters listed below.
`capabilities=<JSON object>`	Container for the method support responses.
`getBlendingAmount=<boolean>`	Value can be either `true` or `false` depending on if the method is supported.
`setBlendingAmount=<boolean>`	Value can be either `true` or `false` depending on if the method is supported.
`getParallaxCompensationDistance=<boolean>`	Value can be either `true` or `false` depending on if the method is supported.
`setParallaxCompensationDistance=<boolean>`	Value can be either `true` or `false` depending on if the method is supported.
`rotateAngle=<boolean>`	Value can be either `true` or `false` depending on if the method is supported.
`restore=<boolean>`	Value can be either `true` or `false` depending on if the method is supported.
`limits=<JSON object>`	Container for the limits responses.
`blendingAmountMin=<number>`	The minimum blending amount value used for `setBlendingAmount`.
`blendingAmountMax=<number>`	The maximum blending amount value used for `setBlendingAmount`.
`parallaxCompensationDistanceMin=<number>`	The minimum parallax compensation distance value used for `setParallaxCompensationDistance`.
`parallaxCompensationDistanceMax=<number>`	The maximum parallax compensation distance value used for `setParallaxCompensationDistance`.
`idMin=<number>`	The minimum id value used for `rotateAngle` and `restore`.
`idMax=<number>`	The maximum id value used for `rotateAngle` and `restore`.
`angleMin=<number>`	The minimum angle value used for `rotateAngle` .
`angleMax=<number>`	The maximum angle value used for `rotateAngle` .

Return value - Failure

HTTP Code: 200 OK
Content-Type: application/json

Response body syntax

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "getCapabilities",
  "error": {
    "code": <number>,
    "message": <string>
  }
}

Parameter	Description
`apiVersion=<string>`	The API version returned from the request.
`context=<string>`	The context set by the user in the request (optional).
`method=<"getCapabilities">`	The requested method.
`error.code=<integer error code>`	The error code.
`error.message=<string>`	The error message for the corresponding error code.

Error codes

See General error codes for a complete list of potential errors.

getBlendingAmount

This method is used when you want to return the current blending amount value.

Request

Security level: Admin
Method: POST
Content-Type: application/json

http://<servername>/axis-cgi/stitching.cgi

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "getBlendingAmount"
}

Parameter	Description
`apiVersion=<string>`	The API version that should be used.
`context=<string>`	The context set by the user and echoed in the response (optional).
`method=<"getBlendingAmount">`	The requested method.

Return value - Success

HTTP Code: 200 OK
Content-Type: application/json

Response body syntax

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "getBlendingAmount",
  "data": {
    "blendingAmount": <number>
  }
}

Parameter	Description
`apiVersion=<string>`	The API version returned from the request.
`context=<string>`	The context set by the user in the request (optional).
`method="getBlendingAmount"`	The requested method.
`data=<JSON object>`	Container for the response specific parameters listed below.
`blendingAmount=<number>`	The returned value that specifies the current amount of blurriness around the image seams.

Return value - Failure

HTTP Code: 200 OK
Content-Type: application/json

Response body syntax

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "getBlendingAmount",
  "error": {
    "code": <number>,
    "message": <string>
  }
}

Parameter	Description
`apiVersion=<string>`	The API version returned from the request.
`context=<string>`	The context set by the user in the request (optional).
`method=<"getBlendingAmount">`	The requested method.
`error.code=<integer error code>`	The error code.
`error.message=<string>`	The error message for the corresponding error code.

Error codes

See General error codes for a complete list of potential errors.

setBlendingAmount

This method is used when you want to set a new blending amount value. Changing this value is useful when there are differences in the white balance between sensors.

It is generally a good idea to set the blending amount to 0 when there is only one object at the same distance as the parallax compensation distance around the seams. This will add a sharp transition between seams, however, in cases where there are many different objects at different distances around the seams it is usually better to increase the blending amount. Doing this will blur our any skewered alignments that might occur around the seams.

Request

Security level: Admin
Method: POST
Content-Type: application/json

http://<servername>/axis-cgi/stitching.cgi

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "setBlendingAmount"
  "params": {
    "blendingAmount": <number>
  }
}

Parameter	Description
`apiVersion=<string>`	The API version that should be used.
`context=<string>`	The context set by the user and echoed in the response (optional).
`method=<"setBlendingAmount">`	The requested method.
`params=<JSON object>`	Container for method specific parameters.
`blendingAmount=<number>`	Specifies the new value with a range between 0–100. The value can be entered as a `<number>` and when using decimals only the 15 first are used. `0` = sharp edges with no blurriness. `100` = maximum blurriness.

Return value - Success

HTTP Code: 200 OK
Content-Type: application/json

Response body syntax

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "setBlendingAmount",
  "data": {}
}

Parameter	Description
`apiVersion=<string>`	The API version returned from the request.
`context=<string>`	The context set by the user in the request (optional).
`method="setBlendingAmount"`	The requested method.
`data=<JSON object>`	Container for the response.

Return value - Failure

HTTP Code: 200 OK
Content-Type: application/json

Response body syntax

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "setBlendingAmount",
  "error": {
    "code": <number>,
    "message": <string>
  }
}

Parameter	Description
`apiVersion=<string>`	The API version returned from the request.
`context=<string>`	The context set by the user in the request (optional).
`method=<"setBlendingAmount">`	The requested method.
`error.code=<integer error code>`	The error code.
`error.message=<string>`	The error message for the corresponding error code.

Error codes

Code	Description
`2204`	Failed to apply blending.
`2214`	Blending is disabled.

See General error codes for a complete list of potential errors.

getParallaxCompensationDistance

This method is used when you want to retrieve the value for the parallax compensation distance.

Request

Security level: Admin
Method: POST
Content-Type: application/json

http://<servername>/axis-cgi/stitching.cgi

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "getParallaxCompensationDistance"
}

Parameter	Description
`apiVersion=<string>`	The API version that should be used.
`context=<string>`	The context set by the user and echoed in the response (optional).
`method=<"getParallaxCompensationDistance">`	The requested method.

Return value - Success

HTTP Code: 200 OK
Content-Type: application/json

Response body syntax

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "getParallaxCompensationDistance",
  "data": {
    "parallaxComensationDistance": <number>
  }
}

Parameter	Description
`apiVersion=<string>`	The API version returned from the request.
`context=<string>`	The context set by the user in the request (optional).
`method="getParallaxCompensationDistance"`	The requested method.
`data=<JSON object>`	Container for the response specific parameter listed below.
`parallaxCompensationDistance=<number>`	The returned value where the alignment is currently being calculated, measured in meters.

Return value - Failure

HTTP Code: 200 OK
Content-Type: application/json

Response body syntax

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "getParallaxCompensationDistance",
  "error": {
    "code": <number>,
    "message": <string>
  }
}

Parameter	Description
`apiVersion=<string>`	The API version returned from the request.
`context=<string>`	The context set by the user in the request (optional).
`method=<"getParallaxCompensationDistance">`	The requested method.
`error.code=<integer error code>`	The error code.
`error.message=<string>`	The error message for the corresponding error code.

Error codes

See General error codes for a complete list of potential errors.

setParallaxCompensationDistance

This method is used when you want to set a new value for the parallax compensation distance.

Request

Security level: Admin
Method: POST
Content-Type: application/json

http://<servername>/axis-cgi/stitching.cgi

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "setParallaxCompensationDistance"
  "params": {
    "parallaxCompensationDistance": <number>
  }
}

Parameter	Description
`apiVersion=<string>`	The API version that should be used.
`context=<string>`	The context set by the user and echoed in the response (optional).
`method=<"setParallaxCompensationDistance">`	The requested method.
`params=<JSON object>`	Container for the method specific parameter below.
`parallaxCompensationDistance=<number>`	Specifies the distance to the objects in meters. The distance is where the alignment between the seams will be calculated with a value between 1–50 entered as a `<number>`. Please note that only the first 15 decimals can be used.

Return value - Success

HTTP Code: 200 OK
Content-Type: application/json

Response body syntax

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "setParallaxCompensationDistance",
  "data": {}
}

Parameter	Description
`apiVersion=<string>`	The API version returned from the request.
`context=<string>`	The context set by the user in the request (optional).
`method="setParallaxCompensationDistance"`	The requested method.
`data=<JSON object>`	Container for the response.

Return value - Failure

HTTP Code: 200 OK
Content-Type: application/json

Response body syntax

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "setParallaxCompensationDistance",
  "error": {
    "code": <number>,
    "message": <string>
  }
}

Parameter	Description
`apiVersion=<string>`	The API version returned from the request.
`context=<string>`	The context set by the user in the request (optional).
`method=<"setParallaxCompensationDistance">`	The requested method.
`error.code=<integer error code>`	The error code.
`error.message=<string>`	The error message for the corresponding error code.

Error codes

See General error codes for a complete list of potential errors.

rotateAngle

This method is used when you want to align the sensor images in the panoramic view to improve the stitching effect.

Each sensor can rotate on the "pan", "tilt" and "roll" axis. The hard limits of the angles can’t exceed -180 to +180 degrees, but there are lower soft limits that are product and sensor dependent. AXIS Q3819–PVE for example, has a soft limit of ± 1.4 degrees when using pan. Exceeding these limits can cause unknown behavior in the image.

Request

Security level: Admin
Method: POST
Content-Type: application/json

http://<servername>/axis-cgi/stitching.cgi

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "rotateAngle"
  "params": {
    "id": <number>,
    "axis": <string>,
    "angle": <number>
  }
}

Parameter	Description
`apiVersion=<string>`	The API version that should be used.
`context=<string>`	The context set by the user and echoed in the response (optional).
`method=<"rotateAngle">`	The requested method.
`params=<JSON object>`	Container for the method specific parameter below.
`id=<number>`	Specifies what sensor image that should be rotated. Valid range is 0 to the number of sensors minus 1.
`axis=<string>`	Specifies which axis that should be rotated. Valid values are "pan", "tilt" and "roll".
`angle=<number>`	Specifies how many degrees the axis should be rotated for a chosen sensor id. The value can be entered as <number> with valid values between -180 to +180. Please note that if you are using decimals, only the first 15 are used.

Return value - Success

HTTP Code: 200 OK
Content-Type: application/json

Response body syntax

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "rotateAngle",
  "data": {}
}

Parameter	Description
`apiVersion=<string>`	The API version returned from the request.
`context=<string>`	The context set by the user in the request (optional).
`method="rotateAngle"`	The requested method.
`data=<JSON object>`	Container for the response.

Return value - Failure

HTTP Code: 200 OK
Content-Type: application/json

Response body syntax

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "rotateAngle",
  "error": {
    "code": <number>,
    "message": <string>
  }
}

Parameter	Description
`apiVersion=<string>`	The API version returned from the request.
`context=<string>`	The context set by the user in the request (optional).
`method=<"rotateAngle">`	The requested method.
`error.code=<integer error code>`	The error code.
`error.message=<string>`	The error message for the corresponding error code.

Error codes

See General error codes for a complete list of potential errors.

restore

This method is used when you want to reset the alignment, parallax compensation distance or blending amount to the unit specific default settings.

Request

Security level: Admin
Method: POST
Content-Type: application/json

http://<servername>/axis-cgi/stitching.cgi

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "restore"
  "params": {
    "id": <number>,
  }
}

Parameter	Description
`apiVersion=<string>`	The API version that should be used.
`context=<string>`	The context set by the user and echoed in the response (optional).
`method=<"restore">`	The requested method.
`params=<JSON object>`	Container for the method specific parameter below.
`id=<number>`	Specifies what sensor image that should be restored. Valid range is 0 to the number of sensors minus 1.

Return value - Success

HTTP Code: 200 OK
Content-Type: application/json

Response body syntax

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "restore",
  "data": {}
}

Parameter	Description
`apiVersion=<string>`	The API version returned from the request.
`context=<string>`	The context set by the user in the request (optional).
`method="restore"`	The requested method.
`data=<JSON object>`	Container for the response.

Return value - Failure

HTTP Code: 200 OK
Content-Type: application/json

Response body syntax

{
  "apiVersion": <string>,
  "context": <string>,
  "method": "restore",
  "error": {
    "code": <number>,
    "message": <string>
  }
}

Parameter	Description
`apiVersion=<string>`	The API version returned from the request.
`context=<string>`	The context set by the user in the request (optional).
`method=<"restore">`	The requested method.
`error.code=<integer error code>`	The error code.
`error.message=<string>`	The error message for the corresponding error code.

Error codes

See General error codes for a complete list of potential errors.

General error codes

This table lists the errors that can occur for all CGI methods. Method specific errors are listed under their respective API specification.

Code	Description
`1000`	Invalid parameter value.
`2000`	Failed to allocate memory.
`2200`	Unknown error has occurred.
`2201`	Failed to init transformation tables.
`2202`	Failed to generate table with given parameters.
`2203`	Failed to apply table with given parameters.
`2205`	Failed read calibration file.
`2206`	Calibration file is missing.
`2207`	Failed to unlink calibration file.
`2208`	Unsupported stitching mode.
`2209`	Failed to read configuration file.
`2210`	Failed to save configuration file.
`2211`	Failed to parse configuration file.
`2212`	Method is not allowed in disabled mode.
`2213`	Operation is not supported.
`4001`	Mandatory input parameters was not found in the input.
`4002`	The type of a provided JSON parameter was incorrect.
`8000`	Internal error, could not complete request.
`8002`	Generic error.

Description​

Model​

Identification​

Use cases​

Retrieve supported API versions and capabilities​

Retrieve supported API versions​

Retrieve supported capabilities​

Change blending amount​

Retrieve blending amount​

Set blending amount​

Change parallax compensation distance​

Retrieve parallax compensation distance​

Set parallax compensation distance​

Align the sensor images in a panoramic view​

Restore settings back to factory default​

API specifications​

getSupportedVersions​

getCapabilities​

getBlendingAmount​

setBlendingAmount​

getParallaxCompensationDistance​

setParallaxCompensationDistance​

rotateAngle​

restore​

General error codes​

Description

Model

Identification

Use cases

Retrieve supported API versions and capabilities

Retrieve supported API versions

Retrieve supported capabilities

Change blending amount

Retrieve blending amount

Set blending amount

Change parallax compensation distance

Retrieve parallax compensation distance

Set parallax compensation distance

Align the sensor images in a panoramic view

Restore settings back to factory default

API specifications

getSupportedVersions

getCapabilities

getBlendingAmount

setBlendingAmount

getParallaxCompensationDistance

setParallaxCompensationDistance

rotateAngle

restore

General error codes