Image source rotation

Description

Image source rotation is a feature employed to improve performance in hardware. The rotation is set to be handled when the dataflow is already in the sensor, making all streams derived from the source being rotated in the same way.

Historically, Axis products received a native stream with a default rotation value where each video source were able to have their own user-defined rotation value. This means that if the native rotation was 0 degrees internally, the outgoing video stream could show up at either 90 or 180 degrees instead, but only as long as they had been appropriately configured. This does not hold true for newer products with auto-rotation, as they use global parameters to control the rotation of the image source. Thus, depending on what has been globally set, the video source and video stream will both have a defined rotation value, making it impossible to request a video stream with a certain rotation value when it differs from the global configuration value.

Note

This API is not a stand alone API but an addendum to the param.cgi found here: Parameter management.

The API consists of the following parameters:

Parameter	Valid values	Description
`ImageSource.I#.SourceRotation`	`yes` `no`	Allows the client to determine whether or not a given product has image source rotation. This parameter is read-only.
`Properties.Image.Rotation`	`[0, 90, 180, 270]`	The rotation of the source.
`ImageSource.I#.AutoRotationEnabled`	`yes` `no`	In products with `AutoRotation` it is possible to activate it by setting `ImageSource.I#.AutoRotationEnabled` to ‘`yes`’. `AutoRotationEnabled` can be disabled by setting `Rotation`.

Identification

Property: ImageSource.I#.SourceRotation=yes
Firmware: 8.40 and later

Common examples

Image source rotation

Use this example to determine if a stream or a source should be rotated.

Query

Check if Image source rotation is present in the device by querying ImageSource.I#.SourceRotation. If the value is yes and a rotation value is set, Image source rotation is present.

For more information, see API specification.

Request

http://<srv>/axis-cgi/param.cgi?action=list&group=ImageSource.I0

Return value - Success:

HTTP code: 200 OK
Content-type: text/plain

Response body syntax

...
root.ImageSource.I0.SourceRotation=yes
root.ImageSource.I0.Rotation=180
...

Return value:

HTTP code: 200 OK
Content-type: text/plain

Response body syntax

Neither ImageSource.I0SourceRotation nor Rotation in body.

Update

Set ImageSource.I#.Rotation to a desired rotation angle from the set as defined by Properties.Image.Rotation, e.g [0,90,180,270].
If ImageSource.I#.Rotation is changed all open streams will close, and must be reacquires in a new stream request.

Request

http://<srv>/axis-cgi/param.cgi?action=update&ImageSource.I0.Rotation=0

Return value - Success:

HTTP code: 200 OK
Content-type: text/plain

Response body syntax

OK

Return value - Not present:

HTTP code: 200 OK
Content-type: text/plain

Response body syntax

# Error: Error setting 'ImageSource.I#.Rotation' to 'nnn'!

Auto rotation

Use this example to operate Image source rotation together with Auto rotation and restart all streams after changing the orientation.

Query

After checking the status of Image source rotation in the previous example, you can now check if Auto rotation is present and if it has been enabled.

Query the value of ImageSource.I#.AutoRotationEnabled, and if the returned value is yes, Auto rotation is enabled.

Request

http://<srv>/axis-cgi/param.cgi?action=list&group=ImageSource.I0

Return value - Success:

HTTP code: 200 OK
Content-type: text/plain

Response body syntax

...
root.ImageSource.I0.AutoRotationEnabled=yes
...

Return value - Error:

HTTP code: 200 OK
Content-type: text/plain

Response body syntax:

No AutoRotationEnabled in body.

Update

Set ImageSource.I#.AutoRotationEnabled to yes to enable AutoRotationEnabled and no to disable it.
If ImageSource.I#.Rotation is changed through the API ImageSource.I#.AutoRotationEnabled will be turned off.

Request:

http://<srv>/axis-cgi/param.cgi?action=update&ImageSource.I0.AutoRotationEnabled=yes

Return value - Success:

HTTP code: 200 OK
Content-type: text/plain

Response body syntax

OK

Return value - Error:

HTTP code: 200 OK
Content-type: text/plain

Response body syntax

# Error: Error setting 'ImageSource.I#.AutoRotationEnabled' to 'nnn'!

API specification

List security level: Viewer
Update security level: Operator or N/A
Method: GET

ImageSource.I#

ImageSource.I#.<parameter>

Valid values for # ranges from 0 to the number of image sources in the system -1.

Parameter	Description
`SourceRotation=yes\|no`	Read-only parameter specifying whether the device has image source rotation or not.
`Rotation=0\|90\|180\|270`	A read/write parameter from a set of integers as defined in `Properties.Image.Rotation`, typically {0, 90, 180, 270}. Default value is 0.
`AutoRotationEnabled=yes\|no`	Specifying whether the device rotation is set, depending on it’s orientation or whether it is set by the user.