JVC VN-V686UAPI manual API Format Structure, Parameter Description

1.2.API Format Structure

GET	space	API	space	HTTP/1.1	0x0D 0x0A
Host:	space	IP Address of VN-V686	0x0D 0x0A 0x0D 0x0A

Unlike APIs for getting/setting parameters, Accept line is not required. Basic authentication is also not necessary.

Example

GET /api/video?encode=jpeg&framerate=30&boundary=on&ptz_info=off

HTTP/1.1<CRLF>

Host: 192.168.0.2<CRLF><CRLF>

Parameter value is indicated using =. Do not insert space before and after =.

Example framerate=1

Parameter Description

encode For specifying compression format. For example, specify as encode=jpeg to get JPEG.

framerate For specifying the frame rate. For example, specify as framerate=5 to get at 5 fps. Specify as framerate=- 5 to get at 1/5 fps, or in other words, 1 frame in 5 seconds. Selection range is as follows.

30, 25, 15, 10, 7.5, 6, 5, 3, 2, 1, 0, -2, -3, -5, -10, -15, -20, -30, -60

When the parameter is specified as framerate=0, VN-V686 sends 1 frame of JPEG data, and disconnect the TCP connection.

boundary To specify streaming format. Specify "on" for server push streaming. If framerate=0 is specified, there is no boundary structure even if boundary=on.

ptz_info To add pan/tilt/zoom information before JPEG data. Specify on or off. Even if ptz_info=off, pan/tilt/zoom information is stored in JPEG comment segemnt.

1.3. Response

When API is successfully received with boundary=on

VN-V686 will return 200 OK. The x-vnv686_response line indicates actual parameters.

Example

7