setOSDEnable.lua
[INDEX]

ABSTRACT

Set overlay enabling of main/sub stream

ARGUMENTS

HTTP Arguments submit: GET; POST

Test this API over HTTP - (URL):

Stream
(MUST)

Stream:

main

Main stream

sub

Sub stream

Test value:

Enable

Optional. OSD Enabling.

If not specified this, returns current enabling status (so can get current status by this); Otherwise:

NOTED:

The 'Enable' parameter here is to control the stream's OSD is open or not, equivalent to a "master switch". Each stream can support up to 4 different independent overlay items. Each item can control to turn on or off. Refer to setOSDItem.lua.

0

Disable OSD

1

Enable OSD

Test value:

NoRotate

Optional. Specifies whether the OSD content rotates with the rotation of the video.

0

Follow video rotation

1

Do not follow the rotation

Test value:

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*/

"Enable":
INTEGER

0|1, Current OSD enabling status (0=disable, 1=enable) after executing.

"NoRotate":
INTEGER

0|1, Current rotation status after executing.

}
}

OTHER NOTES

Device HTTP API, v1.0