getSourceCrop.lua
[INDEX]

ABSTRACT

Get the (preprocessor) source video cropping parameters

If the encoder has an image preprocessor, it can crop special area of the source video pictures. Because of this feature, youcan get partial video and zoom it to your wanted size (Refer setSourceScale.lua), like a digital P(an)/T(ilt)/Z(oom).

NOTE: Not all encoders support this feature, but only the models with the image preprocessor.

ARGUMENTS

HTTP Arguments submit: POST

Test this API over HTTP - (URL):

NONE

RETURNS

Return a JSON style result. The JSON format is:

{
/*OBJECT*/

"Result":
NUMBER

200 means OK, other error code meanings are similar to HTTP Response.

"Status":
"STRING"

Status message. Responsing result status of API executive, if there errors, it will describe reasons.

"Data": {
/*OBJECT*/

Source cropping status:

"Enable":
INTEGER

0|1. 0 is turned off cropping and 1 is turned on.

"Left":
NUMBER

The cropping place starts from left (by pixels) if 'Enable'=1

"Top":
NUMBER

The cropping place starts from top (by Line) if 'Enable'=1

"Width":
NUMBER

The cropping width (by pixels) if 'Enable'=1

"Height":
NUMBER

The cropping height (by Line) if 'Enable'=1

}
}

OTHER NOTES

Device HTTP API, v1.0