GY-HM660RE - Camcorder JVC - Free user manual and instructions

Find the device manual for free GY-HM660RE JVC in PDF.

📄 125 pages

EN ⬇ Download 💬 AI Question ❓ 10 questions ⚙️ Specs

Pick your language and provide your email: we'll send you a specifically translated version.

This manual is not available in your language

Desired language Your email address

Product Type	Professional Camcorder
Brand	JVC
Model	GY-HM660RE
Sensor Type	1/2.8-inch CMOS
Total Pixels	Approx. 2.38 Megapixels
Optical Zoom	20x
Digital Zoom	50x (max.)
Focal Length	f=4.1 to 82 mm (35mm conversion: 29 to 580 mm)
Aperture	F1.6 to F3.0
Recording Media	SD/SDHC/SDXC memory card (dual slots)
Video Format	MPEG-2, AVCHD, and H.264
Resolution	Up to 1920x1080 (Full HD)
Frame Rates	60i, 60p, 30p, 24p
Image Stabilization	Optical image stabilization
LCD Monitor	3.5-inch color LCD (approx. 920K dots)
Viewfinder	0.45-inch color OLED (approx. 1.22M dots)
Dimensions (W x H x D)	170 x 165 x 270 mm (without protrusions)
Weight	Approx. 1.6 kg (without lens hood and battery)
Power Supply	DC 12V (AC adapter) or rechargeable battery pack (BN-VF823)
Power Consumption	Approx. 9.2 W (with viewfinder)
Operating Temperature	0°C to 40°C (32°F to 104°F)
Key Features	High-sensitivity low-noise imaging, time code (LTC/VITC), dual codec recording, streaming capability (optional)
Maintenance & Cleaning	Use a soft, dry cloth to clean the body; use a blower or lens cleaning kit for optics
Safety Precautions	Avoid exposure to rain or moisture; do not disassemble; use only specified accessories
Spare Parts & Repairability	Contact JVC authorized service centers for genuine parts and repairs

Frequently Asked Questions - GY-HM660RE JVC

How do I reset the GY-HM660RE to factory settings?

Go to Menu > System > Reset, then select Factory Reset. Confirm to restore default settings.

What memory cards are compatible with the JVC GY-HM660RE?

It supports SD, SDHC, and SDXC memory cards. For high bitrate recording, use Class 10 or UHS-I cards.

Can I record in low light conditions?

Yes, the camera features a high-sensitivity CMOS sensor and low-noise processing. You can also enable gain (up to +18 dB) in the menu.

How do I connect the camcorder to an external monitor?

Use the HDMI output port (Type A) or the 3G-SDI output port. Set the output format in Menu > Output Settings.

How do I transfer files to a computer?

Remove the SD card and use a card reader, or connect the camcorder via USB 2.0 (Micro-B) and set it to PC mode in the menu.

What is the maximum recording time on a single battery?

With the supplied BN-VF823 battery, recording time is approximately 2 hours in normal use. Using an external battery pack can extend this.

How do I update the firmware?

Download the latest firmware from JVC's website, copy it to an SD card, insert into the camcorder, and go to Menu > System > Firmware Update.

Can I use this camcorder for live streaming?

Yes, with the optional KA-EN660G streaming module, you can stream over IP. The camera also supports SRT and RTMP protocols.

What lens filter size does the GY-HM660RE use?

The lens has a 72mm filter thread. Use standard 72mm filters for ND, polarizers, etc.

How do I clean the sensor?

It is not recommended to clean the sensor yourself. Use a professional cleaning service or a blower for loose dust. Do not touch the sensor surface.

User questions about GY-HM660RE JVC

0 question about this device. Answer the ones you know or ask your own.

Ask a new question about this device

No questions yet. Be the first to ask one.

Download the instructions for your Camcorder in PDF format for free! Find your manual GY-HM660RE - JVC and take your electronic device back in hand. On this page are published all the documents necessary for the use of your device. GY-HM660RE by JVC.

USER MANUAL GY-HM660RE JVC

JVC Camcorder Web API Reference

Version 1.17

JVC KENWOOD Corporation

Use of this document is permitted only if you agree to the following terms.

JVCKENWOOD CORPORATION SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. JVCKENWOOD CORPORATION HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

THIS DOCUMENT DESCRIBES APPLICATION PROGRAMMING INTERFACE TO CONTROL JVC CAMERA RECORDERS VIA NETWORK, AND IT SHALL NOT BE USED FOR ANY OTHER PURPOSE.

Version	Outline
1.00 First release
1.01 Added	GY-HM660 to the command table
	Added "3.1.15 Set streaming server settings(RTP)" command only GY-HM660.
	Added PcrJitter parameter in "3.1.18 Get streaming server settings" and "3.1.19 Set streaming server settings(UDP)" commands.
1.02	Added "3.1.14 Set streaming server settings(RTP)" command for all cameras
	Type "TCP" is effective in "GY-HM650" and "GY-HM660" in command with a streaming type parameter.
	Added "Variable Gain" parameter to "3.3.1 Get Camera Status" and "3.3.6 Set Web Event" for "GY-LS300".
1.03	Type "TCP" is effective in "GY-HM650" in command with a streaming type parameter.
1.03	Type "UDPN" and "UDPL" are effective in "GY-HM660" in command with a streaming type parameter.
1.04 Supported KY-PZ100 newly.
		Added "3.1.3 Set streaming framerate" command for "KY-PZ100".
		Added "3.1.6 Available streaming framerate settings" command for "KY-PZ100".
		Added "3.4. PTZ Camera Support Command" for "KY-PZ100"
		Added "3.5. How to acquire JPEG data" for "KY-PZ100".
1.05	Added "3.1.3 Set streaming framerate" command for "GY-HM200", "GY-LS300", "GY-HM8x0", and "GY-HM660".
	Added "3.1.6 Available streaming framerate settings" command for "GY-HM200", "GY-LS300", "GY-HM8x0", and "GY-HM660".
	Added "3.5. How to acquire JPEG data" for "GY-HM200", "GY-LS300", "GY-HM8x0", and "GY-HM660".
	Added "3.6. How to use interruptible feedback function" for "GY-HM660".
1.06 Error correction. 2.1.1.
		Another client is able to connect while first client is using API interface.
		3.2.2 SessionRenewal command has become obsolete.
		Added "3.6. How to use interruptible feedback function" for "GY-HM8x0".
		Type "UDPN" and "UDPL" are effective in "GY-HM8x0" in command with a streaming type parameter of "3.1.7 Available streaming bitrate settings" command.
1.07 Error correction. "3.1.10 Get streaming server settings".
		Revised wrong parameters. They are effective to all models.
		Error correction. "3.3.6. Set Web Button Event".
		Some parameters are not supported on "KY-PZ100".
		Added "MasterBlack" parameters to "3.3.1 Get Camera Status" and "3.3.6 Set Web Event" for "GY-HM8x0", "GY-HM660", and "GY-HM200".
		Added "Detail" parameters to "3.3.1 Get Camera Status" and "3.3.6 Set Web Event" for "GY-HM8x0", "GY-HM660", and "GY-HM200".
		Added "3.4.3 Zoom switch operation" command for "GY-HM8x0", "GY-HM660", and "GY-HM200".
		Added "3.3.10 Seesaw switch operation" command for "GY-HM8x0", "GY-HM660", and "GY-HM200".
		Added Gain event "Up1""Down1" parameters to "3.3.6 Set Web Event" for "GY-HM8x0", "GY-HM660", and "GY-HM200".
		Added target models "GY-HM8x0", "GY-HM660", and "GY-HM200" to MenuStatus of "3.3.1 Get Camera Status"
		Added "3.7. How to control tally system" description for "GY-HM8x0", "GY-HM660", "GY-HM200", and "KY-PZ100".
		Changed ""3.3.5. Tally lamp control" description correspond to it.
1.08	Added "Serial" parameter to "3.2.1. Get System Information" for "GY-HM660", "GY-HM8x0", "GY-HM200", and "KY-PZ100".
	Added "3.2.6 Get NTP Status", "3.2.7 Set NTP Server". and "3,2.8 Set NTP settings" Commands for "GY-HM660", "GY-HM8x0", "GY-HM200", and "KY-PZ100".
	Supported GY-HM25x newly.
	Error correction.
	Added "Whb" "Status" parameter to "3.3.1. Get camera status".
	Changed "3.3.1. Get camera status". Parameter ("Enable" "Streaming" "On/Off") is not effective in "GY-HM200" and "GY-HM25x".
1.09	Added "Serial" parameter to "3.2.1. Get System Information" for "GY-HM650".
	Added "3.5. How to acquire JPEG data" for "GY-HM650".
	Supported GY-HC900 newly.
1.10 for "GY-HC900" updates as below.
		Added some resolution and bitrate parameters to "3.1. Streaming Setting Command".
		Added "Smpte2022Fec" to "3.1.10. Get streaming server settings" and "3.1.16. Set streaming server settings(RTP)".
		Added "AdaptiveBitrate" to "3.1.10. Get streaming server settings" and "3.1.14. Set streaming server settings(ZIXI)".
		Added "3.8. Return over IP Command" for "GY-HC900".
		Added "Resolution" and "FrameRate" to "3.8.3. GelReturnOverpServerSettings" and "3.8.4. SelReturnOverpServerSettings(RTSP/Zixi)".
		Added "3.8.3.1. AvailableTypeOfReturnOverIP" and "3.8.3.2. AvailableFrameRateOfReturnOverIP" commands.
		Added "IrisBar" parameter to "3.3.7. Set Web Slider Event".
		Added "Position(Iris)" parameter "3.3.1. Get camera status".
		Added "PCR Mode" to "3.1.10. Get streaming server settings" and "3.1.16. Set streaming server settings(UDP/Zixi/RTP)".
		Added "Overlay" and "Tagging" parameter to 3.2.1. Get System Information.
		Error correction. GY-HC900 does not support "Iris PushAuto" of "3.3.6 Set Web Event".
1.11 Supported GY-HC5x0 newly.
		Added "3.2.6. Get NTP Status" and "3.2.7. Set NTP Server" for "GY-HC5x0".
		Added SRT parameter for "GY-HC5x0".
		"3.2.1. Get System Information", "3.1.7. Available streaming bitrate settings", "3.1.10. Get streaming server settings", and "3.1.18. Set streaming server settings(SRT)".
		Added "PCR Mode" parameter to "3.1.10. Get streaming server settings" and "3.1.16. Set streaming server settings(UDP/Zixi/RTP)" for GY-HC5x0.
		Added "RTMPS" protocol for "GY-HC5x0".
		"3.1.7. Available streaming bitrate settings" and "3.1.10. Get streaming server settings" and "3.1.16. Set streaming server settings(RTMPS)".
1.12	Added "3.2.6. Get NTP Status" and "3.2.7. Set NTP Server" for "GY-HC900".
	Added SRT parameter for "GY-HC900".
	"3.2.1. Get System Information", "3.1.7. Available streaming bitrate settings", "3.1.10. Get streaming server settings", and "3.1.18. Set streaming server settings(SRT)".
	Added "3.8. Return over IP Command" 30p/25p parameter for "GY-HC5x0".
	Added "IrisBar" parameter to "3.3.7. Set Web Slider Event" for "GY-HC5x0".
	Added "Position(Iris)" parameter "3.3.1. Get camera status" for "GY-HC5x0".
	Added "KA_EN200" parameter to 3.2.1. Get System Information for "GY-HC5x0" and "GY-HC900".
	Added "422 60p" and "422 50p" parameters to each available streaming settings for "GY-HC5x0" and "GY-HC900" when "KA-EN200" is enabled.
	"3.1.1. Get streaming settings" and other available settings.
	Added "EXT slot information" to "3.3.1. Get camera status" for "GY-HC900".
1.13 Added	"RTMPS" protocol for "GY-HM250" and "KY-PZ100". "3.1.7. Available streaming bitrate settings", "3.1.10. Get streaming server settings" and "3.1.16. Set streaming server settings(RTMPS)".
	Added "3.4.6. Get Pan & Tilt Positions" command for "KY-PZ100".
	Added "Username" parameter to "3.1.13. Set streaming server settings(RTSP/RTP)" for "GY-HC5x0" and "GY-HC900".
	Error correction. GY-HC900 has supported "SRT" protocol of "3.1.10. Get streaming server settings"
1.14 Added	"RTMPS" protocol for "GY-HC900". "3.1.7. Available streaming bitrate settings", "3.1.10. Get streaming server settings" and "3.1.16. Set streaming server settings(RTMPS)".
	"GY-HC5x0" is support "One touch Live" on Facebook and YouTube. "3.1.7. Available streaming bitrate settings", "3.1.10. Get streaming server settings".
	"GY-HC900" and "GY-HC5x0" are support "ZIXI" parameter on streaming type of ZIXI. "3.1.7. Available streaming bitrate settings", "3.1.10. Get streaming server settings".
	Portrait Resolution supported in "GY-HC5x0". "3.1.1. Get streaming settings", "3.1.2. Set streaming resolution", "3.1.5. Available streaming resolution settings" and "3.1.6. Available streaming framerate settings".
	Error correction. Corrected Parameter member AES-196 to AES-192 in "SRT" protocol. "3.1.10. Get streaming server settings", "3.1.18. Set streaming server settings(SRT)" Added "and SRT Listener mode" cause of streaming error status. "3.3.1 Get camera status", "3.4.5 Get camera status (for remote controller)" Added "RTP" protocol was Missing description. "3.1.7. Available streaming bitrate settings", "3.1.10. Get streaming server settings" Added Explanation of White balance scale and position for "KY-PZ100". "3.3.1. Get camera status" Corrected Parameter key "OnePush" to "Awb", "OnePushTrigger" to "AwbTrigger" for "KY-PZ100". 3.4.5 Get camera status (for remote controller)
1.15	Added "StreamId", "FEC", "PCRMode", and "AdaptiveBitrate parameters to "3.1.10. Get streaming server settings"/"3.1.18. Set streaming server settings(SRT)" for "GY-HC5x0" and "GY-HC900".
	Support Return over IP streaming type SRT. "3.8.3. GetReturnOverIpServerSettings" / "3.8.8. SetReturnOverIpServerSettingsSRT" / "3.8.3.1. AvailableTypeOfReturnOverIP" for "GY-HC5x0" and "GY-HC900".
	Error correction. Corrected encode size parameter "320x181" to "320x180". "3.5.2. Set JPEG encode size" Corrected parameter style "String" to "Integer" in SRT DstPort. "3.1.10. Get streaming server settings" Parameter Button Fullauto event is no support in "KY-PZ100". "3.3.6. Set Web Button Event" Corrected to no space in "2.3 Response form" return value.
1.16 Supported GY-HM280 newly.
1.17 Supported KY-PZ400 newly.

1. Outline

1.1. Specification

2. Interface

2.1. Authentication
2.2. Request form
2.3. Response form

3. Command

3.1. Streaming Setting Command

3.1.1. Get streaming settings
3.1.2. Set streaming resolution
3.1.3. Set streaming framerate
3.1.4. Set streaming bitrate
3.1.5. Available streaming resolution settings
3.1.6. Available streaming framerate settings
3.1.7. Available streaming bitrate settings
3.1.8. Get current streaming server number
3.1.9. Set current streaming server number
3.1.10. Get streaming server settings
3.1.11. Set streaming server settings(UDP)
3.1.12. Set streaming server settings(TCP)
3.1.13. Set streaming server settings(RTSP/RTP)
3.1.14. Set streaming server settings(ZIXI)
3.1.15. Set streaming server settings(RTMP)
3.1.16. Set streaming server settings(RTMPS)
3.1.17. Set streaming server settings(RTP)
3.1.18. Set streaming server settings(SRT)
3.1.19. Set Streaming Encode Protocol
3.1.20. Set Streaming I Key Frame Interval
3.1.21. Get Video Settings
3.1.22. Set Video HDMI/SDI Output
3.1.23. Set Video Format
3.1.24. Set Video Encode Level
3.1.25. Set Network ONVIF Settings
3.1.26. Set Network Multicast Settings
3.1.27. Set NDI Settings

3.2. System Command

3.2.1. Get System Information
3.2.2. Session renewal
3.2.3. Get preset zoom position
3.2.4. Set preset zoom position
3.2.5. Set tally lamp priority
3.2.6. Get NTP Status
3.2.7. Set NTP Server
3.2.8. Set NTP Settings
3.2.9. Get NTP Settings
3.2.10. SystemRequest

3.3. Camera Control Command

3.3.1. Get camera status
3.3.2. Recording
3.3.3. Set zoom position ( obey preset zoom settings of camera )
3.3.4. Live streaming
3.3.5. Tally lamp control
3.3.6. Set Web Button Event
3.3.7. Set Web Slider Event
3.3.8. Set Web XYField Event
3.3.9. Get GPS Information
3.3.10. Seesaw switch operation

3.4. PTZ Camera Support Command

3.4.1. Set Pan Tilt Control
3.4.2. Joystick Operation
3.4.3. Zoom switch operation
3.4.4. Set Pan / Tilt / Zoom preset
3.4.5. Get camera status (for remote controller)
3.4.6. Get Pan & Tilt Positions

3.5. How to acquire JPEG data

3.5.1. JPEG encode control

3.5.2. Set JPEG encode size

3.5.3. Acquire JPEG data

3.6. How to use Interruptible Feedback Function

3.6.1. Get interruptible feedback settings

3.6.2. Set interruptible feedback settings

3.6.3. Set interruptible feedback streaming control

3.7. How to control Studio Tally System

3.7.1. Studio tally control

3.7.2. Set tally lamp priority

3.7.3. Relation of commands on Studio tally system

3.7.4 Sequence of studio tally system

3.8. Return over IP Command

3.8.1. GetCurrentReturnOverIpServerID

3.8.2. SetCurrentReturnOverIpServerID

3.8.3. GetReturnOverIpServerSettings

3.8.3.1. AvailableTypeOfReturnOverIP

3.8.3.2. AvailableFrameRateOfReturnOverIP

3.8.4. SetReturnOverIpServerSettingsRTSP

3.8.5. SetReturnOverIpServerSettingsZIXI

3.8.6. SetReturnOverIpServerSettingsIcecast

3.8.7. SetReturnOverIpCtrl

3.8.8. SetReturnOverIpServerSettingsSRT

1.1. Specification

This API specification describes commands to control JVC cameras via network.

Following commands are available.

Setting command - Configure camera settings

System command - Perform the information of the camera, the update of the session

, the memory of the value

Camera control command - Control camera

PTZ camera control command - Control PTZ camera

JPEG data acquisition commanc - Acquire JPEG data.

Interruptible feedback settings - Configure IFB settings.

Studio tally control command - Control studio tally display.

Return over IP command - Return over IP Settings and Control.

* Some API commands may be restricted by camera model and software version.

* Supported API functions are depends on the API version of the camera.

Version information can be obtained with the command 'Get System Information'.

Supported camera model and firmware version.

	Firmware Version
API Version	GY-HM650 GY-HM660		GY-HM8x1	GY-HM200	GY-HM25:	GY-HM280 GY-LS300 KY-PZ100	GY-HC90(	GY-HC5x(	KY-PZ400
1.00	V0404 - V0203-0060 V0203-0136 -- V0203		0132 ----
1.01	- V0100-0049 ----
1.02	-- V0300-0067 V0300-0150 -- V0300-0143 ----
1.03	- V0102-0067 ----
1.04	---- V0100-0076 ---
1.05	- V0105-0086 V0301-0076 V0305-0182 -- V0302-0151 V0101-0093 ---
1.06	-- V0303-0084 ----
1.07	- V0110-0111 V0305-0090 V0309-0213 ---	V0102-0103 ---
1.08	- V0112-0136 V0307-0098 V0313-0230 V0100-0007 -- V0104-0118 ---
1.09	V0412 ---- -- V0101-0121 ---
1.10	---- V0230-0217 V0102-0145 -
1.11	---- V0110-0148 -
1.12	---- V0300-0250 V0120-0166 -
1.13	---- V0106-0022 -- V0200-0128 ---
1.14	----						V0400-0268	V0200-0201 -
1.15	----						V0410-0277	V0220-0232 -
1.16	---- V0202-0034 ----
1.17	---- v1.1.98

* This list shows a API version number which is returned by each firmware. Newest API document supports most recent firmware on all models.

2. Interface

Support HTTP protocol

API command request/response uses HTTP protocol.

A request uses a port number 80 with default setting. It may change if the web port setting on the camera menu is modified.

Requests and response data are described with JSON format in HTTP message body.

2.1. Authentication

Digest authentication

Username/password authorization is needed on first access to the camera.

It returns 'Session ID' to the client after authorization.

The client can access without authorization by using this 'Session ID'.

'Session ID' will expire within 30 seconds.

It has to be extended using 'SessionRenewal' command.

Authentication process has to be performed to obtain another 'Session ID' after expiration.

Please refer to RFC2617 for more information.

Procedure

(1) Access to an authentication page of a server from the client.

Example

GET /api.php HTTP/1.1\r\n

Host: 192.168.0.134|r|n

User-Agent: Mozilla/5.0 (Windows NT 5.1; rv:27.0) Gecko/20100101 Firefox/27.0\rIn

Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8|r\n

Accept-Language: ja,en-us;q=0.7,en;q=0.3'rin

Accept-Encoding: gzip, deflate\r\n

Connection: keep-aliveirln

lrin

(2) The response for authentication is returned to a client.

Example

HTTP/1.1 401 Unauthorized\r\n

WWW-Authenticate: Digest realm="GY-HM650",

nonce="7a63056b0a608017c405707e682b9adb", qop="auth" |r|n

Content-Type: text/html\rin

Content-Length: 1458

Date: Tue, 03 Mar 2015 11:35:13 GMT\rin

Server: Camerairln

|r|n

(3) The client re-access with the authentication information (user name and password) to the authentication page

Example

GET /api.php HTTP/1.1\rin

Host: 192.168.0.134|r|n

User-Agent: Mozilla/5.0 (Windows NT 5.1; rv:27.0) Gecko/20100101 Firefox/27.0\r

Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8|r|n

Accept-Language: ja,en-us;q=0.7,en;q=0.3|r in

Accept-Encoding: gzip, deflate\r\n

Connection: keep-alive\rIn

Authorization: Digest username="prohd", realm="GY-HM650",

nonce="7a63056b0a608017c405707e682b9adb", uri="/api.php",

response="0f4d23f739a0e9fa3b78b826b33edaf8", qop=auth, nc=00000001,

cnonce="ee16206547e4dd0e"\r\n

\r\n

(4)Session ID is returned form the camera.

Example

HTTP/1.1 302 Foundirin

Status: 302 Moved Temporarily\rin

Expires: Thu, 19 Nov 1981 08:52:00 GMT\rin

Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0|r|n

Pragma: no-cache|r|n

Set-Cookie: SessionID=10ffa8dcd1bb1cf5f9c252b7b8a20738\r\n

Content-type: text/html; charset=UTF-8\rin

Transfer-Encoding: chunked\r\n

Date: Tue, 03 Mar 2015 11:35:23 GMT\n

Server: Camerarin

\r\n

return to (2) in authentication failure.

* Another client cannot connect while first client is using API interface.

2.2. Request form

Hypertext Transfer Protocol

Example

POST /cgi-bin/api.cgi HTTP/1.1\r\n

Host: 192.168.0.134|r|n

User-Agent: Mozilla/5.0 (Windows NT 5.1; rv:27.0) Gecko/20100101 Firefox/27.0\rIn

Accept: application/json, text/javascript, */; q=0.01\r\n

Accept-Language: ja,en-us;q=0.7,en;q=0.3'rin

Accept-Encoding: gzip, deflate\r\n

Content-Type: application/x-www-form-urlencoded; charset=UTF-8\r\n

X-Requested-With: XMLHttpRequest\In

Referer: http://192.168.0.134/api.php\r\n

Content-Length: 86\r\n

Authorization: Digest username="prohd", realm="GY-HM650",

nonce="7a63056b0a608017c405707e682b9adb", uri="/cgi-bin/api.cgi",

response="c412878c40aa4d4943af678c2ba070b1", qop=auth, nc=0000001a,

cnonce="3c706c583d858603"lrIn

Connection: keep-alive\irln

Pragma: no-cache|r|n

Cache-Control: no-cache\rin

|r|n

HTML Form URL Encoded: application/x-www-form-urlencoded

Camera cannot accept any space character or newline within command string.

Key		Style Value
Request
	Command String (Command name)
	SessionID String		(Session ID in cookie.)
	Params (You can omit this field if there is no parameter.)
	* *

Example

{

"Request": {

"Command":"GetSystemInfo",

"SessionID":"10ffa8dcd1bb1cf5f9c252b7b8a20738"

}

2.3. Response form

Hypertext Transfer Protocol

Example

HTTP/1.1 200 OK\r\nContent-type: application/json\r\nPragma: no-cache\r\nCache-Control: no-cache\r\nExpires: Thu, 01 Dec 1994 16:00:00 GMT\r\nContent-Length: 105\r\nDate: Tue, 03 Mar 2015 11:35:30 GMT\r\nServer: Camera\r\n\r\n

JavaScript Object Notation: application/json

Actual response from camera does not include any space character or newline.

Key Style Value
Response
	Requested String (Command name)
	Result	String	Result of command processingSuccess /DisableError(Timeout) /RequestedError(Illegal parameter error) /FormatError(Illegal request error) /CommandError(Illegal command error) /SessionError(Authentication error) /DualExeError(Duplicate command) /Failed(Other error)
	Data (You can omit this field if there is no parameter.)
	* *

Example

{

"Response": {

"Requested": "GetSystemInfo",

"Result": "Success",

"Data": {

"Model": "HM650",

"Destination": "EU",

"ApiVersion": "0.13.3"

}

3. Command

3.1. Streaming Setting Command

When you change a part of these parameters, you should get all parameters first. then modify and store them again.

Setting commands should be used only when settings need to be changed, otherwise it causes performance degradation.

Zixi and SRT streaming modes are mutually exclusive on GY-HC5x0 and GY-HC900.

Only "Zixi" or "Srt" parameter is effective according to the streaming mode.

Current mode can be checked using GetSystemInfo response.

3.1.1. Get streaming settings

Get the streaming setting

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

GetStreamingSettings

Yes Yes

SessionID

String

{Session ID in cookie.}

Yes Yes

Params

Stream

Integer

0: First, 1: Second

No No

Yes

Example Example(In case of PZ400)

{
    "Request": {
    "Request": {
    "Command": "GetStreamingSettings",
    "SessionID": "7425fbc68ee4d15dd4c1f5ace4299a3"
    }
    "Params": {
    "Stream": 0
    }
}

"Command": "GetStreamingSettings",
"SessionID": "7425fccb58ee-Ad15ddHc15ace4299a3"

Response Key
Style Value
HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

GetStreamingSettings

Yes Yes

Result

String

(Result of command processing.)

Yes Yes

Data

Stream

Integer

0: First, 1: Second

No No

Yes

Resolution

String

"3840x2160" (PZ400: First stream only)

No No

Yes

"1920x1080" (PZ400: First stream only)

Yes Yes

"1440x1080"

No No

"1280x720" (PZ400: First stream only)

Yes Yes

"1024x576" (PZ400: First stream only)

No No

Yes

"720x480"

Yes Yes

No Yes

Yes Yes

"720x576"

Yes Yes

No Yes

Yes No

"720x408"

No No

Yes

"640x480"

No No

Yes

"640x360"

No Yes

Yes Yes

"480x320"

No No

Yes

"480x270"

Yes No

No No

"320x240"

No No

Yes

"1080x1080"

No No

No Yes

"606x1080"

No No

No Yes

"720x720"

No No

Yes

Yes No

No No

Yes No

"404x720"

No No

Yes

Yes No

No No

Yes No

Framerate

String

"60p" / "50p" / "60t" / "50t" / "30p" / "25p" / "422 10bit 60p" / "422 10bit 50p" Character string for Framerate value "1" - "60"

Yes Yes

Yes No

No No

Yes Yes

No No

No Yes

Bitrate

String

"0.2M"

Yes No

No No

"0.3M"

Yes Yes

Yes No

"0.8M"

Yes Yes

Yes No

"1.5M"

Yes Yes

Yes No

"2.5M"

Yes Yes

Yes No

"3.0M"

Yes Yes

Yes No

"5.0M"

Yes Yes

Yes No

"8.0M"

Yes Yes

Yes No

"10M"

Yes Yes

Yes No

"12M"

Yes Yes

Yes No

"16M"

No No

Yes Yes

Yes No

"20M"

No No

Yes Yes

Yes No

"24M"

No No

No Yes

Yes No

Character string for Bitrate box value "32K" - "61440K" (This parameter is valid only H.264/H.265 mode.)

No No

No Yes

Cfactor

String

Character string for quality factor value "1" - "99" (This parameter is valid only MJPEG mode.)

No No

No Yes

EncodeProtocol

String

"H264" / "H265" / "MJPEG"

No No

No Yes

IKeyFrameInterval

Integer

Value of I Key Frame Interval "2" - "60"

No No

No Yes

BitRateControl

String

"CBR" / "VBR"

No No

No Yes

* Framerate "422_10bit_60p" and "422_10bit_50p" are effective only if optional adaptor "KA-EN200" is attached on 'GY-HC900' and 'GY-HC5x0'.

Example Example (In case of H.264/H.265 for PZ400) Example (In case of MJPEG for PZ400)

{
    "Response": { "Response": { "Response": {
    "Requested": "GetStreamingSettings",
    "Result": "Success",
    "Data": { "Data": { "Data": {
    "Resolution": "1920x1080",
    "Framorate": "90",
    "Bitrate": "3.0M"
    }
    }
    }
    }
    "KeyFrameInterval": 30,

"Requested": "GetStreamingSettings",
"Result": "Success",
"Stream": 0,
"Resolution": "1920x1080",
"Framerate": "60",
"Birate": "4096K",
"EncodeProtocol": "H264",
"KeyFrameInterval": 30,
"BitRateControl": "CBR"
j }
j }

"Requested": "GetStreamingSettings",
"Result": "Success",
"Stream": 0,
"Resolution": "1920x1080",
"Framerate": "60",
"Cfaclor": "80",
"EncodeProtocol": "MJPEG",
"BitRateControl": "CBR"

3.1.2. Set streaming resolution

Set streaming resolution

Camcorder automatically reboots with this command on HM650, HM660, and HM8x0.

Current value can be obtained with the 'AvailableStreamingResolutionSettings' command

Request Key

Request

Command

String

SetStreamingResolution

Yes Yes

SessionID

String

(Session ID in cookie.)

Yes Yes

Params

Stream

Integer

0: First. 1: Second

No No

No Yes

Resolution

String

"3840x2160" (PZ400: First stream only)

No No

No Yes

"1920x1080" (PZ400: First stream only)

Yes Yes

"1440x1080"

No No

"1280x720" (PZ400: First stream only)

Yes Yes

"1024x576" (PZ400: First stream only)

No No

No Yes

"720x480"

Yes Yes

"720x576"

Yes Yes

No Yes

Yes No

"720x408"

No No

No Yes

Yes

"640x480"

No No

No Yes

"640x360"

No Yes

Yes Yes

"480x320"

No No

No Yes

"480x270"

Yes No

No No

"320x240"

No No

No Yes

"1080x1080"

No No

No Yes

"606x1080"

No No

No Yes

"720x720"

No No

No Yes

Yes No

No No

Yes No

"404x720"

No No

No Yes

Yes Yes

No No

Yes No

Framerate is fixed by resolution.(HM650/HM660/HM8x0/HM200/HM25x/LS300)

Example Example(In case of PZ400)

"Request": { "Request": {

"Command": "SetStreamingResolution",

"SessionID": "7425fbc658ce4d150d4c15ace4299a3",

"Params": { "Params": {

"Resolution": "1920x1080"

}

"Command": "SetStreamingResolution", "SessionID": "7425f0cb586e4d15dc4c15acc4299a3", "Stream": 0, "Resolution": "1920x1080"

Response Key
Style Value
HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

SetStreamingResolution

Yes Yes

Result

String

(Result of command processing.)

Yes Yes

Example

{

"Response": {

"Requested": "SetStreamingResolution",

"Result": "Success"

}

3.1.3. Set streaming framerate

Set streaming framerate.

Current value can be obtained with the 'AvailableStreamingFramerateSettings' command.

Request Key

Style Value

HM650 HM660 HMEx0 HM200 HM25x HM280 LS300 PZ100 HC800 HC5x0 PZ400

Request

Command

String

SetStreamingFramerate

No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

SessionID

String

(Session ID in cookie.)

No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

Params

Stream

Integer

0: First, 1: Second

No No No No No Yes

Framerate

String

"60p" / "50p" / "60t" / "50l" / "30p" / "25p" / "422 10bit 60p" / "422 10bit 50p"

No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No

Character string for Framerate value "1" - "60"

No No No No No Yes

* Framerate '422 10bit 60p' and '422 10bit 50p' are effective only if optional adaptor "KA-EN200" is attached on 'GY-HC900' and 'GY-HC5x0'.

Example Example(In case of PZ400)

"Request": { "Request": { "Command": "SetStreamingFramerate", "SessionID": "7425fcb58ee4d15dd4c15ace4299a3", "Params": { "Params": { "Framerate": "30p" } "Framerate": "30" } } }

Response

Key

Style

Value

HM850

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HG300

HG5x0

PZ400

Response

Requested

Soring

SetStreamingFramerate

No Yes

Yes Yes

Result

Soring

(Result of command processing)

No Yes

Yes Yes

Example

"Response": { "Requested": "SetStreamingFramerate", "Result": "Success"}

3.1.4. Set streaming bitrate

Set streaming bitrate

Current value can be obtained with the 'AvailableStreamingBitrateSettings' command.

This command does not reboot the camcorder unlike 'Set streaming resolution' command.

Request Key

Style

Value

HM650

HM660

HM8x0

HM200

HM26x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Request

Command

String

SetStreamingBitrate

Yes Yes

SessionID

String

(Session ID in cookie.)

Yes Yes

Params

Stream

Integer

0: First, 1: Second

No No No

Yes

Bitrate

String

"0.2M"

Yes No

No No No

"0.3M"

Yes Yes

Yes No

"0.8M"

Yes Yes

Yes No

"1.5M"

Yes Yes

Yes No

"2.5M"

Yes Yes

Yes No

No No

"3.0M"

Yes Yes

Yes No

"5.0M"

Yes Yes

Yes No

"5.0M"

Yes Yes

Yes No

"10M"

Yes Yes

Yes No

No No

"12M"

Yes Yes

Yes No

"16M"

No No No

No No Yes

Yes Yes

Yes No

"20M"

No No No

No No Yes

Yes Yes

Yes No

"24M"

No No No

No Yes

Yes No

Character string for Bitrate bps value "32K" - "61440K" (This parameter is valid only H.264/H.265 mode.)

No No No

No Yes

Cfactor

String

Character string for quality factor value "1" - "99" (This parameter is valid only MJPEG mode.)

No No No

Yes

BitRateControl

String

"CBR" / "VBR"

No No No

Yes

*In case of PZ400, Bitrate and Qfactor are always needed. The corresponding Value is used depending on the mode.
*In case of PZ400, This settings specified in each Params item must be set in the camera after a reboot.

Example Example(In case of PZ400)

{

"Request": { "Request": {

"Command": "SetStreamingBitrate", "Command": "SetStreamingBitrate", "SessionID": "7425fbcb586e4d15dd4c1f5ace4299a3",

"Params": { "Params": {

"Bitrate": "3.0M"

}

"BitRateControl": "CRR"

"SessionID": "7425fcbc58ee4d15dd4c15ace4299a3",

"Stream": 0,

"Bitrate": "4086K",

"Cfactor": "80",

Response Key
Style Value
HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

SetStreamingBitrate

Yes Yes

Result

String

(Result of command processing.)

Yes Yes

Example

{

"Response": {

"Requested": "SetStreamingBitrate",

"Result": "Success"

}

3.1.5. Available streaming resolution settings

Get available streaming resolution settings

Settable values are depend on the recording resolution setting of the camcorder.

Request Key

Style Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

AvailableStreamingResolutionSettings

Yes Yes

SessionID

String

(Session ID in cookie.)

Yes Yes

Params

Stream

Integer

0: First, 1: Second

No No No

No No

Yes

Example Example(In case of PZ400)

"Request": {"Request": {"Command": "AvailableStreamingResolutionSettings", "SessionID": "7425fccb58ee4d15dd4c1f5ace4299a3"}

"Stream": 0

Response

Key

Style

Value

HM553

HM660

HMEx0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Response

Requested

String

AvailableStreamingResolutionSettings

Yes Yes

Result

String

(Result of command processing.)

Yes Yes

Data

Stream

Integer

0: First, 1: Second

No No

No Yes

AvailableResolution

Yes Yes

3840x2160

0: unselectable, 1: selectable (PZ400: First stream only)

No No

No Yes

1920x1080

Integer

0: unselectable, 1: selectable (PZ400: First stream only)

Yes Yes

1440x1080

Integer

0: unselectable, 1: selectable

No No

1280x720

Integer

0: unselectable, 1: selectable (PZ400: First stream only)

Yes Yes

1024x576

Integer

0: unselectable, 1: selectable (PZ400: First stream only)

No No

No Yes

720x480

Integer

0: unselectable, 1: selectable

Yes Yes

720x576

Integer

0: unselectable, 1: selectable

Yes Yes

No Yes

Yes No

720x408

Integer

0: unselectable, 1: selectable

No No

No Yes

640x480

Integer

0: unselectable, 1: selectable

No No

No Yes

640x360

Integer

0: unselectable, 1: selectable

No Yes

Yes Yes

480x320

Integer

0: unselectable, 1: selectable

No No

No Yes

480x270

Integer

0: unselectable, 1: selectable

Yes No

No No

No No No

320x240

Integer

0: unselectable, 1: selectable

No No

No Yes

1080x1080

Integer

0: unselectable, 1: selectable

No No

No Yes No

606x1080

Integer

0: unselectable, 1: selectable

No No

No Yes No

720x720

Integer

0: unselectable, 1: selectable

No No

Yes Yes

No No

No Yes No

404x720

Integer

0: unselectable, 1: selectable

No No

Yes Yes

No No

No Yes No

Example Example(In case of PZ400)

{
    "Response": { "Response": {
    "Requested": "AvailableStreaming/ResolutionSettings",
    "Result": "Success", "Result": "Success",
    "Data": { "Data": {
    "AvailableResolution": {
    "1920x1080": 1, "AvailableResolution": {
    "1440x1080": 0, "3840x2160": 1,
    "1280x720": 0,
    "720x480": 0,
    "720x576": 0,
    "640x360": 0, "720x480": 1,
    "480x270": 0, "720x408": 1,
    "640x480": 1,
    "640x360": 1,
    "480x320": 0,
    "320x240": 0
    }
    }
}

"Requested": "AvailableStreamingResolutionSettings",
"Stream": 0.
"1920x1080": 1
"1280x720": 1,
"1024x576": 1,

3.1.6. Available streaming framerate settings

Get available streaming framerate settings.

Settable values are depend on the recording resolution setting on the camcorder.

Request Key

Style Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

AvailableStreamingFramerateSettings

No Yes

Yes Yes

Yes

SessionID

String

(Session ID in cookie.)

No Yes

Yes Yes

Yes

Params

Stream

Integer

0: First, 1: Second

No No

Yes

Resolution

String

"3840x2160" (PZ400: First stream only)

No No

Yes

"1920x1080" (PZ400: First stream only)

No Yes

Yes Yes

"1280x720" (PZ400: First stream only)

No Yes

Yes Yes

"1024x576" (PZ400: First stream only)

No No

Yes

"720x480"

No Yes

Yes Yes

No Yes

Yes Yes

"720x576"

No Yes

Yes Yes

No Yes

Yes Yes

"720x408"

No No

Yes

"640x490"

No No

Yes

"640x360"

No Yes

Yes Yes

"480x320"

No No

Yes

"320x240"

No No

Yes

"1080x1080"

No No

Yes

"606x1080"

No No

Yes

"720x720"

No No

Yes Yes

Yes No

No Yes

Yes

"404x720"

No No

Yes Yes

Yes No

No Yes

Yes

Example Example(In case of PZ400)

"Request": { "Request": {

"Command": "AvailableStreamingFramerateSettings",

"SessionID": "7425fbc68ee4d15dd4c1f5ace4299a3"

"Params": { "Params": {

"Resolution": "1920x1080"

}

"Command": "AvailableStreamingFramerateSettings".

"SessionID": "7425fbcb58ee4d15dd4c1f5ace4299a3"

"Stream": 0.

"Resolution": "1920x1080"

Response Key
Style Value
HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

AvailableStreamingFramerateSettings

No Yes

Yes Yes

Result

String

(Result of command processing.)

No Yes

Yes Yes

Data

Stream

Integer

0: First, 1: Second

No No

No Yes

Resolution

String

"3840x2160" (PZ400: First stream only)

No No

No Yes

"1920x1080" (PZ400: First stream only)

No Yes

Yes Yes

"1280x720" (PZ400: First stream only)

No Yes

Yes Yes

"1024x576" (PZ400: First stream only)

No No

Yes

"720x480"

No Yes

Yes Yes

"720x576"

No Yes

Yes Yes

"720x408"

No No

Yes

"640x480"

No No

Yes

"640x360"

No Yes

Yes Yes

"480x320"

No No

Yes

"320x240"

No No

Yes

"1080x1080"

No No

Yes

"606x1080"

No No

Yes

"720x720"

No No

Yes Yes

Yes No

"404x720"

No No

Yes Yes

Yes No

AvailableFramerate

60p

Integer

0 : unselectable , 1 : selectable

No Yes

Yes Yes

60i

Integer

0 : unselectable , 1 : selectable

No Yes

Yes Yes

30p

Integer

0 : unselectable , 1 : selectable

No Yes

Yes Yes

50p

Integer

0 : unselectable , 1 : selectable

No Yes

Yes Yes

50i

Integer

0 : unselectable , 1 : selectable

No Yes

Yes Yes

25p

Integer

0 : unselectable , 1 : selectable

No Yes

Yes Yes

422_10bit_60p

Integer

0 : unselectable , 1 : selectable

No No

No Yes

Yes No

422_10bit_50p

Integer

0 : unselectable , 1 : selectable

No No

No Yes

Yes No

max_25

Integer

0 : unselectable , 1 : selectable

No No

Yes

max_30

Integer

0 : unselectable , 1 : selectable

No No

Yes

max_50

Integer

0 : unselectable , 1 : selectable

No No

Yes

max_60

Integer

0 : unselectable , 1 : selectable

No No

Yes

Framerate "422_10bit_60p" and "422_10bit_50p" are effective only if optional adaptor "KA-EN200" is attached on 'GY-HC900' and 'GY-HC5x0'.

Example Example(In case of PZ400)

{
    "Response": { "Response": {
    "Requested": "AvailableStreaming/FramerateSettings",
    "Result": "Success", "Result": "Success",
    "Data": { "Data": {
    "Resolution": "1920x1080",
    "AvailableFramerate": {
    "60p": 1,
    "60l": 0, "max_25": 0,
    "30p": 0, "max_30": 0,
    "50p": 0, "max_50": 0,
    "50l": 0, "max_60": 1
    "25p": 0
    "422_10bit_60p": 0, }
    "422_10bit_50p": 0 }
    }
    }
}

"Requested": "AvailableStreamingFramerateSettings",

"Stream": 0,
"Resolution": "1920x1080",
"AvailableFramerate": {

3.1.7. Available streaming bitrate settings

Get available streaming bitrate settings

Request Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Request

Command

String

AvailableStreamingBitrateSettings

Yes Yes

SessionID

String

(Session ID in cookie.)

Yes Yes

Params

Stream

Integer

0: First, 1: Second

No No

Yes

Type

String

"UDP" /

Yes Yes

Yes No

"UDPN" (PCR Jitter is Normal) /

No Yes

Yes No

No No

"UDPL"(PCR Jitter is Low) /

No Yes

Yes No

No No

"TCP" /

Yes No

No No

No Yes

Yes No

"RTSP" /

Yes Yes

"ZIXIM"(Zxi Medium/Minimum/High Latency) /

Yes Yes

Yes No

"ZIXIL"(Zxi Low Latency) /

Yes Yes

Yes No

"ZIXI" /

No No

No Yes

Yes No

"RTMP" /

Yes Yes

"RTMPS" /

No No

Yes No

Yes Yes

Yes

"RTP" /

Yes Yes

Yes No

"Facebook" /

No No

Yes No

No No

Yes No

"YouTube" /

No No

No Yes

"SRT"

No No

No Yes

Yes Yes

Resolution

String

"3840x2160" (PZ400: First stream only)

No No

No Yes

"1920x1080" (PZ400: First stream only)

No Yes

Yes Yes

"1280x720" (PZ400: First stream only)

No Yes

Yes Yes

Yes Tos

"1024x576" (PZ400: First stream only)

No No

No Yes

"720x480"

No Yes

Yes Yes

No Yes

Yes Yes

"720x576"

No Yes

Yes Yes

Yes No

Yes Yes

"720x408"

No No

Yes

"640x480"

No No

Yes

"640x360"

No Yes

Yes Yes

Yes

"480x320"

No No

No Yes

"320x240"

No No

No Yes

"1080x1080"

No No

No Yes

"606x1080"

No No

No Yes

"720x720"

No No

Yes No

No No

Yes No

"404x720"

No No

Yes No

No No

Yes No

Framerate

"60p" / "50p" / "60i" / "50i" / "30p" / "25p" /

No No

No Yes

Yes No

"422_10bit_60p" / "422_10bit_50p"

No No

Yes No

Character string for Framerate value "1" - "60"

No No

No Yes

* Framerate "422_10bit_60p" and "422_10bit_50p" are effective only if optional adaptor "KA-EN200" is attached on 'GY-HC900' and 'GY-HC5x0'.

Example Example(In case of PZ400)

{
    "Request": { "Request": {
    "Command": "AvailableStreamingSibrateSettings",
    "SessionID": "7425fbcb56cc4d15dd4c15aco4299a3",
    "Params": { "Params": {
    "Type": "TCP",
    "Resolution": "1920x1080", "Type": "RTSP",
    "Framerate": "60p" "Resolution": "1920x1080",
    } "Framerate": "30"
    }
    }
}

"Command": "AvailableStreamingBitrateSettings",
"SessionID": "7425fbcb58cc04d15dd4c1f5aco4299a3",
"Stream": 0,

Response Key
Style Value
HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

AvailableStreamingBitrateSettings

Yes Yes

Result

String

(Result of command processing.)

Yes Yes

Data

Stream

Integer

0: First, 1: Second

No No

No Yes

Type

String

"UDP" /

Yes Yes

Yes No

"UDPN" (PCR Jitter is Normal) /

No Yes

Yes No

No No

"UDPL"(PCR Jitter is Low) /

No Yes

Yes No

No No

"TCP" /

Yes No

No No

No Yes

Yes No

"RTSP" /

Yes Yes

"ZIXIM"(Zixi Medium/Minimum/High Latency) /

Yes Yes

Yes No

"ZIXIL"(Zixi Low Latency) /

Yes Yes

Yes No

"ZIXI" /

No No

No Yes

Yes No

"RTMP"

Yes Yes

"RTMPS" /

No No

No Yes

Yes No

Yes Yes

"RTP" /

Yes Yes

Yes No

"Facebook" /

No No

No Yes

Yes No

No No

Yes No

"YouTube" /

No No

No Yes

"SRT"

No No

No Yes

Yes Yes

Resolution

String

"3840x2160" (PZ400: First stream only)

No No

No Yes

"1920x1080" (PZ400: First stream only)

No Yes

Yes Yes

"1280x720" (PZ400: First stream only)

No Yes

Yes Yes

"1024x576" (PZ400: First stream only)

No No

Yes

"720x480"

No Yes

Yes Yes

Yes No

Yes Yes

Yes

"720x576"

No Yes

Yes Yes

Yes No

Yes Yes

"720x408"

No No

Yes

"640x480"

No No

Yes

"640x360"

No Yes

Yes Yes

Yes

"480x320"

No No

Yes

"320x240"

No No

Yes

"1080x1080"

No No

Yes No

"606x1080"

No No

Yes No

"720x720"

No No

Yes No

No No

Yes No

"404x720"

No No

Yes No

No No

Yes No

Framerate

String

"60p" / "50p" / "60l" / "50l" / "30p" / "25p" / "422_10bit_60p" / "422_10bit_50p" Character string for Framerate value "1" - "60"

No No

No Yes

Yes No

No No

No Yes

Yes No

No No

Yes

AvailableBitrate

0.2M

Integer

0: unselectable, 1: selectable

Yes No

No No

0.3M

Integer

0: unselectable, 1: selectable

Yes Yes

Yes No

0.8M

Integer

0: unselectable, 1: selectable

Yes Yes

Yes No

1.5M

Integer

0: unselectable, 1: selectable

Yes Yes

Yes No

2.5M

Integer

0: unselectable, 1: selectable

No No

3.0M

Integer

0: unselectable, 1: selectable

Yes Yes

Yes No

5.0M

Integer

0: unselectable, 1: selectable

Yes Yes

Yes No

8.0M

Integer

0: unselectable, 1: selectable

Yes Yes

Yes No

10M

Integer

0: unselectable, 1: selectable

No No

12M

Integer

0: unselectable, 1: selectable

Yes Yes

Yes No

16M

Integer

0: unselectable, 1: selectable

No No

No Yes

Yes Yes

Yes No

20M

Integer

0: unselectable, 1: selectable

No No

Yes Yes

Yes No

24M

Integer

0: unselectable, 1: selectable

No No

No Yes

Yes No

32K-61440K

Integer

0: unselectable, 1: selectable

No No

No Yes

* Framerate '422_10bit_60p' and '422_10bit_50p' are effective only if optional adaptor "KA-EN200" is attached on 'GY-HC900' and 'GY-HC5x0'.

Example Example(In case of PZ400)

{
    "Response": { "Response": {
    "Requested": "AvailableStreamingBitrateSettings",
    "Result": "Success": "Result": "Success",
    "Data": { "Data": {
    "Type": "TCP",
    "Resolution": "1920x1080", "Type": "RTSP",
    "Framorate": "60p", "Resolution": "1920x1080",
    "AvailableBitrate": { "Framorate": "30",
    "0.2M": 0, "AvailableBitrate": {
    "0.3M": 0, "32K-61440K": 1,
    "0.6M": 0, }
    "1.5M": 0, }
    "2.5M": 0, }
    "3.0M": 1, }
    "5.0M": 1,
    "8.0M": 1,
    "10M": 0,
    "12M": 1,
    "16M": 1,
    "20M": 1,
    "24M": 1
    }
    }
}

"Requested": "AvailableStreamingBitrateSettings".
"Stream": 0,

3.1.8. Get current streaming server number

Get current streaming server ID.

There are four settings of streaming server

Request Key

Style Value

HM650 HM660 HMEx0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

GetCurrentStreamingServerID

Yes Yes

Yes No

SessionID

String

(Session ID in cookie.)

Yes Yes

Yes No

Example

{

"Request": {

"Command": "GetCurrentStreamingServerID",

"SessionID": "7425fbcb58ee4d15dd4c15ace4299a3"

}

Response Key

Response

Requested

String

GetCurrentStreamingServerID

Yes Yes

Yes No

Result

String

(Result of command processing.)

Yes Yes

Yes No

Data

Integer

0:server1, 1: server2, 2: server3, 3: server4

Yes Yes

Yes No

Example

"Response": {"Requested": "GetCurrentStreamingServerID", "Result": "Success", "Data": {"ID": 9}}

3.1.9. Set current streaming server number

Set current streaming server ID.

Choose the server ID to use in streaming.

Request Key

Style Value

HM650

HM660

HMEx0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

SetCurrentStreamingServerID

Yes Yes

Yes No

SessionID

String

{Session ID in cookie.}

Yes Yes

Yes No

Params

Integer

0:server1, 1: server2, 2: server3, 3: server4

Yes Yes

Yes No

Example

"Request": {

"Command": "SetCurrentStreamingServerID",

"SessionID": "7425fbcb58ee4d15dbHo15ace4299a3",

"Params": {

"ID": 3

}

Response Key

Response

Requested

String

SetCurrentStreamingServerID

Yes Yes

Yes No

Result

String

(Result of command processing.)

Yes Yes

Yes No

Example

"Response": { "Requested": "SetCurrentStreamingServerID", "Result": "Success"}

3.1.10. Get streaming server settings

Get streaming settings for each server ID.

Request Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HG900

HC5x0

PZ400

Request

Command

String

GetStreamingServerSettings

Yes Yes

SessionID

String

(Session ID in cookie.)

Yes Yes

Params

Integer

0:server1, 1: server2, 2: server3, 3: server4

Yes Yes

Yes No

Type

String

"RTSP"/"RTSP2"/"RTMP"/"RTMP2"/"RTMPS"/"RTMPS2"/"SRT"/"ONVIF"/"Multicast"/"NDI"

No No

Yes

Example Example(In case of PZ400)

{"Request": {"Request": {"Command": "GetStreamingServerSettings", "SessionID": "7425fcbc8ee4d15dd4c1f5ace4299a3", "Params": {"Params": {"ID": 1}}}}

Response

Key

Style

Value

HM650

HM660

HMEx0

HM200

HM25x

HM280

LS300

PZ100

HC300

HC5x0

PZ400

Response

Requested

String

GetStreamingServerSettings

Yes Yes

Result

String

(Result of command processing.)

Yes Yes

Data

Alias

String

(Another name of server)

Yes Yes

Yes No

Type

String

"UDP" /

Yes Yes

Yes No

"TCP" /

Yes No

No No

No Yes

Yes No

"RTSP" /

Yes Yes

"RTSP2" /

No No

Yes

"ZIXI" /

Yes Yes

Yes No

"RTMP"

Yes Yes

"RTMP2"

No No

No Yes

"RTMPS" /

No No

Yes Yes

"RTMPS2" /

No No

Yes

"RIP" /

Yes Yes

Yes No

"Facebook" /

No No

Yes Yes

No No

No Yes

"YouTube" /

No No

Yes No

"SRT"

No No

Yes Yes

"ONVIF"

No No

No Yes

"Multicast"

No No

No Yes

"NDI"

No No

No Yes

Udp

(Selected by Type)

DstAddress

String

(IP address)

Yes Yes

Yes No

DstPort

Integer

(Port number)

Yes Yes

Yes No

PcrJitter

Integer

0:NORMAL, 1:LOW

No Yes

Yes Yes

No No No

PcrMode

Integer

0:Standard, 1:Fast

No No

No Yes

Yes Yes

Tcp

{Selected by Type}

DstAddress

String

{IP address}

Yes No

No No

No Yes

Yes No

DstPort

Integer

{Port number}

Yes No

No No

No Yes

Yes No

Rtsp

{Selected by Type}

DstPort

Integer

{Port number}

Yes Yes

StreamId

String

{Stream ID}

Yes Yes

Username

String

{User name}

Yes Yes

Password

String

{Password for RTSP;RTP}

Yes Yes

Auth

Integer

0:OFF, 1:ON

No No

No Yes

Zixi

{Selected by Type}

DstAddress

String

{IP address}

Yes Yes

Yes No

DstPort

Integer

{Port number}

Yes Yes

Yes No

StreamId

String

{Stream ID for ZIXI}

Yes Yes

Yes No

Password

String

{Password for ZIXI}

Yes Yes

Yes No

Latency

Integer

0:Low, 1:Medium, 2:Minimum(Zxi OFF), 3:High

Yes Yes

Yes No

PorMode

Integer

0:Standard, 1:Fast

No No

Yes Yes No

AdaptiveBitrate

Integer

0:OFF, 1:ON

Yes Yes

Yes No

Rtmp

{Selected by Type}

DstUrl

String

{Network URL for Delivery}

Yes Yes

StreamKey

String

{Key for Delivery}

Yes Yes

Status

Integer

0:OFF, 1:ON

No No

No Yes

Video

Integer

0:Disable, 1:Enable

No No

No Yes

Audio

Integer

0:Disable, 1:Enable

No No

No Yes

Rtmps

{Selected by Type}

DstUrl

String

{Network URL for Delivery}

No No

Yes Yes

StreamKey

String

{Key for Delivery}

No No

Yes Yes

Status

Integer

0:OFF, 1:ON

No No

No Yes

Video

Integer

0:Disable, 1:Enable

No No

No Yes

Audio

Integer

0:Disable, 1 :Enable

No No

No Yes

Rtp

{Selected by Type}

DstAddress

String

{IP address}

No Yes

Yes Yes

Yes No

DstPort

Integer

{Port number}

No Yes

Yes Yes

Yes No

PorMode

Integer

0:Standard, 1:Fast

No No

No Yes

Yes No

Simple2022Fcc

Integer

0:OFF, 1:ON

No Yes

Yes Yes

Yes No

FecMatrixL

Integer

4 - 20

No Yes

Yes Yes

Yes No

FecMatrixD

Integer

4 - 20

No Yes

Yes Yes

Yes No

Srt

{Selected by Type}

DstAddress

String

{IP address}

No No

No Yes

Yes Yes

DstPort

Integer

{Port number}

No No

No Yes

Yes Yes

StreamId

String

{Stream ID for SRT}

No No

No Yes

Yes Yes

ConnectionMode

Integer

0: Callier, 1: Listener, 2: Rendezvous

No No

No Yes

Yes Yes

BandwidthOverhead

Integer

5 - 100

No No

No Yes

Yes Yes

Latency

Integer

20 - 8000

No No

No Yes

Yes Yes

Encryption

Integer

0: Off, 1: AES-128, 2: AES-192, 3: AES-256

No No

No Yes

Yes Yes

FEC

Integer

0: Off, 1: 10x10, 2: 8x8, 3: 6x6

No No

No Yes

Yes Yes

AdaptiveBitrate

Integer

0:OFF, 1:ON

No No

No Yes

Yes No

PorMode

Integer

0:Standard, 1:Fast

No No

No Yes

Yes No

Passphrase

String

ASCII 10-79 character

No No

No Yes

Yes Yes

Status

Integer

0:OFF, 1:ON

No No

Yes

Onvif

{Selected by Type}

Status

Integer

0:OFF, 1:ON

No No

Yes

Auth

Integer

0:OFF, 1:ON

No No

Yes

Multicast

(Selected by Type)

Status

Integer

0:OFF, 1:ON

No No No No No

No No No No No No

Yes

DstAddress

String

(IP address)

No No No No No

Yes

DstPort

Integer

(Port number)

No No No No No

Yes

Ndi

(Selected by Type)

DeviceName

String

(text)

No No No No No

Yes

GroupName

String

(text)

No No No No No

Yes

Example Example(In case of PZ400)

{
    "Response": { "Response": {
    "Requested": "GetStreamingServerSettings",
    "Result": "Success", "Result": "Success",
    "Data": { "Data": {
    "Alias": "Server1", "Type": "RTSP",
    "Type": "TCP", "Risp": {
    "Top": { "DstPort": 6504",
    "DstAddress": "192.169.0.1",
    "DstPort": 6504", "Username": "user",
    } "Password": "abcde",
    } "Auth": 1
    }
    }
}

{
"Requested": "GetStreamingServerSettings",
"StreamId": "i",
}
}

3.1.11. Set streaming server settings(UDP)

Set streaming settings for each server ID.

Request Key

Style Value

HM650 HM660 HM850 HM200 HM25x HM280 LS300 PZ100 HC900 HC05x0 PZ400

Request

Command

String

SetStreamingServerSettingsUDP

Yes Yes

Yes No

SessionID

String

(Session ID in cookie.)

Yes Yes

Yes No

Params

Integer

0:server1, 1:server2, 2: server3, 3: server4

Yes Yes

Yes No

Alias

String

(Another name of server)

Yes Yes

Yes No

DstAddress

String

(IP address)

Yes Yes

Yes No

DstPort

Integer

(Port number)

Yes Yes

Yes No

PcrMode

Integer

0:Standard, 1:Fast

No No

Yes Yes

PcrJitter

Integer

0:NORMAL, 1:LOW

No Yes

Yes Yes

Yes No

No No

Example

{
    "Request": {
    "Command": "SetStreamingServerSettingsUDP",
    "SessionID": "7425fccb88ee4d15d04c15ace4298a3",
    "Params": {
    "ID": 1,
    "Alias": "Server",
    "DstAddress": "192.168.0.1",
    "DstPort": 6504,
    "ForJitter": 1
    }
}

Response Key

Response

Requested

Siring

SetStreamingServerSettingsUDP

Yes Yes

Yes No

Result

Siring

(Result of command processing.)

Yes Yes

Yes No

Example

{
    "Response": {
    "Requested": "SetStreamingServerSettingsUDP",
    "Result": "Success"
    }
}

3.1.12. Set streaming server settings(TCP)

Set streaming settings for each server ID

Type "TCP" is effective in 'GY-HM650', 'GY-HC5x0', and 'GY-HC900'.

Request Key

Style Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

SetStreamingServerSettingsTCP

Yes No

No No

No Yes

Yes No

SessionID

String

(Session ID in cookie.)

Yes No

No No

No Yes

Yes No

Params

Integer

0:server1, 1: server2, 2: server3, 3: server4

Yes No

No No

No Yes

Yes No

Alias

String

(Another name of server)

Yes No

No No

No Yes

Yes No

DstAddress

String

(IP address)

Yes No

No No

No Yes

Yes No

DstPort

Integer

(Port number)

Yes No

No No

No Yes

Yes No

Example

{

"Request": {

"Command": "SetStreamingServerSettingsTCP":

"SessionID": "7425fbcb58eeAd15ddHc1f5ace4299a3",

"Params": {

"ID": 1,

"Alias": "Servort",

"DstAddress": "132.168.0.1",

"DstPort": 6504

}

Response Key

Type

Style

Value

HM650

HM660

HM6x0

HM200

HM25x

HM260

LS300

PZ100

HC900

HC5x0

PZ400

Response

Requested

String

SetStreamingServerSettingsTCP

Yes No

No No

No Yes

Yes No

Result

String

(Result of command processing.)

Yes No

No No

No Yes

Yes No

Example

{

"Response": {

"Requested": "SetStreamingServerSettingsTCP",

"Result": "Success"

}

3.1.13. Set streaming server settings(RTSP/RTP)

Set streaming settings for each server ID.

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

SetStreamingServerSettingsRTSP

Yes Yes

SessionID

String

(Session ID in cookie.)

Yes Yes

Params

Integer

0:server1, 1:server2, 2: server3, 3: server4

Yes Yes

Yes No

Alias

String

(Another name of server)

Yes Yes

Yes No

Username

String

(Username for RTSP/RTP)

No No No

No No

No Yes

Yes No

Password

String

(Password for RTSP/RTP)

Yes Yes

Yes No

DstPort

Integer

(Port number)

No No

No Yes

Auth

Integer

0:OFF, 1:ON

No No

No Yes

Example Example(In case of PZ400)

'Request': { "Request": {

"Command": "SetStreamingServerSettingsRTSP",

"SessionID": "7425fycb58ce4d15dd4c15ace4299a3",

"Params": { "Params": {

"ID": 1,

"Alias": "Servlet",

"Username": "user",

"Password": "abcde"

}

"Command": "SetStreamingServerSettingsRTSP", "SessionID": "7425f0cb68ee4d15dd4c15ace4299a3",

"DstPort": 554,

"Auth": 1

}

Response

Style Value

HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

SetStreamingServerSettingsRTSP

Yes Yes

Result

String

(Result of command processing.)

Yes Yes

Example

"Response":

"Requested": "SetStreamingServerSettingsRTSP",

"Result": "Success"

3.1.14. Set streaming server settings(ZIXI)

Set streaming settings for each server ID.

Request Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Request

Command

String

SetStreamingServerSettingsZIXI

Yes Yes

Yes No

SessionID

String

(Session ID in cookie.)

Yes Yes

Yes No

Params

Integer

0:server1, 1:server2, 2: server3, 3: server4

Yes Yes

Yes No

Alias

String

(Another name of server)

Yes Yes

Yes No

DstAddress

String

(IP address)

Yes Yes

Yes No

DstPort

Integer

(Port number)

Yes Yes

Yes No

StreamId

String

(Stream ID for ZIXI)

Yes Yes

Yes No

Password

String

(Password for ZIXI)

Yes Yes

Yes No

Latency

Integer

0:Low, 1:Medium, 2:Minimum(Zixi OFF), 3:High

Yes Yes

Yes No

PcrMode

Integer

0:Standard, 1:Fast

No No

Yes Yes

Yes No

AdaptiveBitrate

Integer

0:OFF, 1:ON

Yes Yes

Yes No

* High Latency of Type is effective in 'GY-HM660', 'GY-HM200', 'GY-HM25x', 'GY-HM280', 'GY-LS300', 'GY-HM8x0', and 'KY-PZ100'.

Example

{
    "Request": {
    "Command": "SetStreamingServerSettingsZ1X1",
    "SessionID": "7425f3cb58ee4d15dd4c1f5aco4299a3",
    "Params": {
    "ID": 1,
    "Alias": "Servor1",
    "DstAddress": "192.168.0.1",
    "DstPort": 2088,
    "StreamId": "HMS50-1234",
    "Password": "abcde",
    "Latency": 1,
    "AdaptiveBtrate": 0
    }
    }
}

Response Key
Style Value
HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

SetStreamingServerSettingsZIXI

Yes Yes

Yes No

Result

String

(Result of command processing.)

Yes Yes

Yes No

Example

{

"Response": {

"Requested": "SetStreamingServerSettingsZIXI",

"Result": "Success"

}

3.1.15. Set streaming server settings(RTMP)

Set streaming settings for each server ID.

Request Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Request

Command

String

SetStreamingServerSettingsRTMP

Yes Yes

SessionID

String

(Session ID in cookie.)

Yes Yes

Params

Integer

:server1, 1:server2, 2: server3, 3: server4

Yes Yes

Yes No

Alias

String

(Another name of server)

Yes Yes

Yes No

Stream

Integer

0: First, 1: Second

No No

Yes

DstUrl

String

(Network URL for Delivery)

Yes Yes

StreamKey

String

(Key for Delivery)

Yes Yes

Status

Integer

0:OFF, 1:ON (Other settings are valid when this is ON.)

No No

Yes

Video

Integer

0:Disable, 1:Enable

No No

Yes

Audio

Integer

0:Disable, 1:Enable

No No

Yes

Example Example(In case of PZ400)

'Request': { "Request": {

"Command": "SetStreamingServerSettingsHTML",

"SessionID": "7425tctb580e4d15dd4c15aco4299a3",

"Params": { "Params": {

"ID": 1,

"Alias": "Server1",

"DstUN": "http://xxx.xxxx.xxxx-xxx.com/play",

"StreamKey": "livestreaming"

}

"Command": "SetStreamingServerSettingsRTMP", "SessionID": "7425/bcb580x4d15dd4c1f5aco4299a3", "Stream": 0, "DstUrl": "http://xxxx.xxxx.xxxx-xxx.com/live", "StreamKey": "stream0", "Status": 1, "Video": 0, "Audio": 0

}

Response

Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Response

Requested

String

SetStreamingServerSettingsRTMP

Yes Yes

Result

String

(Result of command processing.)

Yes Yes

Example

{

"Response": {

"Requested": "SetStreamingServerSettingsRTMP",

"Result": "Success"

}

3.1.16. Set streaming server settings(RTMPS)

Set streaming settings for each server ID.

Request Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HG900

HG5x0

PZ400

Request

Command

String

SetStreamingServerSettingsRTMPS

No No

No Yes

Yes

No Yes

Yes

SessionID

String

(Session ID in cookie.)

No No

No Yes

Yes

No Yes

Yes

Params

Integer

0:server1, 1:server2, 2: server3, 3: server4

No No

No Yes

Yes

No Yes

Yes

Alias

String

(Another name of server)

No No

No Yes

Yes

No Yes

Yes

Stream

Integer

0: First, 1: Second

No No

Yes

DstUrl

String

(Network URL for Delivery)

No No

No Yes

Yes

No Yes

Yes

StreamKey

String

(Key for Delivery)

No No

No Yes

Yes

No Yes

Yes

Status

Integer

0:OFF, 1:ON (Other settings are valid when this is ON.)

No No

Yes

Video

Integer

0:Disable, 1:Enable

No No

Yes

Audio

Integer

0:Disable, 1:Enable

No No

Yes

Example Example(In case of PZ400)

{
    "Request": { "Request": {
    "Command": "SetStreamingServerSettingsRTIMP5",
    "SessionID": "7425tctb580e4d15dd4c15aco4299a3",
    "Params": { "Params": {
    "ID": 1,
    "Alias": "Server1",
    "DstUN": "https://xxx.xxxx.xxxx.xx.com/play",
    "StreamKey": "livestreaming"
    }
    }
}

{
"Command": "SetStreamingServerSettingsRTMPS",
"SessionID": "74250cb580p4d15dd4c1f5aco4299a3",
"Stream": 0,
"DstUrl": "https://xxxx.xxxx.xxxx-xxx.com/live",
"StreamKey": "stream0",
"Status": 1,
"Video": 0,
"Audio": 0
}

Response

Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Response

Requested

String

SetStreamingServerSettingsRTMPS

No No

No Yes

Yes

No Yes

Yes Yes

Result

String

(Result of command processing.)

No No

No Yes

Yes

No Yes

Yes Yes

Example

{
    "Response": {
    "Requested": "SetStreamingServerSettingsRTMPS",
    "Result": "Success"
    }
}

3.1.17. Set streaming server settings(RTP)

Set streaming settings for each server ID.

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

SetStreamingServerSettingsRTP

No Yes

Yes Yes

Yes No

SessionID

String

(Session ID in cookie.)

No Yes

Yes Yes

Yes No

Params

Integer

0:server1, 1:server2, 2: server3, 3: server4

No Yes

Yes Yes

Yes No

Alias

String

(Another name of server)

No Yes

Yes Yes

Yes No

DstAddress

String

(IP address)

No Yes

Yes Yes

Yes No

DstPort

Integer

(Port number)

No Yes

Yes Yes

Yes No

PcrMode

Integer

0:Standard, 1:Fast

No No

No Yes

Yes No

Smpte2022Fec

Integer

0:OFF, 1:ON

No Yes

Yes Yes

Yes No

FocMatrixL

Integer

4 - 20

No Yes

Yes Yes

Yes No

FocMatrixD

Integer

4 - 20

No Yes

Yes Yes

Yes No

* FecMatorixL and FecMatrixD value are satisfy AxB=100 condition.

Example

{
    "Request": {
    "Command": "SetStreamingServerSettingsHTTP",
    "SessionID": "7425bcb58ee4d15dd4c15ace4298a3",
    "Params": {
    "ID": 1,
    "Alias": "Server1",
    "DstAddress": "182.168.0.1",
    "DstPort": 2088,
    "Simple2022Fec": 1,
    "FedMatrixL": 10,
    "FedMatrixD": 10
    }
    }
}

Response Key

Stvo

Value

HM650

HM660

HM6x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Response

Requested

String

SetStreamingServerSettingsRTP

No Yes

Yes Yes

Yes Yes No

Result

String

(Result of command processing.)

No Yes

Yes Yes

Yes No

Example

{
    "Response": {
    "Requested": "SetStreamingServerSettingsRTP",
    "Result": "Success"
    }
}

3.1.18. Set streaming server settings(SRT)

Set streaming settings for each server ID.

Request Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HG900

HG5x0

PZ400

Request

Command

String

SetStreamingServerSettingsSRT

No No

No Yes

Yes

SessionID

String

(Session ID in cookie.)

No Yes

Yes

Params

integer

:server1, 1: server2, 2: server3, 3: server4

No Yes

Yes

Alias

string

(Another name of server)

No Yes

Yes

DstAddress

string

(IP Address)

No Yes

Yes

DstPort

integer

1 - 65535

No Yes

Yes

StreamId

string

(Stream ID for SRT)

No Yes

Yes

ConnectionMode

integer

: Caller 1: Listener, 2: Rendezvous

No Yes

Yes

BandwidthOverhead

integer

5 - 100

No Yes

Yes

Latency

integer

20 - 8000

No Yes

Yes

Encryption

integer

:OFF, 1: AES-128, 2: AES-192 3: AES-256

No Yes

Yes

FEC

integer

:OFF, 1: 10x10, 2: 8x8 3: 6x6

No Yes

Yes

AdaptiveBitrate

integer

:OFF, 1:ON

No Yes

Yes

PCIMode

integer

:Standard, 1:Fast

No Yes

Yes

Passphrase

string

ASCII 10-79 character

No Yes

Yes

Status

integer

:OFF, 1:ON {Other settings are valid when this is ON.The second stream is not supported, it works as OFF regardless of the setting.}

No Yes

Example Example(In case of PZ400)

{
    "Request": { "Request": {
    "Command": "SetStreamingServerSettingsRRT",
    "SessionID": "7425fcbc58ee-Id15dd4c1f5ace4299a3",
    "Params": { "Params": {
    "ID": 0,
    "Alias": "Server1",
    "DstAddress": "192.162.0.1",
    "DstPort": 6504
    "ConnectionMode": 0
    "BandwidthOverhead": 10
    "Latency": 20
    "Encryption": 0
    "Passphrase": "abcdefghijklmnopqrstuvwxyz"
    }
    }
}

{
    "Command": "SerStreamingServerSettingsSRT",
    "SessionID": "7425fcbc58ee4d15dd4c1f5ace4299a3",
    "DstPort": 6504,
    "Encryption": 7,
    "Passphrase": "abcdefghijklmnopqrstuvwxyz",
    "Status": 1
}
}

Response Key
Style Value
HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

SetStreamingServerSettingsSRT

No No No No No

No No No Yes Yes Yes

Result

String

(Result of command processing.)

No No No No No

No No No Yes Yes Yes

Example

{

"Response": {

"Requested": "SetStreamingServerSettingsSRT",

"Result": "Success"

}

3.1.19. Set Streaming Encode Protocol

Set Streaming Encode Protocol

This setting will not take effect until reboot.

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

SetStreamingEncodeProtocol

No No No No No

No No No No No Yes

SessionID

String

(Session ID in cookie.)

No No No No No

No No No No Yes

Params

Stream

Integer

0: First. 1: Second

No No No No No

No No No No No Yes

EncodeProtocol

String

"H264" / "H265" / "MJPEG"

No No No No No

No No No No No Yes

Example

'Request': {

"Command": "SetStreamingEncodeProtocol",

"SessionID": "7425bct58ee4d15d4c15ace4299a3",

"Params": {

"Stream": 0,

"EncodeProtocol": "H264"

}

Response Key

Response
Requested	String	SetStreamingEncodeProtocol	No No	No No	No No	No No	Yes
Result	String	(Result of command processing.)	No No	No No	No No	No No	Yes

Example

"Response": { "Requested": "SetStreamingEncodeProtocol", "Result": "Success"}

3.1.20. Set Streaming I Key Frame Interval

Set Streaming I Key Frame Interval

This setting will not take effect until reboot.

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

SetStreaming|KeyFrameInterval

No No No No No

No No No No No Yes

SessionID

String

(Session ID in cookie.)

No No No No No

No No No No Yes

Params

Stream

Integer

0: First. 1: Second

No No No No No

No No No No No Yes

Interval

Integer

Value of I Key Frame Interval "2" - "60"

No No No No No

No No No No No Yes

Example

"Request":{ "Command": "SetStreaming|KeyFrameInterval", "SessionID": "7425bcb58ee4015dd4c15ace4299a3", "Params": { "Stream": 0, "Interval": 30}}

Response Key

Response

Requested

String

SetStreaming|KeyFrameInterval

No No

Yes

Result

String

(Result of command processing.)

No No

Yes

Example

"Response": { "Requested": "SetStreaming|KeyFrameInterval", "Result": "Success"}

3.1.21. Get Video Settings

Get the Video settings

Request Key

Style Value

HM650 HM660 HMEx0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

GetVideoSettings

No No

Yes

SessionID

String

(Session ID in cookie.)

No No

Yes

Example

{

"Request": {

"Command": "GetVideoSettings",

"SessionID": "7425fbcb58ee4d15dd4c1f5ace4299a3"

}

Response Key

Response

Requested

String

GetVideoSettings

No No No No No No No No Yes

Result

String

(Result of command processing.)

No No No No No No No No Yes

Data

Output

String

"SDI" / "HDMI"

No No No No No No No No Yes

VideoFormat

String

"50Hz" / "60Hz" / "DialPriority"

No No No No No No No No Yes

EncodeLevel

String

"mainprofile" / "highprofile"

No No No No No No No No Yes

Example

"Response": { "Requested": "GetVideoSettings", "Result": "Success". "Date": { "Output": "HDMI", "VideoFormer": "DialPriority", "EncodedLevel": "mainprofile" } }

3.1.22. Set Video HDMI/SDI Output

Set Video HDMI/SDI Output.

This setting will not take effect until reboot.

Request Key

Style Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

SetVideoHdmSdiOutput

No No

No Yes

SessionID

String

(Session ID in cookie.)

No No

No Yes

Params

Output

String

"SDI" : "HDMI"

No No

No Yes

Example

"Request": {

"Command": "SerVideoHDMISolOutput".

"SessionID": "7425fbcb58ee4d15dd4c15ace4239a3",

"Params": {

"Output": "HDMI"

}

Response Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HG900

HC5x0

PZ400

Response

Requested

Siring

SetVideoHdmiSdlOutput

No No

Yes

Result

Sitting

(Result of command processing.)

No No

Yes

Example

"Response": { "Requested": "SelVideoHDMI5diOutput", "Result": "Success"}

3.1.23. Set Video Format

Set Video Format.

This setting will not take effect until reboot.

Request Key

Style Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

SetVideoFormat

No No

No Yes

SessionID

String

(Session ID in cookie.)

No No

No Yes

Params

VideoFormat

String

"50Hz" / "60Hz" / "DialPriority"

No No

No Yes

Example

"Request": {

"Command": "SerVideoFormat",

"SessionID": "7425fccb58ee4d15dd4c15ace4298a3",

"Params": {

"VideoFormer": "DialPriority^

}

Response Key

Response

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC05x0

PZ400

Requested

String

SetVideoFormat

No No

Yes

Result

String

(Result of command processing.)

No No

Yes

Example

"Response": { "Requested": "SerVideoFormat", "Result": "Success"}

3.1.24. Set Video Encode Level

Set Video Encode Level.

This setting will not take effect until reboot.

Request Key

Style Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

SetVideoEncodeLevel

No No

Yes

SessionID

String

(Session ID in cookie.)

No No

Yes

Params

EncodeLevel

String

"mainprofile" / "highprofile"

No No

Yes

Example

"Request": {

"Command": "ServVideoEncodeLevel",

"SessionID": "7425fccb58ee4d15dd4c15ace4298a3",

"Params": {

"EncodeLevel": "mainprofile"

}

Response Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HG900

HC5x0

PZ400

Response

Requested

Siring

SetVideoEncodeLevel

No No

Yes

Result

Sitting

(Result of command processing.)

No No

Yes

Example

"Response": { "Requested": "SelVideoEncodeLevel", "Result": "Success"}

3.1.25. Set Network ONVIF Settings

Set the Network ONVIF Settings

This setting will not take effect until reboot.

Request Key

Request

Command

String

SetNetworkOnwitSettings

No No No No No No No Yes

SessionID

String

(Session ID in cookie.)

No No No No No No No No Yes

Params

Status

Integer

0:OFF, 1:ON (Other settings are valid when this is ON.)

No No No No No No No No Yes

Auth

Integer

0:OFF, 1:ON

No No No No No No No No Yes

Example

"Request": {

"Command": "SetNetworkOnutSettings",

"SessionID": "7425bcb58ee4d15d04c15ace4299a3",

"Params": {

"Status": 0,

"Auth": 0

}

Response Key

Response
Requested	String	SetNetworkOnwifSettings	No No	No No	No No	No No	Yes
Result	String	(Result of command processing.)	No No	No No	No No	No No	Yes

Example

"Response": { "Requested": "SetNetworkOntifSettings", "Result": "Success"}

3.1.26. Set Network Multicast Settings

Set the Network Multicast Settings.

This setting will not take effect until reboot.

Request Key

Request

Command

String

SetNetworkMulticastSettings

No No No No No

Yes

SessionID

String

(Session ID in cookie.)

No No No No No

Yes

Params

Status

Integer

0:OFF, 1:ON (Other settings are valid when this is ON.)

No No No No No

Yes

DstAddress

String

(IP address)

No No No No No

Yes

DstPort

Integer

(Port number)

No No No No No

Yes

Example

"Request": {

"Command": "SetNetworkMulticastSettings",

"SessionID": "7425fbeb58eeAd15ddHc15ace4299a3",

"Params": {

"Status": 1,

"DstAddress": "224.1.2.3",

"DstPort": 6688

}

Response Key

Response

Requested

String

SetNetworkMulticastSettings

No No No No No No No Yes

Result

String

(Result of command processing.)

No No No No No No No No Yes

Example

"Response": { "Requested": "SetNetworkMulticastSettings". "Result": "Success"}

3.1.27. Set NDI Settings

Set the NDI Settings:

This setting will not take effect until reboot.

Request Key

Request

Command

String

SetNDISettings

No No

Yes

SessionID

String

(Session ID in cookie.)

No No

Yes

Params

DeviceName

String

(text)

No No

Yes

GroupName

String

(text)

No No

Yes

Example

"Request": {

"Command": "SetNDISettings",

"SessionID": "7425bcb58ee4d15dd4c15ace4299a3",

"Params": {

"DeviceName": "HD Camera",

"GroupName": "public"

}

Response Key

Response

Requested

String

SetNDISettings

No No

Yes

Result

String

(Result of command processing.)

No No

Yes

Example

{"Response": {"Requested": "SetNO!Settings", "Result": "Success"}}

3.2. System Command

Zixi and SRT streaming modes are mutually exclusive on GY-HC5x0 and GY-HC900.

Only "Zixi" or "Srt" parameter is effective according to the streaming mode.

Current mode can be checked using GetSystemInfo response.

3.2.1. Get System Information

System information acquisition

Request Key

Style Value

HM850

HM860

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

GetSystemInfo

Yes Yes

SessionID

String

{Session ID in cookie.}

Yes Yes

Response Key

Style

Value

HM650

HM660

HM6x0

HM200

HM25x

HM280

LS300

PZ100

HG900

HC5x0

PZ400

Response

Requested

String

GetSystemInfo

Yes Yes

Result

String

(Result of command processing)

Yes Yes

Data

Model

String

Model information

Yes Yes

Model

String

"UNKNOWN" / "HM650"(GY-HM650) / "HM850"(GY-HM850) / "HM890"(GY-HM890) / "HM200"(GY-HM200) / "LS300"(GY-LS300) / "HM250"(GY-HM250) / "HM258"(GY-HM258) / "HM280"(GY-HM280) / "HM660"(GY-HM660) / "PZ100"(KY-PZ100) / "PZ400"(KY-PZ400) / "PZ200"(KY-PZ200) / "HC500"(GY-HC500) / "HC550"(GY-HC550) / "HC900"(GY-HC900)

Yes Yes

Destination

String

Place of destination "JP"(Japan) / "US"(USA-Canada) / "KR"(Korea) / "EU"(Southern Europe,Central Europe) / "ER"(Russia) / "AC"(China) / "AA"(Australia) / "AG"(Asian) / "TW"(Taiwan) / "AS"(Saudi Arabia) / "UC"(Canada) / "UA"(Argentina) / "UB"(Brazil) / "EZ"(East Europe) / "EY"(Northern Europe) / "EK"(China) / "EF"(France) / "AH"(Hong Kong) / "UN"(Format SD,NTSC/PAL both format)

Yes Yes

ApiVersion

String

WebAPI Version "XX.YYY.ZZZ" (XX.Major ver. YYY.Minor ver. ZZZ.Development ver)

Yes Yes

Serial

String

Serial number "xxxxxxxx"

Yes Yes

No Yes

Yes Yes

Resolution

String

Resolution of recording format. "1920x1080" / "1440x1080" / "1280x720" / "720x480" / "720x576" / "640x360" / "480x270"

No No No No No No Yes Yes No

Overlay	String	Overlay option "On" / "Off"	No No No Yes Yes Yes No No Yes Yes No
Tagging	String	Tagging option "On" / "Off"	Yes Yes No No No No No Yes No
Zixi	String	Zixi option "On" / "Off"	No No No No No No No Yes Yes No
Srt	String	Srt option "On" / "Off"	No No No No No No Yes Yes Yes
KA_EN200	String	KA-EN200 option adaptor setting "On" / "Off"	No No No No No No Yes Yes No

Example Example(In case of PZ400)

{
    "Response": { "Response": {
    "Requested": "GetSystemInfo",
    "Result": "Success", "Result": "Success",
    "Data": { "Data": {
    "Model": "VM650", "Model": "FZ400",
    "Destination": "JP", "Destination": "JP",
    "ApiVersion": "0.13.0", "ApiVersion": "1.14.001",
    "Serial": "123A1234", "Serial": "123A1234",
    "Tagging": "Off", "Str": "On"
    }
    }
}

"Requested": "GetSystemInfo",

3.2.2. Session renewal

Renew a session

Updating session is needed within 25 seconds as always.

This command has become obsolete and session renewal is no longer required.

Please don't use this command because it causes malfunction on Web access.

Request Key
Style Value
HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

SessionRenewal

Yes No

No No

SessionID

String

(Session ID in cookie.)

Yes No

No No

Params

Update

Integer

0:False(Time-out immediately)1:True(Time-out extension)

Yes No

No No

Example

"Request": {

"Command": "SessionRenewal",

"SessionID": "7425fccb58ee4d15dd4c15ace429a3",

"Params": {

"Update": 1

}

Response Key
Style Value
HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC800 HC5x0 PZ400

Response

Requested

String

SessionRenewal

Yes No

No No

Result

String

(Result of command processing.)

Yes No

No No

{

"Response": {

"Requested": "SessionRenewal",

"Result": "Success"

}

3.2.3. Get preset zoom position

Acquire the preset zoom position.

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

GetPresetZoomPosition

Yes Yes

Yes No

No Yes

SessionID

String

(Session ID in cookie.)

Yes Yes

Yes No

No Yes

Example

{

"Request": {

"Command": "GetPresetZoomPosition".

"SessionID": "7425fbcb58ee4d15dd4c15ace4299a3"

}

Response Key

Style Value

HM850 HM660 HM8x0 HM200 HM25x HM260 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

GetPresetZoomPosition

Yes Yes

Yes No

No Yes

Result

String

(Result of command processing.)

Yes Yes

Yes No

No Yes

Data

Integer

Value of Preset "0" - "499",no-setting "-1"

Yes Yes

Yes No

No Yes

Integer

Value of Preset "0" - "499",no-setting "-1"

Yes Yes

Yes No

No Yes

Integer

Value of Preset "0" - "499",no-setting "-1"

Yes Yes

Yes No

No Yes

Example

"Response": {

"Requested": "GetPresetZoomPosition".

"Result": "Success".

"Date": {

'A': 10, 'B': 20, 'C': 30

}

3.2.4. Set preset zoom position

Preset the zoom position.

Request Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Request

Command

String

SetPresetZoomPosition

Yes Yes

No No Yes No

SessionID

String

{Session ID in cookie.}

Yes Yes

No No Yes No

Params

String

"A","B","C" is Preset ID

Yes Yes

No No Yes No

Position

Integer

Value of Preset "0" - "499", delete setting is "-1"

Yes Yes

No No Yes No

Example

{
    "Request": {
    "Command": "SetPresetZoomPosition",
    "SessionID": "7425fbcb58ee4d15ddHc15ace4299a3",
    "Params": {
    "ID": "A",
    "Position": 300
    }
    }
}

Response Key

Response

Requested

String

SetPresetZoomPosition

Yes Yes

Yes No

No No Yes No

Result

String

(Result of command processing.)

Yes Yes

Yes No

No No Yes No

Example

{
    "Response": {
    "Requested": "SetPresetZoomPosition",
    "Result": "Success"
    }
}

3.2.5. Set tally lamp priority

This command was moved to "3.7.3. Set tally lamp priority".

3.2.6. Get NTP Status

Acquire the status of NTP.

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request
Command	String	GetNTPStatus	No Yes	Yes Yes	Yes Yes	No Yes	Yes Yes	No
SessionID	String	(Session ID in cookie.)	No Yes	Yes Yes	Yes Yes	No Yes	Yes Yes	No

Example

"Request": {
"Command": "GetNTPStatus",
"SessionID": "7425f0cb58ce4d150d4c1f5aco4299a3"
/

Response Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HG5x0 PZ400

Response

Requested

String

GetNTPStatus

No Yes

Yes Yes

Yes Yes No

Result

String

(Result of command processing.)

No Yes

Yes Yes

Yes Yes No

Data

Address

String

(IP address)

No Yes

Yes Yes

Yes Yes No

ToSync

String

"On" / "Off"

No Yes

Yes Yes

Yes Yes No

Yes No

Status

String

"Syncronized" / "NotSyncronized" / "Master"

No Yes

Yes Yes

Yes Yes No

Example

"Response": {
"Requested": "GetNTPStatus",
"Result": "Success",
"Data": {
"Address": "192.168.0.100",
"TcSync": "On",
"Status": "Synchronized"
}
}

3.2.7. Set NTP Server

Set the NTP server address.

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request
Command	String	SetNTPServer	No Yes	Yes Yes	Yes Yes No Yes	Yes Yes No
SessionID	String	(Session ID in cookie.)	No Yes	Yes Yes	Yes Yes No Yes	Yes Yes No
Params
Address	String	(IP address)	No Yes	Yes Yes	Yes Yes No Yes	Yes Yes No

Example

{
    "Request": {
    "Command": "SetNTPServer",
    "SessionID": "7425f0cb58ee4d15dd4c15ace4299a3",
    "Params": {
    "Address": "192.168.0.100"
    }
    }
}

Response Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

SetNTPServer

No Yes

Yes Yes

No Yes

Yes Yes

Result

String

(Result of command processing.)

No Yes

Yes Yes

No Yes

Yes Yes

Example

{
    "Response": {
    "Requested": "SetNTPServer",
    "Result": "Success"
    }
}

3.2.8. Set NTP Settings

Set the NTP settings.

Request Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Request

Command

String

SetNTPSettings

No Yes

Yes Yes

No Yes

No No Yes

SessionID

String

(Session ID in cookie.)

No Yes

Yes Yes

No Yes

No No Yes

Params

TcSync

String

"On","Off"

No Yes

Yes Yes

No Yes

No No No

TimeSync

Integer

0:OFF, 1:ON (For PZ400:200, other Params is valid when this parameter is ON.)

No No No No No

No Yes

TimeZone

String

(Time Zone) "GMT-1100" - "GMT+1300"

No No No No No

No Yes

ServeAddress

String

(IP address)

No No No No No

No Yes

TimeInterval

Integer

Value of Time interval(min)

No No No No No

Yes

MainTimeShow

Status

Integer

0:OFF, 1:ON

No No No No No

Yes

XPosition

Integer

Value of X Position.

No No No No No

Yes

YPosition

Integer

Value of Y Position.

No No No No No

Yes

SubTimeShow

Status

Integer

0:OFF, 1:ON

No No No No No

Yes

XPosition

Integer

Value of X Position.

No No No No No

Yes

YPosition

Integer

Value of Y Position.

No No No No No

Yes

Example Example(In case of PZ400)

{
    "Request": { "Request": {
    "Command": "SetNTPSettings", "Command": "SetNTPSettings",
    "SessionID": "7425tbcb58cc4d15dd4c1f5aco4299a3",
    "Params": { "Params": {
    "TcSync": "On" "TimeSync": 1,
    }
    }
    "TimeInterval": 1440,
}

{
    "SessionID": "7425/bcb58oo4d15dd4c1f5aco4299a3",
    "TimeZone": "GMT:0900",
    "ServerAddress": "192.168.123.123",
    "MainTimeShow": {
    "Status": 1,
    "XPosition": 0,
    "YPosition": 0
    }
    "SubTimeShow": {
    "Status": 0,
    "XPosition": 0,
    "YPosition": 0
    }
    }
}

Response Key
Style Value
HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response
Requested	String	SetNTPSettings	No Yes	Yes Yes	Yes Yes	No Yes	No No Yes
Result	String	(Result of command processing.)	No Yes	Yes Yes	Yes Yes	No Yes	No No Yes

Example

{

"Response": {

"Requested": "SetNTPSettings",

"Result": "Success"

}

3.2.9. Get NTP Settings

Get NTP Settings.

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Send the Request to the System.

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request all status information of camera function.

It is recommended to use this command every 500 msec or above.

Unnecessary use of this command make performance degradation.

Request Key

Style

Value

HM650

HM660

HM6x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Request

Command

String

GetCamStatus

Yes Yes

SessionID

String

{Session ID in cookie.}

Yes Yes

Example

"Request": {

"Command": "GetCamStatus",

"SessionID": "7425tccb5Bee4d15dd4c15ace4299a3"

}

Response Key Style Value HM550 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

GetCamStatus

Yes Yes

Result

String

(Result of command processing.)

Yes Yes

Data

Yes Yes

Camera (Camera)

Yes Yes

Status

String

Status"NoCard"(no card inserted) / "Stop"(recording stop) / PZ400 always return "NoCard"."Standby"(record standby) / "Rec"(recording)/"RecPause"(recording pause)

Yes Yes

Mode

String

Mode"Camera"(record mode) /\("Thmubnail"(display thmubnail) / "Play"(play clip) /\("Review"(review clip) / "USB"(connect USB) /\("EditMetadata"(edit metadata)

Yes Yes

Yes No

RecMode

String

Rec mode"Normal" / "Pre" / "Clip" / "Frame" / "Interval" /\("Variable"

Yes Yes

No Yes

Yes No

String

recording time(sec)(32bit length)

Yes Yes

No Yes

Yes No

AspectRatio

String

Aspect ratio "16:9" / "4:9"

Yes Yes

No Yes

Yes No

WebAccess

String

Web access "Off" / "On"

Yes Yes

VideoOutputStatus

String

Video output status of camera "Off" / "On"

No No

Yes No

No Yes

MenuStatus

String

Menu Open status of camera "Off" / "On"

No Yes

Yes Yes

No Yes

Yes Yes

Yes

MenuOutput

String

"All" / "Web"

No No

Yes No

No No

FullAuto

Yes Yes

No Yes

Yes No

Status

String

Status "Off" / "On" / "Preset"

Yes Yes

No Yes

Yes No

Exposure

No No

Yes No

No Yes

	Status	String	Exposure "Auto" / "Manual" / "IrisPriority" / "ShutterPriority" "Bright"	No No No No No No Yes No No Yes
	Status	String		No No No No No No No Yes
Iris				Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
	Status	String	Mode "Manual" / "Auto" / "AutoAELock"	Yes Yes Yes Yes Yes Yes Yes Yes No Yes Yes No
	Status	String	"Auto" / "Manual"	No No No No No No Yes No No Yes
	Value	String	Character string for iris value	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
	Position	Integer	Iris position (0-255, for Slider button position)	No No No No No No Yes Yes No
Gain				Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
	Status	String	Mode "ManualL" / "ManualM" / "ManualH" / "Alc" or "AGC"(HC5x0) / "AlcAELock" / "Lolux" / "Variable"	Yes Yes Yes Yes Yes Yes Yes No Yes Yes Yes No
	Status	String	"Auto" / "Manual"	No No No No No No Yes No Yes
	Value	String	Character string for gain value	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
AeLevel				Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
	Status	String	Mode "AeOff" / "AeOn" / "AeOnFace"	Yes Yes Yes Yes Yes Yes Yes No Yes Yes No
	Adjust	String	AE Level adjustment "On" / "Off"	Yes Yes Yes Yes Yes Yes Yes No Yes Yes No
	Value	String	Character string for AE level value	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
Shutter				Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
	Status	String	Mode "Off" / "Manual" / "Step" / "Variable" / "Eal" / "EoiAELock"	Yes Yes Yes Yes Yes Yes Yes No Yes Yes No
	Status	String	"Auto" / "Manual"	No No No No No No Yes No No Yes
	Value	String	Character string for Shutter value	Yes Yes Yes Yes Yes Yes Yes Yes Yes
Whb				Yes Yes Yes Yes Yes Yes Yes Yes Yes
	Status	String	Mode "Preset" / "A" / "B" / "Faw" / "FawAELock"	Yes Yes Yes Yes Yes Yes Yes No Yes Yes
			"Faw" / "Awb" / "OnePush" / "3200K" / "5600K" / "Manual"	No No No No No No Yes No No
			"OnePush" / "Manual"	No No No No No No Yes No No Yes
			"Auto" / "Indoor" / "Outdoor"	No No No No No No Yes No No Yes
	Value	String	Character string for White Balance value	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
	WhPRScale	Integer	Slide bar total length for White paint Red(0-64). (*)	Yes Yes Yes Yes Yes Yes No Yes Yes
			Slide bar total length for White paint Red(0-255). (*)	No No No No No No Yes No No Yes
	WhPBScale	Integer	Slide bar total length for White paint Blue(0-64). (*)	Yes Yes Yes Yes Yes Yes Yes No Yes Yes
			Slide bar total length for White paint Blue(0-255). (*)	No No No No No No Yes No No Yes
	WhPRPosition	Integer	Slide bar current position for White paint Red(0-64). (*)	Yes Yes Yes Yes Yes Yes No Yes Yes
			Slide bar current position for White paint Red(0-255). (*)	No No No No No No Yes No Yes
	WhPBPosition	Integer	Slide bar current position for White paint Blue(0-64). (*)	Yes Yes Yes Yes Yes Yes No Yes Yes
			Slide bar current position for White paint Blue(0-255). (*)	No No No No No No Yes No Yes
	WhPRValue	String	Character string for White paint Red value	Yes Yes Yes Yes Yes Yes Yes Yes
	WhPBValue	String	Character string for White paint Blue value	Yes Yes Yes Yes Yes Yes Yes Yes
Bright				No No No No No No Yes No Yes
Bright	Value	String	Character string for Bright value	No No No No No No Yes No No Yes
Zoom				Yes Yes Yes Yes Yes Yes Yes Yes
	Dynamic	String	Dynamic Zoom Status "On" / "Off"	No No No Yes Yes Yes No No No
	DynamicPos	Integer	Dynamic Zoom Position(0-499)	No No No Yes Yes Yes No No No
	Position	Integer	Zoom position (0-499, for Slider button position)	Yes Yes Yes Yes Yes Yes Yes Yes Yes
	DisplayValue	String	Character string for Zoom value "Z0 - Z149" (GY-HM200/HM25x/HM280/LS300 F-number "0 - 9999mm")	Yes Yes Yes Yes Yes Yes Yes Yes
PanTilt				No No No No No No Yes No Yes
	SpeedWithZoom	String	Speed With Zoom Status "On" / "Off"	No No No No No No Yes
	PresetSpeed	Integer	PanTilt/Preset speed (1-30)	No No No No No No Yes
Focus				Yes Yes Yes Yes Yes Yes Yes Yes Yes
	Status	String	Mode "AFFace" / "AF" / "MFOnePush" / "MF" / "MFFace"	Yes Yes Yes Yes Yes Yes Yes No Yes
	Status	String	"Auto" / "Manual"	No No No No No No Yes

Value

String

Character string for Focus value

Yes Yes

MasterBlack

No Yes

Yes Yes

No No

Yes Yes

Value

String

Character string for MasterBlack value

No Yes

Yes Yes

No No

Yes Yes

Detail

No Yes

Yes Yes

No Yes

Yes Yes

Value

String

Character string for Detail value

No Yes

Yes Yes

No Yes

Yes Yes

Streaming

Yes Yes

Status

String

Status"Stop"(Streaming has stopped or cannot be started.)/"Stopping"(About to stop.)/"Start"(Streaming has started.)/"Starting"(About to start.)/"Waiting"(Waiting for connection. (for RTSP/RTP)..."Error"(Error occurred or waiting to start RTSP/RTP streaming and SRT Listener mode)

Yes Yes

YesNoYesNo

ReturnOverIP

No No

No Yes

Yes No

Status

String

Status"Stop"(Return over IP has stopped or cannot be started.)/"Stopping"(About to stop.)/"Start"(Return over IP has started.)/"Starting"(About to start.)/"Error"

No No

No Yes

Yes No

Dispty

Yes Yes

No Yes

Yes No

Status

String

Status "On" / "Off"

Yes Yes

No Yes

Yes Yes

Yes No

Yes Yes

CharacterMix

No No

Yes No

No No

No Yes

Yes No

Sci

String

Mix "On" / "Off"

No No

Yes No

No No

No Yes

Yes No

Hdmi

String

Mix "On" / "Off"

No No

Yes No

No No

No Yes

Yes No

Video

String

Mix "On" / "Off"

No No

Yes No

No No

No Yes

Yes No

TallyLamp

Yes Yes

Priority

String

Priority "Camera" / "Web"

Yes Yes

Yes No

Lighting

String

Lighting "On" / "Off"

Yes Yes

Studio Tally

String

Status "Off" / "Program" / "Preview"

No Yes

Yes Yes

No Yes

Yes Yes

SlotA

(Status of SlotA)

Yes Yes

No Yes

Yes No

Status

String

Status "Select" / "NoSelect" / "NoCard" / "SelectRec"/"NoSelectRec" / "Invalid" / "Unknown"

Yes Yes

No Yes

Yes No

Protect

String

Status "Unlock" / "Lock"

Yes Yes

No Yes

Yes No

Remain

String

Remaining amount time(minutes) (0-65535)

Yes Yes

No Yes

Yes No

ClipNum

Integer

Number of clips(0-4000)

Yes Yes

No Yes

Yes No

RemainWarning

Integer

Remaining amount warning(0=No warning*1=Warning)

Yes Yes

No Yes

Yes No

SlotB

(Status of SlotB)

Yes Yes

Status

String

Status "Select" / "NoSelect" / "NoCard" / "SelectRec"/"NoSelectRec" / "Invalid" / "Unknown"

Yes Yes

Protect

String

Status "Unlock" / "Lock"

Yes Yes

Yes No

Remain

String

Remaining amount time(minutes) (0-65535)

Yes Yes

Yes No

ClipNum

Integer

Number of clips(0-4000)

Yes Yes

Yes No

RemainWarning

Integer

Remaining amount warning(0=No warning*1=Warning)

Yes Yes

Yes No

SlotExt (Status of SlotExt)

No No

No Yes

Yes No

Status

String

Status "Select" / "NoSelect" / "NoCard" / "SelectRec"/"NoSelectRec" / "Invalid" / "Unknown"

No No

No Yes

Yes No

Protect

String

Status "Unlock" / "Lock"

No No

No Yes

Yes No

Remain

String

Remaining amount time(minutes) (0-65535)

No No

No Yes

Yes No

ClipNum

Integer

Number of clips(0-4000)

No No

No Yes

Yes No

RemainWarning

Integer

Remaining amount warning(0=No warning*1=Warning)

No No

No Yes

Yes No

Battery (Status of Battery)

Yes Yes

No Yes

Yes No

Info

String

Battery information display classification"Time"(minutes) / "Capacity"(%) / "Voltage"(V)

Yes Yes

No Yes

Yes No

Level

String

Battery Level

Yes Yes

No Yes

Yes No

0 : no battery / 1 : plug / 2 : plug[fl] / 3 : battery[?] /

Yes Yes

No Yes

Yes No

4 : battery[CAL] / 5 : battery[empty] / 6 : battery[low] /

Yes Yes

No Yes

Yes No

7 : battery[middle] / 8 : battery[full] /

Yes Yes

No Yes

Yes No

9 : battery[no segments] /

Yes Yes

No Yes

Yes No

10 : charging battery [empty] /

No Yes

Yes Yes

Yes No

Yes Yes

11 : charging battery [low] /

No Yes

Yes Yes

Yes No

Yes Yes

12 : charging battery [middle] /

No Yes

Yes Yes

Yes No

Yes Yes

13 : charging battery [full] /

No Yes

Yes Yes

Yes No

Yes Yes

14 : charging battery [no segments]

No Yes

Yes Yes

Yes No

Yes Yes

Value

String

Remaining amount time(minutes/ % / Voltage, 65535 is impossible get)(0-1000'10)

Yes Yes

No Yes

Yes No

Luminance

No No

No Yes

Value

Integer

Luminance value

No No

Yes

Saturation

No No

Yes

Value

Integer

Saturation value

No No

Yes

Contrast

No No

Yes

Value

Integer

Contrast value

No No

Yes

Sharpness

No No

Yes

Value

Integer

Sharpness value

No No

Yes

Hue

No No

Yes

Value

Integer

Hue value

No No

Yes

Flip

No No

Yes

Status

String

Status "On" / "Off"

No No

Yes

Mirror

No No

Yes

Status

String

Status "On" / "Off"

No No

Yes

Enable (Availability of function button switches)

Yes Yes

Fullauto (Fullauto function)

Yes Yes

No Yes

Yes No

Enable

Integer

switch 0:Disable, 1:Enable

No No

Yes Yes

Yes No

Yes Yes

Integer

button "ON" switch of fullauto 0:Disable, 1:Enable

Yes Yes

No Yes

Yes No

Off

Integer

button "OFF" switch of fullauto 0:Disable, 1:Enable

Yes Yes

No Yes

Yes No

Praset

Integer

button "PRESET" switch of fullauto 0:Disable, 1:Enable

No No

No Yes

No No

Exposure

(Exposure function)

No No

No Yes

No No

Yes

Enable

Integer

switch 0:Disable, 1:Enable

No No

Auto

Integer

button "Auto" switch of fullauto 0:Disable, 1:Enable

No No

No Yes

No No

Yes

Manual

Integer

button "Manual" switch of fullauto 0:Disable, 1:Enable

No No

No Yes

No No

Yes

ShutterPriority

Integer

button ShutterPriority" switch of fullauto0:Disable, 1:Enable

No No

No Yes

No No

Yes

IrisPriority

Integer

button "IrisPriority" switch of fullauto0:Disable, 1:Enable

No No

No Yes

No No

Yes

Bright

Integer

button "Bright" switch of exposure0:Disable, 1:Enable

No No

No Yes

Iris

(Iris function)

Yes Yes

Enable

Integer

switch 0:Disable, 1:Enable

No No

Yes Yes

StatusDisp

Integer

Display Value of iris 0:Disable, 1:Enable

No No

No Yes

Yes Yes

Manual

Integer

button "MANUAL" switch of iris 0:Disable, 1:Enable PZ400 always return 0. Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes YesYes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yesyes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No

Auto

Integer

button "AUTO" switch of iris 0:Disable, 1:Enable PZ400 always return 0. Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes YesYes Yes

Open1

Integer

button ">” switch of iris 0:Disable, 1:Enable

Yes Yes

Open2

Integer

button ">>" switch of iris 0:Disable, 1:Enable

Yes Yes

No Yes

Yes No

Open3

Integer

button >>>* switch of iris 0:Disable, 1:Enable

Yes Yes

No Yes

Yes No

Close1

Integer

button "<" switch of iris 0:Disable, 1:Enable

Yes Yes

Close2

Integer

button "<<" switch of iris 0:Disable, 1:Enable

Yes Yes

No Yes

Yes No

Close3

Integer

button "<<" switch of iris 0:Disable, 1:Enable

Yes Yes

No Yes

Yes No

PushAuto

Integer

button "Push Auto" switch of iris 0:Disable, 1:Enable

Yes Yes

No No Yes

Yes No

Gain (Gain function)

Yes Yes

Enable

Integer

switch 0:Disable, 1:Enable

No No

Yes Yes

Yes No

Yes Yes

StatusDisp

Integer

Display Value of gain 0:Disable, 1:Enable

No No

No Yes

Yes Yes

Yes No

Yes Yes

Manual

Integer

button "MANUAL" switch of gain 0:Disable, 1:Enable

PZ400 always return 0. Yes Yes No No No No Yes No No Yes

Auto

Integer

button "AUTO" switch of gain 0:Disable, 1:Enable

PZ400 always return 0. No No No No No No Yes No No Yes

Lolux

Integer

button "LOLUX" switch of gain 0:Disable, 1:Enable

Yes Yes

No Yes

Yes No

Variable

Integer

button "Variable" switch of gain 0:Disable, 1:Enable

No No

No Yes

Yes No

Integer

button "L" switch of gain 0:Disable, 1:Enable

Yes Yes

No Yes

Yes No

Integer

button "M" switch of gain 0:Disable, 1:Enable

Yes Yes

No Yes

Yes No

Integer

button "H" switch of gain 0:Disable, 1:Enable

Yes Yes

No Yes

Yes No

Up1

Integer

button "Up1" switch of gain 0:Disable, 1:Enable

No Yes

Yes Yes

Up2

Integer

button "Up2" switch of gain 0:Disable, 1:Enable

No No

No Yes

Yes No

Down1

Integer

button "Down1" switch of gain 0:Disable, 1:Enable

No Yes

Yes Yes

Down2

Integer

button "Down2" switch of gain 0:Disable, 1:Enable

No No

No Yes

Yes No

AeLevel (AE Level function)

Yes Yes

Enable

Integer

switch 0:Disable, 1:Enable

No No

Yes Yes

Yes No

Yes Yes

StatusDisp

Integer

Display Value of AELevel 0:Disable, 1:Enable

No No

No Yes

Yes Yes

Yes No

Yes Yes

Integer

button "▲" switch of AELevel 0:Disable, 1:Enable

Down

Integer

button "▼" switch of AELevel 0:Disable, 1:Enable

PZ400 always return 0. Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes YesYes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes YesYes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes YesYes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yesyes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes yesYes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes YesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesyesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYesYes

Yes Yes

Shutter (Shutter function)

Yes Yes

Enable

Integer

switch 0:Disable, 1:Enable

No No

Yes Yes

Yes No

Yes Yes

Yes No

StatusDisp

Integer

Display Value of Shutter 0:Disable, 1:Enable)

No No

No Yes

Yes Yes

Yes No

Yes Yes

Yes No

OII

Integer

button "OFF" switch of shatter 0:Disable, 1:Enable

Yes Yes

Yes No

No No

Manual

Integer

button "MANUAL" switch of shatter 0:Disable, 1:Enable

Yes Yes

No No

Step

Integer

button "STEP" switch of shatter 0:Disable, 1:Enable

No No

Yes Yes

Yes No

Yes Yes

Variable

Integer

button "VRIABLE" switch of shatter 0:Disable, 1:Enable

No No

Yes Yes

Yes No

Yes Yes

Eci

Integer

button "EEI" switch of shatter 0:Disable, 1:Enable

Yes Yes

Slower

Integer

button "▲" switch of shatter 0:Disable, 1:Enable

Yes Yes

Faster

Integer

button "▼" switch of shatter 0:Disable, 1:Enable

Yes Yes

Whb (White balance function)

Yes Yes

0:Disable, 1:Enable

Integer

button "A" switch of White balance 0:Disable, 1:Enable

Yes Yes

No Yes

Yes No

Integer

button "B" switch of White balance 0:Disable, 1:Enable

Yes Yes

No Yes

Yes No

Awb

Integer

button "AWB" switch of White balance 0:Disable, 1:Enable

No No

Yes No

PushAuto

Integer

button "OnePushTrigger" switch of White balance 0:Disable, 1:Enable

Yes Yes

K3200

Integer

button "3200K" switch of White balance 0:Disable, 1:Enable

No No

Yes No

K5600

Integer

button "5600K" switch of White balance 0:Disable, 1:Enable

No No

Yes No

WhPaintRP

Integer

button "I" switch of White paint 0:Disable, 1:Enable

Yes Yes

WhPaintRM

Integer

button "I" switch of White paint 0:Disable, 1:Enable

Yes Yes

WhPaintBP

Integer

button "--" switch of White paint 0:Disable, 1:Enable

Yes Yes

WhPaintBM

Integer

button "--" switch of White paint 0:Disable, 1:Enable

Yes Yes

Bright (Bright function)

No No

Yes

Enable

Integer

switch 0:Disable, 1:Enable

No No

StatusDisp

Integer

Display Value of Bright 0:Disable, 1:Enable

No No

Integer

button ">” switch of Bright 0:Disable, 1:Enable

No No

Yes

Down

Integer

button "<" switch of Bright 0:Disable, 1:Enable

No No

Yes

Zoom (Zoom function)

Yes Yes

Enable

Integer

switch 0:Disable, 1:Enable

No No

Yes Yes

StatusDisp

Integer

Display Value of Zoom 0:Disable, 1:Enable

No No

No Yes

Yes Yes

No Yes

Yes No

Tele1

Integer

button ">” switch of zoom 0:Disable, 1:Enable

Yes Yes

Tele2

Integer

button ">"" switch of zoom 0:Disable, 1:Enable

Yes Yes

Tele3

Integer

button ">"" switch of zoom 0:Disable, 1:Enable

Yes Yes

Wide1

Integer

button "<" switch of zoom 0:Disable, 1:Enable

Yes Yes

Wide2

Integer

button "<<" switch of zoom 0:Disable, 1:Enable

Yes Yes

Wide3

Integer

button "<<" switch of zoom 0:Disable, 1:Enable

Yes Yes

Tele

Integer

button "Tele" switch of zoom 0:Disable, 1:Enable

No No

Yes Yes

Yes No

Yes Yes

Wide

Integer

button "Wide" switch of zoom 0:Disable, 1:Enable

No No

Yes Yes

No Yes

Yes No

Preset

Integer

button "Preset" switch of zoom 0:Disable, 1:Enable

No No

Yes Yes

No Yes

Yes No

Clear

Integer

button "Clear" switch of zoom 0:Disable, 1:Enable

No No

Yes Yes

No Yes

Yes No

Preset1

Integer

button "A" switch of zoom 0:Disable, 1:Enable

No No

Yes Yes

No Yes

Preset2

Integer

button "B" switch of zoom 0:Disable, 1:Enable

No No

Yes Yes

No Yes

Preset3

Integer

button "C" switch of zoom 0:Disable, 1:Enable

No No

Yes Yes

No Yes

Focus

(Focus function)

Yes Yes

Enable

Integer

switch 0:Disable, 1:Enable

No No

Yes Yes

No Yes

Yes No

StatusDisp

Integer

Display Value of Focus 0:Disable, 1:Enable

No No

No Yes

Yes Yes

Manual

Integer

button "MANUAL" switch of focus 0:Disable, 1:Enable

Yes Yes

Auto

Integer

button "AUTO" switch of focus 0:Disable, 1:Enable

Yes Yes

Far1

Integer

button ">" switch of focus 0:Disable, 1:Enable

Yes Yes

Far2

Integer

button ">"" switch of focus 0:Disable, 1:Enable

Yes Yes

Far3

Integer

button ">"" switch of focus 0:Disable, 1:Enable

Yes Yes

Near1

Integer

button "<" switch of focus 0:Disable, 1:Enable

Yes Yes

Near2

Integer

button "<" switch of focus 0:Disable, 1:Enable

Yes Yes

Near3

Integer

button "<<" switch of focus 0:Disable, 1:Enable

Yes Yes

Infinity

Integer

button "∞" switch of focus 0:Disable, 1:Enable

Yes Yes

No No

PushAuto

Integer

button "PUSH AUTO" switch of focus 0:Disable, 1:Enable

Yes Yes

MasterBlack (MasterBlack function)

No Yes

Yes Yes

No No

Yes Yes

Enable

Integer

switch 0:Disable, 1:Enable

No No

Yes Yes

StatusDisp	Integer	Display Value of MasterBlack 0:Disable, 1:Enable	No No No No No Yes Yes No
Up1	Integer	button "-" switch of MasterBlack 0:Disable, 1:Enable	No Yes Yes Yes Yes Yes No No Yes Yes No
Up2	Integer	button "-" switch of MasterBlack 0:Disable, 1:Enable	No Yes Yes Yes Yes Yes No No Yes Yes No
Up3	Integer	button ">>> switch of MasterBlack 0:Disable, 1:Enable	No Yes Yes Yes Yes Yes No No Yes Yes No
Down1	Integer	button "-" switch of MasterBlack 0:Disable, 1:Enable	No Yes Yes Yes Yes Yes No No Yes Yes No
Down2	Integer	button "<<" switch of MasterBlack 0:Disable, 1:Enable	No Yes Yes Yes Yes Yes No No Yes Yes No
Down3	Integer	button "<<<" switch of MasterBlack 0:Disable, 1:Enable	No Yes Yes Yes Yes Yes No No Yes Yes No
Detail (Detail function)			No Yes Yes Yes Yes Yes No No Yes Yes No
Enable	Integer	switch 0:Disable, 1:Enable	No No No No No No No No No
StatusDisp	Integer	Display Value of Detail 0:Disable, 1:Enable	No No No No No No No No No
Up	Integer	button "-" switch of Detail 0:Disable, 1:Enable	No Yes Yes Yes Yes Yes No No Yes Yes No
Down	Integer	button "<" switch of Detail 0:Disable, 1:Enable	No Yes Yes Yes Yes Yes No No Yes Yes No
User (switch of user assignment)			Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
Sw0	Integer	button "SW0" switch of User Switch0:Disable, 1:Enable	No No No No No No No Yes No No
Sw1	Integer	button "SW1" switch of User Switch0:Disable, 1:Enable	Yes Yes Yes Yes Yes Yes Yes No Yes Yes No
Sw2	Integer	button "SW2" switch of User Switch0:Disable, 1:Enable	Yes Yes Yes Yes Yes Yes Yes No Yes Yes No
Sw3	Integer	button "SW3" switch of User Switch0:Disable, 1:Enable	Yes Yes Yes Yes Yes Yes No Yes Yes No
Sw4	Integer	button "SW4" switch of User Switch0:Disable, 1:Enable	Yes Yes Yes Yes Yes Yes No Yes Yes No
Sw5	Integer	button "SW5" switch of User Switch0:Disable, 1:Enable	Yes Yes Yes Yes Yes Yes No Yes Yes No
Sw6	Integer	button "SW6" switch of User Switch0:Disable, 1:Enable	Yes Yes Yes Yes Yes Yes No Yes Yes No
Sw7	Integer	button "SW7" switch of User Switch0:Disable, 1:Enable	Yes Yes Yes Yes Yes Yes No Yes Yes No
Sw8	Integer	button "SW8" switch of User Switch0:Disable, 1:Enable	No No Yes Yes Yes Yes No Yes Yes No
Sw9	Integer	button "SW9" switch of User Switch0:Disable, 1:Enable	No No Yes Yes Yes Yes No Yes Yes No
Sw10	Integer	button "SW10" switch of User Switch0:Disable, 1:Enable	No No Yes No No No Yes No No Yes No
Sw11	Integer	button "SW11" switch of User Switch0:Disable, 1:Enable	No No Yes No No No No No Yes No
Sw12	Integer	button "SW12" switch of User Switch0:Disable, 1:Enable	No No No No No No No No Yes No
Sw13	Integer	button "SW13" switch of User Switch0:Disable, 1:Enable	No No No No No No No No Yes No
LensRet	Integer	button "LensRet" switch of User Switch0:Disable, 1:Enable	No No Yes No No No No Yes No No
Sub1	Integer	button "Sub1" switch of User Switch0:Disable, 1:Enable	No No No No No No No Yes No No
Sub2	Integer	button "Sub2" switch of User Switch0:Disable, 1:Enable	No No No No No No No Yes No No
Sub3	Integer	button "Sub3" switch of User Switch0:Disable, 1:Enable	No No No No No No No Yes No No
VISw1	Integer	button "VISW1" switch of User Switch0:Disable, 1:Enable	No No No No No No No Yes No No
VISw2	Integer	button "VISW2" switch of User Switch	No No No No No No No Yes No No

0:Disable, 1:Enable

Streaming

(Streaming function)

Yes Yes

Enable

Integer

switch 0:Disable, 1:Enable

No No

No Yes

Yes No

StatusDisp

Integer

Display Value of Streaming 0:Disable, 1:Enable

No No

No Yes

Yes No

Integer

button "ON" switch of Streaming 0:Disable, 1:Enable

Yes Yes

Yes No

No No

No Yes

Yes Yes

Yes

Off

Integer

button "OFF" switch of Streaming 0:Disable, 1:Enable

Yes Yes

Yes No

No No

No Yes

Yes Yes

Yes

Disptv

(Display function)

Yes Yes

No No Yes

Integer

button "ON" switch of Display 0:Disable, 1:Enable

Yes Yes

No Yes

Yes Yes

No No Yes

Off

Integer

button "OFF" switch of Display 0:Disable, 1:Enable

Yes Yes

No Yes

Yes Yes

No No Yes

CharacterMix

(Character mix function)

No No

Yes No

No No

No Yes

Yes No

Sdi

Integer

button "SDI" switch of CharacterMix0:Disable, 1:Enable

No No

Yes No

No No

No Yes

Yes No

Hdmi

Integer

button "HDMI" switch of CharacterMix0:Disable, 1:Enable

No No

Yes No

No No

No Yes

Yes No

Video

Integer

button "Video" switch of CharacterMix0:Disable, 1:Enable

No No

Yes No

No No

No Yes

Yes No

Menu (Menu function)

Yes Yes

Display

Integer

button "DYSPLAY" switch of Menu 0:Disable, 1:Enable PZ400 always return 0. Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

Yes Yes

Status

Integer

button "STATUS" switch of Menu 0:Disable, 1:Enable PZ400 always return 0. Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

Yes Yes

Integer

button "MENU" switch of Menu 0:Disable, 1:Enable

Yes Yes

Set

Integer

button "SET" switch of Menu 0:Disable, 1:Enable

Yes Yes

Cancel

Integer

button "CANCEL" switch of Menu 0:Disable, 1:Enable

Yes Yes

Integer

button "I" switch of Menu 0:Disable, 1:Enable

Yes Yes

Down

Integer

button "I" switch of Menu 0:Disable, 1:Enable

Yes Yes

Left

Integer

button "--" switch of Menu 0:Disable, 1:Enable

Yes Yes

Right

Integer

button "--" switch of Menu 0:Disable, 1:Enable

Yes Yes

Luminance (Luminance function)

No No

No No Yes

No No

NoNo

No No

Yes

No No

NO No

No No

Yes

No No

	Enable	Integer	switch 0:Disable, 1:Enable	No No No No No No No No No No
	StatusDisp	Integer	Display Value of Flip 0:Disable, 1:Enable	No No No No No No No No No No
	Up	Integer	button "->" switch of Flip 0:Disable, 1:Enable	No No No No No No No No No Yes
	Down	Integer	button "<" switch of Flip 0:Disable, 1:Enable	No No No No No No No No No Yes
	Mirror (Mirror function)			No No No No No No No No No Yes
	Enable	Integer	switch 0:Disable, 1:Enable	No No No No No No No No No
	StatusDisp	Integer	Display Value of Mirror 0:Disable, 1:Enable	No No No No No No No No
	Up	Integer	button "->" switch of Mirror 0:Disable, 1:Enable	No No No No No No No No Yes
	Down	Integer	button "<" switch of Mirror 0:Disable, 1:Enable	No No No No No No No No Yes
ButtonString (String of button name)				Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
Gain (Button of gain)				Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
L		String	String of Low gain button	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
M		String	String of Middle gain button	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
H		String	String of High gain button	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
User (Button of user switch allocation)				Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
Sw0		String	String of User switch 0"Load Picture File" / "Clip Cutter Trig" / "Backup Trig" /"Clip Review" / "Zebra" / "Marker" / "Lolux" / "Bars"/"Focus Assist" / "OIS" / "AE Lock" / "OK Mark"/"Spot Meter" / "Face Detect" / "White Balance"/"Preset Zoom 1" / "Preset Zoom 2" / "Preset Zoom 3"/"LCD Backlight" / "Flash Band" / "One Push Focus"/"One Push Iris" / "Expanded Focus"/"Live Streaming" / "Auto Focus" / "Histogram"/"AWB" / "Rec" / "Return Video"	No No No No No No No Yes No No
Sw1		String	String of User switch 2. Same as above.	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
Sw2		String	String of User switch 2. Same as above.	Yes Yes Yes Yes Yes Yes Yes Yes Yes No Yes Yes No
Sw3		String	String of User switch 3. Same as above.	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
Sw4		String	String of User switch 4. Same as above.	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
Sw5		String	String of User switch 5. Same as above.	Yes Yes Yes Yes Yes Yes Yes Yes Yes No
Sw6		String	String of User switch 6. Same as above.	Yes Yes Yes Yes Yes Yes Yes Yes Yes No
Sw7		String	String of User switch 7. Same as above.	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
Sw8		String	String of User switch 8. Same as above.	No No Yes Yes Yes Yes Yes Yes Yes No
Sw9		String	String of User switch 9. Same as above.	No No Yes Yes Yes Yes Yes Yes No
Sw10		String	String of User switch 10. Same as above.	No No Yes Yes Yes Yes Yes Yes No
Sw11		String	String of User switch 11. Same as above.	No No Yes Yes Yes Yes Yes Yes No
Sw12		String	String of User switch 12. Same as above.	No No No No No No No No Yes No
Sw13		String	String of User switch 13. Same as above.	No No No No No No No No Yes No
LensRet		String	String of User switch Lens Ret. Same as above.	No No Yes No No No No No No No
VfSw1		String	String of User Viewfinder switch1 Same as above.	No No No No No No No No Yes No
VfSw2		String	String of User Viewfinder switch2 Same as above.	No No No No No No No Yes No No
Whb (Button of White balance)				Yes Yes Yes Yes Yes Yes Yes Yes Yes No
Preset		String	String of Preset button"PRESET" / "A" / "B" / "FAW"	No No Yes Yes Yes Yes Yes Yes No Yes Yes No
A		String	String of A button"PRESET" / "A" / "B" / "FAW"	No No Yes Yes Yes Yes Yes Yes Yes No
B		String	String of B button"PRESET" / "A" / "B" / "FAW"	No No Yes Yes Yes Yes Yes Yes Yes No

* 0-64 can be used for AWB mode and 0-255 for manual white balance mode on KY-PZ100.

Example

{
    "Response": {
    "Requested": "DefCamStatus",
    "Result": "Success",
    "Data": {
    "Camera": {
    "Status": "Standby", "Mode": "Camera", "RecMode": "Normal",
    "IC": "########", "AspectRatio": "16.9", "WebAccess": "On"
    },
    "Fullauto": {
    "Status": "Auto"
    },
    "Ins": {
    "Status": "Auto", "Value": "0"
    },
    "Gain": {
    "Status": "Aic", "Value": "0"
    },
    "AeLevel": {
    "Status": "AeOn", "Ajust": "On", "Value": "0"
    },
    "Shutter": {
    "Status": "Ear", "Value": "0"
    },
    "Who": {
    "Status": "Faw", "Value": "0",
    "WhPRScale": 0, "WhPBScale": 0,
    "WhPRPosition": 100, "WhPBPosition": 100,
    "WhPRValue": 100, "WhPBValue": 100
    },
    "Zoom": {
    "Dynamic": "Off", "DynamicPos": 0,
    "Position": 100, "DisplayValue": "Z100"
    },
    "Focus": {
    "Status": "AF", "Value": "0"
    },
    "Streaming": {
    "Status": "Stop"
    },
    "Display": {
    "Status": "Off"
    },
    "CharacterMix": {
    "Sol": "Off", "Normal": "Off", "Video": "Off"
    },
    "TallyLamp": {
    "Priority": "Camera", "Sw": "Off"
    },
    "SlotA": {
    "Status": "Select", "Protect": "Unlock", "Remain": "120", "ClipNum": 50,
    "RemainWarning": 0
    }
}

"Slot": {
"Status": "Select", "Protect", "Unlock", "Remain", "140", "ClipNum": 25, "RemainWarning": 0
},
"Battery": {
"Info": "Time", "Level": "8", "Value": "80"
},
"Enable": {
"FullAuto": {
"Status": 1, "On": 1, "Off": 1, "Prosel": 1
},
"Iris": {
"Status": 1, "StatusDisp": 1,
"Manual": 1, "Auto": 1, "Open1": 1, "Open2": 1, "Open3": 1,
"Close1": 1, "Close2": 1, "Close3": 1 "PushAuto": 1
},
"Gain": {
"Status": 1, "StatusDisp": 1,
"Manual": 1, "Age": 1, "Linux": 1, "Variable": 1, "L": 1, "M": 1, "H": 1,
"Up1": 1, "Up2": 1, "Down1": 1, "Down2": 1,
},
"AeLevel": {
"Status": 1, "StatusDisp": 1,
"AeLevelUp": 1, "AeLevelDown": 1, "AdjustOn": 1, "AdjustOff": 1
},
"Shutter": {
"Status": 1, "StatusDisp": 1,
"Off": 1, "Manual": 1, "Stop": 1, "Variable": 1, "Eo": 1,
"Slower": 1, "Faster": 1
},
"Who": {
"Status": 1, "StatusDisp": 1,
"Manual": 1, "Faw": 1, "Prosel": 1, "A": 1, "B": 1, "Adjust": 1,
"WhPaintBP": 1, "WhPaintRM": 1, "WhPaintBP": 1, "WhPaintSM": 1
},
"Zoom": {
"Status": 1, "StatusDisp": 1,
"Tele1": 1, "Tele2": 1, "Tele3": 1, "Wide1": 1, "Wide2": 1, "Wide3": 1,
"Tele": 1, "Wide": 1,

"Preset": 1, "Clear": 1, "Preset1": 1, "Preset2": 1, "Preset3": 1
},
"Focus": {
"Status": 1, "StatusDisp": 1,
"Manual": 1, "Auto": 1,
"Far1": 1, "Far2": 1, "Far3": 1, "Near1": 1, "Near2": 1, "Near3": 1,
"Infinity": 1, "PushAuto": 1
},
"User": {
"Sw1": 1, "Sw2": 1, "Sw3": 1, "Sw4": 1, "Sw5": 1, "SDw6": 1,
"Sw7": 1, "Sw8": 1, "Sw9": 1, "Sw10": 1, "Sw11": 1, "LensRef": 1
},
"Streaming": {
"On": 1, "Off": 1
},
"Display": {
"On": 1, "Off": 1
},
"CharacterMatrix": j
"Sci": 1, "Hdm": 1, "Video": 1
},
"Menu": {
"Display": 1, "Status": 1,
"Menu": 1, "Set": 1, "Cancel": 1,
"Up": 1, "Down": 1, "Left": 1, "Right": 1
}
},
"ButtonString": {
"Gain": {
"L": "0dB", M": "6dB", H": "12dB"
},
"User": {
"Sw1": "Focus Assist", "Sw2": "OIS", "Sw3": "Lofux", "Sw4": "AE Lock",
"Sw5": "Zebra", "Sw6": "Marker", "Sw7": "Chip Review", "Sw8": "Rec",
"Sw9": "AWB", "Sw10": "TC Preset", "Sw11": "OK Mark",
"LensRef": "Live Streaming"
},
"Whb": {
"Preset": "PRESET", "A": "A", "B": "B"
}
},
}

3.3.2. Recording

Control the recording function

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

SetCamCtrl

Yes Yes

Yes No

SessionID

String

(Session ID in cookie.)

Yes Yes

Yes No

Params

CamCtrl

String

Camera Control"Rec" recording start / "Stop" recording stop

Yes Yes

Yes No

Example

{
    "Request": {
    "Command": "SetCamCtrl",
    "SessionID": "7425fcb58ee4d15ddHc15ace4299a3",
    "Params": {
    "CamCtrl": "Rec"
    }
    }
}

Response Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LSS00 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

SetCamCtrl

Yes Yes

Yes No

Result

String

(Result of command processing.)

Yes Yes

Yes No

Example

{
    "Response": {
    "Requested": "SetCamCtrl",
    "Result": "Success"
    }
}

3.3.3. Set zoom position ( obey preset zoom settings of camera )

Control zoom position

In operation, obey preset zoom speed settings of camera,

If you use zooming with slide bar, you should use "SetWebSliderEvent" command.

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

SetZoomCtrl

Yes Yes

Yes No

Yes Yes

SessionID

String

(Session ID in cookie.)

Yes Yes

Yes No

Yes Yes

Params

Position

Integer

Zoom position "0"~'499"

Yes Yes

Yes No

Yes Yes

Example

"Request": {

"Command": "SetZoomCtrl",

"SessionID": "7425bcb58ee4d15dd4c15ace4298a3",

"Params": {

"Position": 400

}

Response Key

Response

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HG900

HG5x0

PZ400

Requested

Siting

SetZoomCtrl

(Result of command processing.)

Yes Yes

Yes No

Yes Yes

Result

Siting

Yes Yes

Yes No

Yes Yes

Example

"Response": { "Requested": "SeiZoomCtrl", "Result": "Success"}

3.3.4. Live streaming

Control the streaming function

After changing settings with API command, you should check the result of the command before start live streaming.

While menu or status screen is displayed on the camcorder, start/stop streaming command does not work.

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

SetStreamingCtrl

Yes Yes

SessionID

String

(Session ID in cookie.)

Yes Yes

Params

Streaming

String

Streaming Control"On":streaming start / "Off":streaming stop

Yes Yes

Example

"Request": {"Command": "SetStreamingCtrl", "SessionID": "7425fccb58ee4d15d04c1f5ace4298a3", "Params": {"Streaming": "On"}

Response Key

Response

Requested

String

SetStreamingCtrl

Yes Yes

Result

String

(Result of command processing.)

Yes Yes

Example

{"Response": {"Requested": "SetStreamingCtrl", "Result": "Success"}}

3.3.5. Tally lamp control

This command controls tally lamp

Turning on/off the tally lamp depends on camera settings. "3.7.2. Set tally lamp priority has the details.

'SetTallyLampCtrl' should be used only when changing the tally lamp state, otherwise it causes performance degradation.

Please do not use "SetTallyLampCtrl" in the studio tally system described in '3.7. How to control studio tally system".

From Web API version 1.07, alarm indication on the camera itself has highest priority compared with all other tally control via web interface.

Request Key
Style Value
HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

Siting

SetTallyLampCtrl

Yes Yes

SessionID

Siting

(Session ID in cookie.)

Yes Yes

Params

Siting

Tarry lamp Control"On"(The order turns on LED) /"Off"(The order turns off LED) /

Yes Yes

Example

"Request": {

"Command": "SetTallyLampCtrl",

"SessionID": "7425fbcb58ee4d15dd4c15ace4299a3",

"Params": {

"Sw": "On"

}

Response Key
Style Value
HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response
Requested	Soring SelTallyLampCtrl	Yes Yes	Yes Yes	Yes Yes	Yes Yes	Yes Yes	Yes Yes
Result	Soring (Result of command processing.)	Yes Yes	Yes Yes	Yes Yes	Yes Yes	Yes Yes	Yes Yes

Example

{

"Response": {

"Requested": "SerTallyLampCtrl",

"Result": "Success"

}

3.3.6. Set Web Button Event

Issue a button event

Request Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Request

Command

String

SetWebButtonEvent

Yes Yes

SessionID

String

(Session ID in cookie.)

Yes Yes

Params (Button parameter is selected by Kind parameter)

Kind

String

Kind of button event

"Fullauto"

Yes Yes

No Yes

Yes No

"Iris"

Yes Yes

"Gain"

Yes Yes

"AeLevel"

Yes Yes

Yes No

"Shutter"

Yes Yes

"Whb"

Yes Yes

"Zoom"

Yes Yes

"Focus"

Yes Yes

"User"

Yes Yes

Yes No

"Disptv"

Yes Yes

Yes No

"Menu"

Yes Yes

"Rec"

Yes Yes

Yes No

"MasterBlack"

No Yes

Yes Yes

No No

Yes Yes

"Detail"

No Yes

Yes Yes

No Yes

Yes Yes

"Exposure"

No No No

No No Yes

"SpeedWithZoom"

No No No

No No Yes

"Bright"

No No No

No No Yes

"Luminance"

No No No

No No Yes

"Saturation"

No No No

No No Yes

"Contrast"

No No No

No No Yes

"Sharpness"

No No No

No No Yes

"Hue"

No No No

No No Yes

"Flip"

No No No

No No Yes

"Mirror"

No No No

No No Yes

Button

String

Fullauto event

"On" / "Oli"

Yes Yes

No Yes

Yes No

"Preset"

No No No

No Yes

No No No

Exposure event

"Auto" / "Manual" / "IrisPriority" (AAE on PZ400) / "ShutterPriority" (SAE on PZ400) / "Bright" (only PZ400)

No No No

No No Yes

Iris event

"Manual" / "Auto"

Yes Yes

No Yes

Yes No

"Open1"

Yes Yes

"Open2"

Yes Yes

Yes No

"Open3"

Yes Yes

Yes No

"Close1"

Yes Yes

"Close2"

Yes Yes

No Yes

Yes No

"Close3"

Yes Yes

No Yes

Yes No

"PushAuto"

Yes Yes

No No Yes

Gain event

"Alc"

Yes Yes

No No

No No No

No No

"Lolux"

Yes Yes

No Yes

Yes No

"L" / "M" / "H"

Yes Yes

No Yes

Yes No

"Variable"	No No No No No Yes No No No No
"Up1"	No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
"Up2"	No No No No No Yes No No No No
"Down1"	No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
"Down2"	No No No No No Yes No No No No
"Manual" / "Auto"	No No No No No No No No No No
AeLevel event
"AeLevelUp" / "AeLevelDown"	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
"AdjustOn" / "AdjustOff"	No No No Yes Yes Yes Yes Yes Yes Yes No
"Up" / "Down"	No No No No No No Yes Yes No No
Shutter event
"Off"	Yes Yes Yes No No No No No No
"Step"	No No Yes Yes Yes Yes Yes Yes Yes No
"Variable"	No No Yes Yes Yes Yes Yes Yes Yes Yes No
"Manual"	Yes Yes No No No No No No No
"Eei"	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
"Slower"	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
"Faster"	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
Whb event
"Faw"	Yes Yes No No No No No Yes No No
"Presel" / "A" / "B"	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
"Adjust" (Awb trigger when PZ100. OnePush trigger when PZ400)	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
"WhPaintRP" / "WhPaintRM"	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
"WhPaintBP" / "WhPaintBM"	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
"Awb"	No No No No No No Yes No No
"3200K"	No No No No No No Yes No No
"5600K"	No No No No No No Yes No No
"Manual"	No No No No No No Yes No No Yes
"Auto"	No No No No No No No No Yes
"Indoor"	No No No No No No No No Yes
"Outdoor"	No No No No No No No No Yes
"OnePush"	No No No No No No No No Yes
Zoom event
"Tele1" / "Tele2" / "Tele3"	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
"Wide1" / "Wide2" / "Wide3"	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
"Stop"※"Tele" or "Wide" events need "Stop" in KY-PZ100 / PZ400 / PZ200.	No No No No No No No Yes No No Yes
Focus event
"Manual" / "Auto"	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
"Far1" / "Far2" / "Far3" / "Near1" / "Near2" / "Near3"	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
"Infinity"	Yes Yes No No No No No No No No
"PushAuto"	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
"Stop"※"Far" or "Near" events need "Stop" in KY-PZ100.	No No No No No No No Yes No No Yes
MasterBlack event
"Up1" / "Up2" / "Up3" / "Down1" / "Down2" / "Down3"	No Yes Yes Yes Yes Yes No No Yes Yes No
User event
"Sw0"	No No Yes No No No No No Yes No
"Sw1" / "Sw2" / "Sw3" / "Sw4" / "Sw5" / "Sw6" / "Sw7"	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
"Sw8"	No No Yes Yes Yes Yes Yes Yes Yes Yes
"Sw9"	No No Yes Yes Yes Yes Yes Yes No Yes
"Sw10"	No No Yes No No No Yes No No Yes

	"Sw11"	No No Yes No No No No No Yes No
	"Sw12" / "Sw13"	No No No No No No No No Yes No
	"LensRet"	No No Yes No No No No Yes No No
	"Sub1" / "Sub2" / "Sub3"	No No No No No No Yes No No No
	"VfSw1" / "VfSw2"	No No No No No No No Yes No No
	Disptv event
	"On":(Display on TV) / "Off":(Display on TV)	Yes Yes No Yes Yes Yes Yes No No No
	"Sci":(Character Mix)	No No Yes No No No No Yes Yes No
	"HdmI":(Character Mix)	No No Yes No No No Yes Yes No
	"Video":(Character Mix)	No No Yes No No No Yes Yes No
	Menu event
	"Display":(Menu) / "Status":(Menu) /	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
	"Menu":(Menu) / "Cancel":(Menu) / "Sel":(Menu) /	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
	"Up":(Menu) / "Down":(Menu) / "Left":(Menu) / "Right":(Menu)	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
	※ "Up", "Down", "Left", and "Right" events call assigned function when menu is closed.	No No No No No No No Yes Yes No
	Rec event
	"Start":Recording start / "Stop":Recording stop	Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
	Detail event "Up" / "Down"	No Yes Yes Yes Yes Yes Yes Yes Yes Yes No
	SpeedWithZoom event "Off" / "On"	No No No No No No Yes No No Yes
	Bright event
	"Up" / "Down"	No No No No No No No No No Yes
	Luminance event
	"Up" / "Down"	No No No No No No No No No Yes
	Saturation event
	"Up" / "Down"	No No No No No No No No No Yes
	Contrast event
	"Up" / "Down"	No No No No No No No No No Yes
	Sharpness event
	"Up" / "Down"	No No No No No No No No No Yes
	Hue event
	"Up" / "Down"	No No No No No No No No No Yes
	Flip event
	"On" / "Off"	No No No No No No No No No Yes
	Mirror event
	"On" / "Off"	No No No No No No No No No Yes

Example

"Request": {

"Command": "SetWebButtonEvent",

"SessionID": "7425bcb58ee4d15dd4c15ace4239ad",

"Params": {

"Kind": "Fulauto",

"Button": "On"

}

Response Key

Response

Requested

String

SetWebButtonEvent

Yes Yes

Result

String

(Result of command processing.)

Yes Yes

Example

{
    "Response": {
    "Requested": "SetWebButtonEvent",
    "Result": "Success"
    }
}

3.3.7. Set Web Slider Event

Issue a slider event

You should use 'SetWebSliderEvent' command instead of 'SetZoomCtrl' for zooming with slide bar. You get maximum speed of zoom.

Request Key

Style Value

HM650

HM660

HMEx0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

SetWebSliderEvent

Yes Yes

SessionID

String

(Session ID in cookie.)

Yes Yes

Params

Kind

String

Kind of Slider event

* ZoomBar "

Yes Yes

Yes No

Yes Yes

* IrisBar *

No No

Yes Yes

Position

Integer

Slider event

ZoomBar 0~499:Zoom position

Yes Yes

Yes No

Yes Yes

IrisBar 0~255:Iris position

No No

Yes Yes

Example

"Request": {"Command": "SetWebSliderEvent", "SessionID": "7425fcbc58ee4d15dd4c15ace4299a3", "Params": {"Kind": "ZoomBar", "Position": 73}}

Response Key

Type

Style

Value

HM650

HM660

HM6x0

HM200

HM25x

HM260

LS300

PZ100

HC900

HC5x0

PZ400

Response

Requested

String

SetWebSliderEvent

Yes Yes

Result

String

(Result of command processing.)

Yes Yes

Example

{"Response": {"Requested": "SetWebSliderEvent", "Result": "Success"}}

3.3.8. Set Web XYField Event

Issue a two-dimensional slider event

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC05x0 PZ400

Request

Command

String

SetWebXYFieldEvent

Yes Yes

SessionID

String

(Session ID in cookie.)

Yes Yes

Params

Kind

String

Kind of XYField event*WhPaintRB "White paint R and B

Yes Yes

XPosition

Integer

XYField eventWhPaintRB "0"~"64" (White paint B position) (PZ400: Max value of Whb Auto is 20, Whb manual is 255)

Yes Yes

YPosition

Integer

XYField eventWhPaintRB "0"~"64" (White paint R position) (PZ400: Max value of Whb Auto is 20, Whb manual is 255)

Yes Yes

Example

"Request":

"Command": "SelWebXYFieldEvent",

"SessionID": "7425bcb5fee4d15d4c15ace4298a3",

"Params": {

"Kind": "WhPaintRB",

"XPosition": 32,

"YPosition": 32

}

Response Key

Style

Value

HM650

HM660

HM6x0

HM200

HM25x

HM260

LS300

PZ100

HC900

HC5x0

PZ400

Response

Requested

String

SetWebXYFieldEvent

Yes Yes

Result

String

(Result of command processing.)

Yes Yes

Example

"Response": { "Requested": 'SetWebXYFieldEvent', "Result": "Success" }

3.3.9. Get GPS Information

Request location information of camera GPS function.

Request Key
Style Value
HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

GetGPSInfo

Yes Yes

Yes No

No No

No Yes

Yes No

SessionID

String

(Session ID in cookie.)

Yes Yes

Yes No

No No

No Yes

Yes No

Example

"Request": {

"Command": "GetGPSInfo",

"SessionID": "7425fccb58ee4d15do4c15ace4299a3"

}

Response Key
Style Value
HM850 HM660 HM8x0 HM200 HM25x HM260 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

GetGPSInfo

Yes Yes

Yes No

No No

Yes Yes No

Result

String

(Result of command processing.)

Yes Yes

Yes No

No No

Yes Yes No

Data

AntennaLevel

String

"None" / "Lost" / "Searching" / "Level1" / "Level2" / "Level3"

Yes Yes

Yes No

No No

Yes Yes No

Location

String

"+-""+/-""Latitude + North, - South,00.00000(min) - 90.000000(max)Longitude + East, - West,000.000000(min) - 179.999999(max)Altitude +, - ,0.000000(min) - 99999999(max)

Yes Yes

Yes No

No No

Yes Yes No

*Location data is valid only if AntennaLevel is "Level1", "Level2", or "Level3".

Example

{

"Response": {

"Requested": "GetGPSInfo",

"Result": "Success",

"Data": {

"Antennal elevation": "Level3",

"Location": "+35.360452+138.727820+3775.630"

}

3.3.10. Seesaw switch operation

Seesaw switch operation command is changing parameter by a seesaw-switch

Request Key

Style

Value

HM650

HM660

HM850

HM200

HM25x

HM280

LS300

PZ100

HC900

HC05x0

PZ400

Request

Command

String

SeesawSwitchOperation

No Yes

Yes Yes

No No

Yes Yes

SessionID

String

(Session ID in cookie.)

No Yes

Yes Yes

No No

Yes Yes

Params

Kind

String

Kind of Seesaw event"ZoomSeesaw" / "IrisSeesaw" / "MasterBlackSeesaw" / "FocusSeesaw"

No Yes

Yes Yes

No No

Yes Yes

Direction

String

Zoom operation"Stop" / "Wide" / "Tolo"Iris operation"Open" / "Close" / "Stop"MasterBlack operation"Up" / "Down" / "Stop"Focus operation"Far" / "Near" / "Stop"

No Yes

Yes Yes

No No

Yes Yes

Speed

Integer

0 - 8

No Yes

Yes Yes

No No

Yes Yes

**Speed - 0* has the same meaning as "Direction - Stop".

Example

{
    "Request": {
    "Command": "SeesawSwitchOperation",
    "SessionID": "7425fcbc58ee4d15dd4c15ace4299a3",
    "Params": {
    "Kind": "MasterBlack",
    "Direction": "Up",
    "Speed": 5
    }
}

Response

Key

Style

Value

HM550

HM660

HM850

HM200

HM25x

HM280

LS300

PZ100

HC300

HC550

PZ400

Response

Requested

String

SeesawSwitchOperation

No Yes

Yes Yes

No No

Yes Yes

Result

String

(Result of command processing)

No Yes

Yes Yes

No No

Yes Yes

Example

"Response": / "Requested": "SeesawSwitchOperation", "Result": "Success"}

3.4. PTZ Camera Support Command

3.4.1. Set Pan Tilt Control

Pan / Tilt control command with direct position parameters.

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

SetPTCtrl

No No No No No Yes No No Yes

SessionID

String

(Session ID in cookie.)

No No No No No Yes No No Yes

Params

PanDirection

String

"Stop" / "Left" / "Right" / "Home" / "Position"

No No No No No Yes No No Yes

PanPosition

Integer

0(Back left limit)- 17540(Front)- 35080(Back right limit)PanPosition is valid when "PanDirection" is "Position".

No No No No No Yes No No Yes

PanSpeed

Integer

0 - 30

No No No No No Yes No No Yes

TiltDirection

String

"Stop" / "Up" / "Down" / "Home" / "Position"

No No No No No Yes No No Yes

TiltPosition

Integer

0(Just above)- 9040(Just beside)- 12030(Diagonally downward)"TiltPosition" is valid when "TiltDirection" is "Position".

No No No No No Yes No No Yes

TiltSpeed

Integer

0 - 30

No No No No No Yes No No Yes

**Speed = 0* has the same meaning as *Direction = Stop*.

Example

{
    "Request": {
    "Command": "SetPTCm",
    "SessionID": "7425f0cb58ee1d15dd4c15ace4290a3",
    "Params": {
    "PanDirection": "Left",
    "PanPosition": 32768
    "PanSpeed": 10
    "TiltDirection": "Up",
    "TiltPosition": 32768
    "TiltSpeed": 10
    }
    }
}

Response Key
Style Value
HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response
Requested	String	SetPTCtrl	No No No No No	No No Yes No No Yes
Result	String	(Result of command processing.)	No No No No No	No No Yes No No Yes

Example

{

"Response": {

"Requested": "SetPTCtrl",

"Result": "Success"

}

3.4.2. Joystick Operation

Joystick operation command with direction and speed parameters.

For PTZ cameras, it should function as a cursor movement while the MENU is displayed.

Request Key

Style Value

HM650

HM660

HMEx0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

JoyStickOperation

No No

Yes

No Yes

SessionID

String

(Session ID in cookie.)

No No

Yes

No Yes

Params

PanDirection

String

"Stop" / "Left" / "Right"

No No

Yes

No Yes

PanSpeed

Integer

0 - 30

No No

Yes

No Yes

TiltDirection

String

"Stop" / "Up" / "Down"

No No

Yes

No Yes

TiltSpeed

Integer

0 - 30

No No

Yes

No Yes

**Speed = 0* has the same meaning as "Direction = Stop".

Example

{

"Request": {

"Command": "JoyStickOperation",

"SessionID": "7425fbcb58ee4d15dd4c15ace4299a3",

"Params": {

"PanDirection": "Left",

"PanSpeed": 10

"TiltDirection": "Up",

"TiltSpeed": 10

}

Response Key

Response
Requested	String	JoyStickOperation	No No No No No Yes No No Yes
Result	String	(Result of command processing.)	No No No No No Yes No No Yes

Example

{

"Response": {

"Requested": "JoyStickOperation",

"Result": "Success"

}

3.4.3. Zoom switch operation

Zoom switch operation command is changing zoom by a seesaw-switch.

Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HG900

HG5x0

PZ400

Request

Command

String

ZoomSwitchOperation

No Yes

Yes Yes

No Yes

Yes Yes

SessionID

String

{Session ID in cookie.}

No Yes

Yes Yes

No Yes

Yes Yes

Params

Direction

String

"Stop" / "Wide" / "Tele"

No Yes

Yes Yes

No Yes

Yes Yes

Speed

Integral

0 - 8

No Yes

Yes Yes

No Yes

Yes Yes

**Speed = 0* has the same meaning as 'Direction = Stop'.

Example

{
    "Request": {
    "Command": "ZoomSwitchOperation",
    "SessionID": "7425fccb58ee4d15dd4c15ace4298a3",
    "Params": {
    "Direction": "Wide",
    "Speed": 5
    }
    }
}

Response

Key

Style

Value

HM650

HM660

HM850

HM200

HM25x

HM280

LS300

PZ100

HC300

HC550

PZ400

Response

Requested

String

ZoomSwitchOperation

No Yes

Yes Yes

No Yes

Yes Yes

Result

String

(Result of command processing.)

No Yes

Yes Yes

No Yes

Yes Yes

Example

{
    "Response": {
    "Requested": "ZoomSwitchOperation",
    "Result": "Success"
    }
}

3.4.4. Set Pan / Tilt / Zoom preset

Control pan / tilt / zoom preset position.

Request Key

Style Value

HM650 HM660 HM850 HM200 HM25x HM280 LS300 PZ100 HC900 HC05x0 PZ400

Request

Command

String

SetPTZPreset

No No No No No

No No Yes No Yes

SessionID

String

(Session ID in cookie.)

No No No No No

No No Yes No Yes

Params

Integer

1 - 100(Number of preset position) / 1 - 255(Number of preset position in case of PZ400)

No No No No No

No No Yes No Yes

Operation

String

"Move"(Move to preset position)"Set" (Current position is stored)"Delete"(Delete the preset position)

No No No No No

No No Yes No Yes

Example

{
    "Request": {
    "Command": "SetPTZPreset",
    "SessionID": "7425bcb58ee4d15d04c15ace4299a3",
    "Params": {
    "No": 90,
    "Operation": "Move"
    }
    }
}

Response Key

Response

Requested

String

SetPTZPreset

No No

Yes No

No Yes

Result

String

(Result of command processing.)

No No

Yes No

No Yes

Example

{
    "Response": {
    "Requested": "SetPTZPreser",
    "Result": "Success"
    }
}

3.4.5. Get camera status (for remote controller)

Request minimum status information of camera function for RM-LP100 and other remote controllers.

It is recommended to use this command every 500 msec or above.

Unnecessary use of this command make performance degradation.

Request Key

Stylo Value

HM600 HM600 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

GetCamStatusMinimum

No No

Yes

No No

Yes

SessionID

String

((Session ID in cookie.)

No No

Yes

No No

Yes

Example

"Request": { "Command": "GetCamStatusMinimum", "SessionID": "7425fbcb58ee4d15dd4c15ace4299a3" }

Response Key

Style

Value

HM650

HM660

HM6x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Response

Requested

String

GetCamStatusMinimum

No No

Yes

Result

String

(Result of command processing.)

No No

Yes

Data

Camera (Camera)

Status

String

Status"NoCard"(no card inserted) / "Stop"(recording stop) / "Standby"(record standby) / "Rec"(recording)/"RecPause"(recording pause)

No No

Yes

VideoOutputStatus

String

"On" / "Off"

No No

Yes

MenuStatus

String

"On" / "Off"

No No

Yes

Exposure

Status

String

"Auto" / "Manual" / "IrisPriority" / "ShutterPriority""Bright"

No No

Yes

Iris

Status

String

"Auto" / "Manual"

No No

Yes

Value

String

Character string for iris value

No No

Yes

Shutter

Status

String

"Auto" / "Manual"

No No

Yes

Value

String

Character string for Shutter value

No No

Yes

Gain

Status

String

"Auto" / "Manual"

No No

Yes

Value

String

Character string for gain value

No No

Yes

AeLevel

Status

String

"AeOff" / "AeOn"

No No

Yes

Value

String

Character string for AE level value

No No

Yes

Whb

Status

String

"Faw" / OnePush" / "3200K" / "5600K" / "Manual"

No No No No No

No No Yes No No

"OnePush" / "Manual" / "Auto" / "Indoor" / "Outdoor"

No No No No No

No No No No

Yes

Value

String

Character string for White Balance value

No No No No No

No No Yes No No

Yes

WhPRScale

Integer

Slide bar total length for White paint Red(0-255)

No No No No No

No No Yes No

Yes

WhPBScale

Integer

Slide bar total length for White paint Blue(0-255)

No No No No No

No No Yes No

Yes

WhPRPosition

Integer

Slide bar current position for White paint Red(0-255)

No No No No No

No No Yes No

Yes

WhPBPosition

Integer

Slide bar current position for White paint Blue(0-255)

No No No No No

No No Yes No

Yes

WhPRValue

String

Character string for White paint Red value

No No No No No

No No Yes No

Yes

WhPBValue

String

Character string for White paint Blue value

No No No No No

No No Yes No

Yes

Focus

Status

String

"Auto" / "Manual"

No No No No No

No No Yes No

Yes

Value

String

Character string for Focus value

No No No No No

No No Yes No

Yes

Zoom

Position

Integer

Zoom position (0-499)

No No No No No

No No Yes No

Yes

Detail

Value

String

Character string for detail value

No No No No No

No No Yes No

Bright

Value

String

Character string for Bright value

No No No No No

No No Yes No

Yes

Streaming

Status

String

Status"Stop"(Streaming has stopped or cannot be started.)/"Stopping"(About to stop.)/"Start"(Streaming has started.)/"Starting"(About to start.)/"Waiting"(Waiting for connection. (for RTSP/RTP))/-"Error"(Error occurred or waiting to start RTSP/RTP streaming and SRT Listener mode)

No No No No No

No No Yes No

Yes

YesNoYesNoNo

TallyLamp

Priority

String

Priority "Camera" / "Web"

No No No No No

No No Yes No

Lighting

String

Lighting "On" / "Off"

No No No No No

No No Yes No

Yes

StudioTally

String

Status "Off" / "Program" / "Preview"

No No No No No

No No Yes No

Yes

Enable (Availability of function button switches)

Exposure

(Exposure function)

Auto

Integerbutton "Auto" switch of exposure 0:Disable, 1:Enable

No No No No No

No No Yes No

Yes

Manual

Integerbutton "Manual" switch of exposure 0:Disable, 1:Enable

No No No No No

No No Yes No

Yes

ShutterPriority

Integerbutton ShutterPriority" switch of exposure0:Disable, 1:Enable

No No No No No

No No Yes No

Yes

IrisPriority

Integerbutton "IrisPriority" switch of exposure0:Disable, 1:Enable

No No No No No

No No Yes No

Yes

Bright

Integerbutton "Bright" switch of exposure0:Disable, 1:Enable

No No No No No

No No Yes No

Yes

Iris

(Iris function)

Open1

Integerbutton "-" switch of iris 0:Disable, 1:Enable

No No No No No

No No Yes No

Yes

Close1

Integerbutton "-" switch of iris 0:Disable, 1:Enable

No No No No No

No No Yes No

Yes

Gain (Gain function)

Auto

IntegerDisplay Value of gain 0:Disable, 1:Enable PZ400 always return 0. No No No No No No Yes No No Yes

Manual

Integerbutton "MANUAL" switch of gain 0:Disable, 1:Enable PZ400 always return 0. No No No No No No Yes No No Yes

Up1

Integerbutton "Up1" switch of gain 0:Disable, 1:Enable

No No No No No

No No Yes No

Yes

Down1

Integerbutton "Down1" switch of gain 0:Disable, 1:Enable

No No No No No

No No Yes No

Yes

AeLevel (AE Level function)

Integer

button "▲" switch of AElevel 0:Disable, 1:Enable

No No No No No

No No Yes No No No

Down

Integer

button "▼" switch of AElevel 0:Disable, 1:Enable

No No No No No

No No Yes No No No

Shutter (Shutter function)

Slower

Integer

button "▲" switch of shatter 0:Disable, 1:Enable

No No No No No

No No Yes No No Yes

Faster

Integer

button "▼" switch of shatter 0:Disable, 1:Enable

No No No No No

No No Yes No No Yes

Whb (White balance function)

Faw

Integer

button "FAW" switch of White balance0:Disable, 1:Enable

No No No No No

No No Yes No No No

Auto

Integer

button "Auto" switch of White balance0:Disable, 1:Enable

No No No No No

No No Yes No No Yes

Indoor

Integer

button "Indoor" switch of White balance0:Disable, 1:Enable

No No No No No

No No Yes No No Yes

Outdoor

Integer

button "Outdoor" switch of White balance0:Disable, 1:Enable

No No No No No

No No Yes No No Yes

OnePush

Integer

button "OnePush" switch of White balance0:Disable, 1:Enable

No No No No No

No No Yes No No Yes

Manual

Integer

button "MANUAL" switch of White balance0:Disable, 1:Enable

No No No No No

No No Yes No No Yes

Awb

Integer

button "AWB" switch of White balance0:Disable, 1:Enable

No No No No No

No No Yes No No No

K3200

Integer

button "3200K" switch of White balance0:Disable, 1:Enable

No No No No No

No No Yes No No No

K5600

Integer

button "5600K" switch of White balance0:Disable, 1:Enable

No No No No No

No No Yes No No No

AwbTrigger

Integer

button "AWB trigger" switch of White balance. (In case of PZ400, this may Enable only in OnePush mode.)0:Disable, 1:Enable

No No No No No

No No Yes No No Yes

Focus

(Focus function)

Manual

Integer

button "MANUAL" switch of focus 0:Disable, 1:Enable

No No No No No

No No Yes No No Yes

Auto

Integer

button "AUTO" switch of focus 0:Disable, 1:Enable

No No No No No

No No Yes No No Yes

Detail (Detail function)

Integer

button "ON" switch of Streaming 0:Disable, 1:Enable

No No No No No

No No Yes No No No

Down

Integer

button "OFF" switch of Streaming 0:Disable, 1:Enable

No No No No No

No No Yes No No No

Bright (Bright function)

Integer

button "ON" switch of Bright 0:Disable, 1:Enable

No No No No No

No No Yes No No Yes

Down

Integer

button "OFF" switch of Bright 0:Disable, 1:Enable

No No No No No

No No Yes No No Yes

Preset (Availability of preset number)

Integer

PTZ preset number is operatable. 0:Disable, 1:Enable

No No No No No

No No Yes No No Yes

Integer

PTZ preset number is operatable. 0:Disable, 1:Enable

No No No No No

No No Yes No No Yes

* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

Integer

PTZ preset number is operatable. 0:Disable, 1:Enable

No No No No No

No No Yes No No Yes

100

Integer

PTZ preset number is operatable. 0:Disable, 1:Enable

No No No No No

No No Yes No No Yes

Example

{
    "Response": {
    "Requested": "GetCamStatusMinimum",
    "Result": "Success",
    "Data": {
    "Camera": {
    "PowerStatus": "On", "MenuStatus": "On"
    },
    "Exposure": {
    "Status": "Auto"
    },
    "Ins": {
    "Status": "Auto", "Value": "0"
    },
    "Shutter": {
    "Status": "Auto", "Value": "0"
    },
    "Dam": {
    "Status": "Auto", "Value": "0"
    },
    "AeLevel": {
    "Status": "AeOn", "Value": "0"
    },
    "Who": {
    "Status": "Faw", "Value": "0",
    "WhPRScale": 0, "WhPBScale": 0,
    "WhPRPosition": 64, "WhPBPosition": 64,
    "WhPRValue": 64, "WhPEValue": 64"
    },
    "Focus": {
    "Status": "Auto", "Value": "0"
    },
    "Zoom": {
    "Position": 100
    },
    "Detail": {
    "Value": "100"
    },
    "Streaming": {
    "Status": "Stop"
    },
    "TallyLamp": {
    "Priority": "Camera", "Lighting": "Off"
    },
    "Enable": {
    "Exposure": {
    "Auto": 1, "Manual": 1, "ShutterPriority": 1, "IrisPriority": 1
    },
    "Iris": {
    "Open1": 1, "Close1": 1
    }
}

{
    "Gain": {
    "Auto": 1, "Manual": 1, "Up1": 1, "Down1": 1
    },
    "AeLevel": {
    "Up": 1, "Down": 1
    },
    "Shutter": {
    "Slower": 1, "Fastor": 1
    },
    "Whb": {
    "Faw": 1, "Manual": 1, "OnePush": 1, "K3200": 1, "K5600": 1, "OnePushTrigger": 1
    },
    "Focus": {
    "Auto": 1, "Manual": 1
    },
    "Detail": {
    "Up": 1, "Down": 1
    },
    "Preset": {
    "1": 1, "2": 1, "3": 1, "4": 1, "5": 1, "6": 1, "7": 1, "8": 1, "9": 1, "10": 1,
    "1": 1, "12": 1, "13": 1, "14": 1, "15": 1, "16": 1, "17": 1, "18": 1, "19": 1, "20": 1,
    "21": 1, "22": 1, "23": 1, "24": 1, "25": 1, "26": 1, "27": 1, "28": 1, "29": 1, "30": 1,
    "31": 1, "32": 1, "33": 1, "34": 1, "35": 1, "36": 1, "37": 1, "38": 1, "39": 1, "40": 1,
    "41": 1, "42": 1, "43": 1, "44": 1, "45": 1, "46": 1, "47": 1, "48": 1, "49": 1, "50": 1,
    "51": 1, "52": 1, "53": 1, "54": 1, "55": 1, "56": 1, "57": 1, "58": 1, "59": 1, "60": 1,
    "61": 1, "62": 1, "63": 1, "64": 1, "65": 1, "66": 1, "67": 1, "68": 1, "69": 1, "70": 1,
    "71": 1, "72": 1, "73": 1, "74": 1, "75": 1, "76": 1, "77": 1, "78": 1, "79": 1, "80": 1,
    "81": 1, "82": 1, "83": 1, "84": 1, "85": 1, "86": 1, "87": 1, "88": 1, "89": 1, "90": 1,
    "91": 1, "92": 1, "93": 1, "94": 1, "95": 1, "96": 1, "97": 1, "98": 1, "99": 1, "100": 1
    },
    }
}

3.4.6. Get Pan & Tilt Positions

Get Pan & Tilt positions

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

GetPTPosition

No No No No Yes No Yes

SessionID

String

(Session ID in cookie.)

No No No No Yes No Yes No Yes

Example

"Request":{

"Command": "GetPTPosition",

"SessionID": "7425fcb58ee4d15dd4c1f5ace4299a3",

}

Response Key

Style Value

HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

GetPTPosition

No No No No Yes No Yes

Result

String

(Result of command processing.)

No No No No Yes No Yes

Data

Pan

Integer

0(Back left limit)- 17540(Front)- 35080(Back right limit)

No No No No Yes No Yes

Tilt

Integer

0(Just above)- 9040(Just beside)- 12080(Diagonally downward)

No No No No Yes No Yes

Example

{

"Response": {

"Requested": "GetPTPosidon",

"Result": "Success".

"Date": {

"Pan": 17540,

"Tilt": 9040

}

3.5. How to acquire JPEG data

These commands enables to start JPEG encoding and acquire JPEG image data.

'3.5.1 JpegEncode' command with parameter 'Start' can be used to start encoding.

JPEG data is acquired followed by a header in a response for 'get_jpg_cgi' described in '3.5.2 Acquire JPEG data'.

3.5.1. JPEG encode control

Start / stops the encoding function of the camera.

It is necessary to start encoding to acquire JPEG data.

When other users have already used it, it returns disable error. Even in this case, you can acquire JPEG data.

Please be carefully to stop JPEG encoding, because other users may acquire JPEG data

There is a possibility stop encoding command returns error if another client has already stopped encoding.

In the following cases, you cannot send the command to the camera

The camera is in Live Streaming mode.

The camera is in IFB Streaming mode.

Request

Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Request

Command

String

JpegEncode

Yes Yes

Yes No

SessionID

String

(Session ID in cookie.)

Yes Yes

Yes No

Params

Operate

String

"Start" / "Stop"

Yes Yes

Yes No

Example

{

"Request": {

"Command": "JpegEncode",

"SessionID": "7425fbcb58ee4d15dd4c1f5ace4239a3",

"Params": {

"Operate": "Start"

}

Response Key

Response

Requested

String

JpegEncode

Yes Yes

Yes No

Result

String

(Result of command processing.)

Yes Yes

Yes No

Example

{

"Response": {

"Requested": "JpegEncode",

"Result": "Success"

}

3.5.2. Set JPEG encode size

Setting image resolution of acquiring JPEG data.

Request

Key

Style

Value

HM650

HM660

HM850

HM200

HM25x

HM280

LS300

PZ100

HC800

HC650

PZ400

Request

Command

String

SetJpegEncodeSize

No No

Yes No

No No

SessionID

String

(Session ID in cookie.)

No No

Yes No

No No

Params

Size

String

"640x360"*320x180"

No No

Yes No

No No

Example

{
    "Request": {
    "Command": "SetJpegEncodeSize",
    "SessionID": "7425fccb58ee4d15dd4c1f5aco4299a3",
    "Params": {
    "Size": "320x180"
    }
    }
}

Response Key

Response

Requested

Siting

SetUpegEncodeSize

No No

Yes No

No No

Result

Siting

(Result of command processing)

No No

Yes No

No No

Example

{
    "Response": {
    "Requested": "SetJpegEncodeSize",
    "Result": "Success"
    }
}

3.5.3. Acquire JPEG data

You can acquire JPEG image followed by a header when accessing to the URL below.

Content type of the response is image/jpeg

Access format	HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400
http://ip address/cgi-bin/get_jpg.cgi?SessionID=Session ID in cookie.>	Yes Yes	Yes Yes	Yes Yes	Yes Yes	Yes Yes	Yes No
Request	HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400
GET/cgi-bin/get_jpg.cgi?SessionID=Session ID in cookie.> HTTP/1.1/n	Yes Yes	Yes Yes	Yes Yes	Yes Yes	Yes Yes	Yes No
Response	HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400
HTTP 1.1 200 OK/n	Yes Yes	Yes Yes	Yes Yes	Yes Yes	Yes Yes	Yes No
Content-type: image/jpeg/n
Pragma: no-cache/n
Cache-Control: no-cache/n
Expires: Thu, 01 Jan 1970 00:00:00 GMT/n
Content-Length: 3296/n
Date: Wed, 07 Jan 2015 23:28:58 GMT/n
Server: Cameral/n
I/n
......Data of Jpeg file follows after this.

3.6. How to use Interruptible Feedback Function

These commands enables to use interruptible feedback(IFB) function.

IFB is used for returning audio to the camera from the controller.

3.6.1. Get interruptible feedback settings

Get IFB function parameters.

Request

Key

Style

Value

HM650

HM660

HM6x0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

GetIFBSettings

No Yes

Yes No

No No

SessionID

String

(Session ID in cookie.)

No Yes

Yes No

No No

Example

"Request": {

"Command": "GetIFBSettings",

"SessionID": "7425fobc58eeAd15ddHc15ace4299a3",

}

Response Key

Response

Requested

String

GetIFBSettings

No Yes

Yes No

No No

Result

String

(Result of command processing.)

No Yes

Yes No

No No

Data

Function

String

Switch to enable IFB function. "Enable" / "Disable"

No Yes

Yes No

No No

Address

String

Address of IFB server. "xxx.xxx.xxx.xxx"

No Yes

Yes No

No No

Port

Integer

Port of IFB server. 1 - 65535

No Yes

Yes No

No No

Mountpoint

String

Mountpoint on IFB server. Max 62 characters.

No Yes

Yes No

No No

Example

{

"Response": {

"Requested": "GetFBSettings",

"Result": "Success",

"Data": {

"Function": "Enable",

"Address": "132.168.0.11",

"Port": 5000,

"Mountpoint": "DB90TX"

}

3.6.2. Set interruptible feedback settings

Set IFB function parameters. It is necessary to use return audio at camera.

This command enables / disables the IFB function of the camera.

Request

Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

SetIFBSettings

No Yes

Yes No

No No

SessionID

String

(Session ID in cookie.)

No Yes

Yes No

No No

Params

Function

String

Switch to enable IFB function. "Enable" / "Disable"

No Yes

Yes No

No No

Address

String

Address of IFB server. "xxx.xxx.xxx.xxx"

No Yes

Yes No

No No

Port

Integer

Port of IFB server. 1 - 65535

No Yes

Yes No

No No

Mountpoint

String

Mountpoint on IFB server. Max 62 characters.

No Yes

Yes No

No No

Example

{

"Request": {

"Command": "SetIFBSettings,

"SessionID": "7425fbcb58eeAd15ddHc1f5ace4299a3",

"Params": {

"Function": "Enable",

"Address": "132.168.0.11",

"Port": 5000,

"Mounlpoint": "DB90TX"

}

Response Key

Type

Style

Value

HM650

HM660

HM6x0

HM200

HM25x

HM260

LS300

PZ100

HC900

HC5x0

PZ400

Response

Requested

String

SetIFBSettings

No Yes

Yes No

No No

Result

String

(Result of command processing.)

No Yes

Yes No

No No

Example

{

"Response": {

"Requested": "SetIFBSettings",

"Result": "Success"

}

3.6.3. Set interruptible feedback streaming control

This command is used to start/stop IFB streaming

Request Key

Style Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HG900

HG5x0

PZ400

Request

Command

String

SetIFBCtrl

No Yes

Yes No

No No

SessionID

String

{Session ID in cookie.}

No Yes

Yes No

No No

Params

Streaming

Sting

Streaming Control"Start":start streaming / "Stop":stop streaming

No Yes

Yes No

No No

Example

{
    "Request": {
    "Command": "SelfFBCin",
    "SessionID": "7425fccb8ee-1d15dd4c15ace4299a3",
    "Params": {
    "Streaming": "Start"
    }
    }
}

Response Key

Response

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC05x0

PZ400

Requested

String

SetIFBCtrl

No Yes

Yes No

No No

Result

String

(Result of command processing.)

No Yes

Yes No

No No

Example

{
    "Response": {
    "Requested": "SelfFBCtrl",
    "Result": "Success"
    }
}

3.7. How to control Studio Tally System

"SetStudioTally" command indicates tally condition to the camera and it displays "PGM" or "PVW" on the LCD

Menu settings on the camera which affects tally lamp control are as follows.

On the studio tally system described in this chapter, "SetTally LampCtrl" command should not be used.

"SetStudioTally" and "SetTallyLampPriority" commands can control studio tally system.

From Web API version 1.07, alarm indication on the camera itself has highest priority compared with all other tally control via web interface.

This description is not for PZ400.

Menu settings on HM660/HM200/HM25x/HM280/PZ100

System...

Tally Lamp

Off, Rec, Live Streaming, Rec/Live Streaming, External*

Menu settings on HM8x0

System...

Tally System

Studio*,internal

If the Tally System setting is "Studio".

System...

Front Tally

Off, On*

Back Tally

Off, On*

* Tally lamp is controlled by Web API when selected.

3.7.1. Studio tally control

This command controls studio tally indication.

Turning on/off the tally lamp depends on camera settings.

Refer to "3.7.4. Relation of commands on Studio tally system" about Tally lamp control.

"SetStudioTally" should be used only when changing the tally state, otherwise it causes performance degradation.

Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HG900

HG5x0

PZ400

Request

Command

String

SetStudioTally

No Yes

Yes Yes

No Yes

Yes Yes

Yes

SessionID

String

(Session ID in cookie.)

No Yes

Yes Yes

No Yes

Yes Yes

Yes

Params

Indication

String

"Off"(not Indicate status on LCD) / "Program" (Indicate PGM on LCD) / "Preview" (Indicate PVW on LCD)

No Yes

Yes Yes

No Yes

Yes Yes

Yes

Example

{

"Request": {

"Command": "SetStudioTally",

"SessionID": "7425tccb58ee4d15dd4e15ace4299a3",

"Params": {

"Indication": "Program"

}

Response

Key

Style

Value

HM553

HM662

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Response

Requested

String

SetStudio Tally

No Yes

Yes Yes

No Yes

Yes Yes

Yes

Result

String

(Result of command processing.)

No Yes

Yes Yes

No Yes

Yes Yes

Yes

Example

{

"Response": {

"Requested": "SetStudioTaily",

"Result": "Success"

}

3.7.2. Set tally lamp priority

Set indication priority setting of the tally lamp.

You should set tally lamp priority to "Web" before using the tally lamp via API.

Menu setting on the camera is fixed to "External/Studio" when setting changed priority to "Web" and cannot change it.

It becomes changeable when priority setting is "Camera"

This command should be used only when the tally lamp status need to be changed, otherwise it causes performance degradation.

'SetTallyLampPriority' changes camera setting as follows.

Camera stores prior state before switching to the "Web" priority and it resumes former state when you return the priority to "Camera".

HM660/HM200/HM25x/HM280/PZ100/HC5x0

System...

Tally Lamp

Off, Rec, Live Streaming, Rec/Live Streaming, External

HM8x0/HC900

System...

Tally System

Studio,Internal

This setting becomes 'On' when the priority is set to 'Web'.

System...

Front Tally

Off, Rec, Live Streaming, Rec/Live Streaming *

Off, On **

Back Tally

Off, Rec, Live Streaming, Rec/Live Streaming *

Off, On **

* If the Tally System setting is "Internal".

** If the Tally System setting is "Studio".

Request Key
Style Value
HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

SetTallyLampPriority

Yes Yes

Yes No

SessionID

String

(Session ID in cookie.)

Yes Yes

Yes No

Params

Priority

Integer

"Camera"(Camera is given priority of control.)/ "Web"(Web is given priority of control.)

Yes Yes

Yes No

Example

{
    "Request": {
    "Command": "SetTallyLampPriority",
    "SessionID": "7425fpcb58ee4d15db4c15ace4299a3",
    "Params": {
    "Priority": "Camera"
    }
    }
}

Response Key
Style Value
HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC800 HC5x0 PZ400

Response

Requested

String

SetTallyLampPriority

Yes Yes

Yes No

Result

String

(Result of command processing.)

Yes Yes

Yes No

Example

{
    "Response": {
    "Requested": "SetTailyLampPriority",
    "Result": "Success"
    }
}

System Chart
graph TD A["Studio tally control system"] --> B["Network switch"] B --> C["LED lighting of each model KY-PZ100"] C --> D["Settings"] D --> E["Front back"] E --> F["Camera Preview"] F --> G["Program"] G --> H["External or Studio"] H --> I["Other"] I --> J["Camera Preview"] J --> K["Program"] K --> L[…

LCD indication image
PDM

JVC GY-HM660RE - Set tally lamp priority - 3

graph TD A["Studio tally control system"] --> B["GetCamStatus* returns status of camera. Priority of Tally Lamp is Camera."] A --> C["SetStudioTally Indication:Program."] A --> D["GetCamStatus* returns status of camera. Indicate of Studio tally is Program."] A --> E["SetTallyLampPriority Priority:We…

* "GetCamStatusMinimum" command can be used to acquire the status as well on KY-PZ100 and KY-PZ400. * PZ400 is not indication of studio tally status on LCD.

3.8. Return over IP Command

These commands enables to use Return over IP function.

Zixi and SRT streaming modes are mutually exclusive on GY-HC5x0 and GY-HC900.

Only "Zixi" or "Srt" parameter is effective according to the streaming mode.

Current mode can be checked using GetSystemInfo response.

3.8.1. GetCurrentReturnOverIpServerID

Get current server ID for Return over IP function.

There are four server settings for Return over IP.

Request

Key

Style

Value

HM650

HM660

HM6x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Request

Command

String

GetCurrentReturnOverIpServerID

No No

No Yes

Yes No

SessionID

String

(Session ID in cookie.)

No No

No Yes

Yes No

Example

"Request":

"Command": "GetCurrentReturnOveripServerID",

"SessionID": "7425f0cb580c4d15dd4c1f5aco4299a3",

}

Response Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Response

Requested

String

GetCurrentReturnOverIpServerID

No No

No Yes

Yes No

Result

String

(Result of command processing.)

No No

No Yes

Yes No

Data

Integer

0:server1, 1: server2, 2: server3, 3: server4

No No

No Yes

Yes No

Example

{

"Response": {

"Requested": "GetCurrentReturnOverIpServerID",

"Result": "Success",

"Data": {

"ID": 0

}

3.8.2. SetCurrentReturnOverIpServerID

Set current server ID for Return over IP function.

Choose the server ID to use in Return over IP function.

Request

Key

Style

Value

HM650

HM660

HM6x0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

SetCurrentReturnOverIpServerID

No No

No Yes

Yes No

SessionID

String

(Session ID in cookie.)

No No

No Yes

Yes No

Params

Integer

0:server1, 1: server2, 2: server3, 3: server4

No No

No Yes

Yes No

Example

"Request": {

"Command": "SelCurrentReturnOverlapServerID",

"SessionID": "7425fccb58ee4d15dd4c15ace4299a3",

"Params": {

"ID": 0

}

Response Key

Response

Requested

Siring

SetCurrentReturnOverIpServerID

No No

Yes Yes No

Result

Siring

(Result of command processing.)

No No

Yes Yes No

Example

{"Response": {"Requested": "SetCurrentReturnOverlapServerID", "Result": "Success"}

3.8.3. GetReturnOverIpServerSettings

Get Return over IP settings for each server ID.

Request Key

Style

Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Request

Command

String

GetReturnOverIpServerSettings

No No

No Yes

Yes No

SessionID

String

(Session ID in cookie.)

No No

No Yes

Yes No

Params

Integer

0:server1, 1: server2, 2: server3, 3: server4

No No

No Yes

Yes No

Example

"Request": {

"Command": "GetReturnOveripServerSettings",

"SessionID": "7425fbcb58ee4d15ddHc15ace4299a3",

"Params": {

"ID": f

}

Response Key

Response

Requested

String

GetReturnOverlpServerSettings

No No No No No

No No No Yes Yes No

Result

String

(Result of command processing.)

No No No No No

No No No Yes Yes No

Data

Alias

String

(Another name of server)

No No No No No

No No No Yes Yes No

Type

String

"RTSP/RTP" / "Icecast" / "SRT"

No No No No No

No No No Yes Yes No

RTSP/RTP

(Selected by Type)

Protocol

String

"UDP""TCP"

No No No No No

No No No Yes Yes No

SrcAddress

String

(IP address)

No No No No No

No No No Yes Yes No

SrcPort

Integer

(Port number)

No No No No No

No No No Yes Yes No

StreamId

String

(Stream ID)

No No No No No

No No No Yes Yes No

Username

String

(User name)

No No No No No

No No No Yes Yes No

Password

String

(Password for RTSP/RTP)

No No No No No

No No No Yes Yes No

Resolution

integer

0:1280x720

No No No No No

No No No Yes Yes No

FrameRate

integer

1:60p, 2:30p, 4:50p, 5:25p

No No No No No

No No No Yes Yes No

Zixi

(Selected by Type)

SrcAddress

string

(IP address)

No No No No No

No No No Yes Yes No

SrcPort

integer

(Port number)

No No No No No

No No No Yes Yes No

StreamId

string

(Stream ID for ZIXI)

No No No No No

No No No Yes Yes No

Password

string

(Password for ZIXI)

No No No No No

No No No Yes Yes No

Name

string

(Name for ZIXI)

No No No No No

No No No Yes Yes No

Latency

integer

0:Off, 1:Low, 2: Medium

No No No No No

No No No Yes Yes No

Resolution

integer

0:1280x720

No No No No No

No No No Yes Yes No

FrameRate

integer

1:60p, 2:30p, 4:50p, 5:25p

No No NoNo No

No No No Yes Yes No

Icecast

(Selected by Type)

SrcAddress

String

(IP address)

No No No No No

No No No Yes Yes No

SrcPort

Integer

(Port number)

No No No No No

No No No Yes Yes No

Mountpoint

String

(Mountpoint)

No No No No No

No No No Yes Yes No

SRT

(Selected by Type)

SrcAddress

string

(IP address) No No No No No No No Yes Yes No

Port

integer

(Port number) No No No No No No No Yes Yes No

ConnectionMode

integer

0: Caller 1: Listener, 2: Rendezvous

Yes

Latency

integer

20 - 8000

No No

No Yes

Yes No

Encryption

integer

0: OFF, 1: ON No No No No No No No Yes Yes No

Passphrase

string

(Passphrase for SRT) No No No No No No No Yes Yes No

Resolution

integer

0:1280x720 No No No No No No No Yes Yes No

FrameRate

integer

1:60p, 2:30p, 4:50p, 5:25p

No No

No Yes

Yes No

Example

{
    "Response": {
    "Requested": "GetReturnOver tripServerSettings",
    "Result": "Success",
    "Date": {
    "Alias": "Server1",
    "Type": "RTSP",
    "Rtsp": {
    "Protocol": "UDP",
    "SrcAddress": "192.168.0.1",
    "SrcPort": 6504
    "Streamid": "HC900-1234",
    "Username": "Jvckenwood",
    "Password": "abcdefghijklmnopqrstuvwxyz"
    }
    }
    }
}

3.8.3.1. AvailableTypeOfReturnOverIP

Get Available type.

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

AvailableTypeOfReturnOverIP

No No No No No

No No No Yes

Yes No

SessionID

String

(Session ID in cookie.)

No No No No No

No No No Yes

Yes No

Example

{

"Request": {

"Command": "AvailableTypeOfReturnOverIP", "SessionID": "7425fccb58ee4d15dd4c1f5ace4299a3", }

Response Key

Style Value

HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

AvailableTypeOfReturnOverIP

No No No No No

No No No Yes Yes No

Result

String

(Result of command processing.)

No No No No No

No No Yes Yes No

Data

AvailableType

No No No No No

No No Yes Yes No

RTSP/RTP

Integer

0 : unselectable, 1 : selectable

No No No No No

No No Yes Yes No

Icecast

Integer

0 : unselectable, 1 : selectable

No No No No No

No No Yes Yes No

Zixi

Integer

0 : unselectable, 1 : selectable

No No No No No

No No Yes Yes No

SRT

Integer

0 : unselectable, 1 : selectable

No No No No No

No No Yes Yes No

Example

{

"Response": {

"Requested": "AvailableTypeOfReturnOverIP",

"Result": "Success",

"Date": {

"AvailableType": {

"RTSPNTP": 1,

"Icecast": 1,

"200": 0

}

3.8.3.2. AvailableFrameRateOfReturnOverIP

Get available frame rate.

Request Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Request

Command

String

AvailableFrameRateOfReturnOverIP

No No

Yes

SessionID

String

(Session ID in cookie.)

No No

No Yes

Yes

Params

RecordingFrameRate

String

"60p" / "50p" / "60i" / "50i" / "30p" / "25p"

No No

Yes

Example

{
    "Request": {
    "Command": "AvailableFrameRateOfReturnOverIP",
    "SessionID": "7425fcbc58ee4d15dd4c1f5ace4299a3",
    "Params": {
    "RecordingFrameRate": "60p"
    }
    }
}

Response Key

Style Value

HM650 HM660 HM8x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

AvailableFrameRateOfReturnOverIP

No No

Yes Yes No

Result

String

(Result of command processing.)

No No

Yes Yes No

Data

RecordingFrameRate

String

"60p" / "50p" / "60i" / "50i" / "30p" / "25p"

No No

Yes Yes No

AvailableFrameRate

No No

Yes Yes No

"60p"

Integer

0 : unselectable, 1 : selectable

No No

Yes Yes No

"30p"

Integer

0 : unselectable, 1 : selectable

No No

Yes Yes No

"50p"

Integer

0 : unselectable, 1 : selectable

No No

Yes Yes No

"25p"

Integer

0 : unselectable, 1 : selectable

No No

Yes Yes No

Example

{
    "Response": {
    "Requested": "AvailableFrameRateOfReturnOverP",
    "Result": "Success",
    "Data": {
    "RecordingFrameRate": "60p"
    "AvailableFrameRate": {
    "60p": 1,
    "30p": 1,
    "50p": 0,
    "25p": 0
    }
    }
}

3.8.4. SetReturnOverIpServerSettingsRTSP

Set Return over IP settings for each server ID.

This command is used for RTSP/RTP protocol.

Request Key

Style

Value

HM650

HM660

HMEx0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

SetReturnOveripServerSettingsRTSP

Yes

SessionID

String

(Session ID in cookie.)

Yes

Params

Integer

0:server1, 1: server2, 2: server3, 3: server4

Yes

Alias

String

(Another name of server)

Yes

Protocol

String

"UDP""TCP"

Yes

SrcAddress

String

(IP address)

Yes

SrcPort

Integer

(Port number)

Yes

StreamId

String

(Stream ID)

Yes

Username

String

(User name)

Yes

Password

String

(Password for RTSP:RTP)

Yes

FrameRate

Integer

1:60p, 2:30p, 4:50p, 5:25p

Yes

Example

"Request": {

"Command": "SetReturnOverlapServerSettingsRTSP", "SessionID": "7425lbcb58ee4d15dd4c1f5aco4299a3", "Params": {

"ID": 1,

"Alias": "Server1", "Protocol": "UDP", "SrcAddress": "192.168.0.1", "SrcPort": 6504

"StreamId": "HC900-1234", "Username": "Jvckenwood", "Password": "abcde"

}

Response Key
Style Value
HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

SetReturnOverlpserverSettingsRTSP

No No No No No No No Yes Yes No

Result

String

(Result of command processing.)

No No No No No No No Yes Yes No

Example

{

"Response": {

"Requested": "SetReturnOverlapServerSettingsRTSP",

"Result": "Success"

}

3.8.5. SetReturnOverIpServerSettingsZIXI

Set Return over IP settings for each server ID.

This command is used for Zixi protocol.

Request Key

Style

Value

HM650

HM660

HMEx0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

SetReturnOveripServerSettingsZIXI

Yes

SessionID

String

(Session ID in cookie.)

Yes

Params

Integer

0:server1, 1: server2, 2: server3, 3: server4

Yes

Alias

String

(Another name of server)

Yes

SrcAddress

String

(IP address)

Yes

SrcPort

Integer

(Port number)

Yes

StreamId

String

(Stream ID for ZIXI)

Yes

Password

String

(Password for ZIXI)

Yes

Name

String

(Name for ZIXI)

Yes

Latency

Integer

0:Low, 1:Medium, 2:Minimum(Zixi OFF), 3:High

Yes

FrameRate

Integer

1:60p, 2:30p, 4:50p, 5:25p

Yes

Example

{

"Request": {

"Command": "SetReturnOverlapServerSettings21X1", "SessionID": "7425lcbc58ee4d15dd4c1f5aco4299a3", "Params": {

"ID": 1,

"Alias": "Server1", "SrcAddress": "192.168.0.1", "SrcPort": 2088,

"Streamid": "HMS50-1234", "Password": "abcde", "Name": "UvcKenwood", "Latency": 0

}

Response Key
Style Value
HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response

Requested

String

SetReturnOverlipServerSettingsZIXI

No No No No No No No Yes Yes No

Result

String

(Result of command processing.)

No No No No No No No Yes Yes No

Example

{

"Response": {

"Requested": "SetReturnOveripServerSettingsZIXI",

"Result": "Success"

}

3.8.6. SetReturnOverIpServerSettingsIcecast

Set Return over IP settings for each server ID.

This command is used for Icecast protocol.

Request Key

Style

Value

HM650

HM660

HM6x0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

SetReturnOveripServerSettingsIbcast

No No

No Yes

Yes No

SessionID

String

(Session ID in cookie.)

No Yes

Yes No

Params

Integer

0:server1, 1: server2, 2: server3, 3: server4

No Yes

Yes No

Alias

String

(Another name of server)

No Yes

Yes No

SrcAddress

String

(IP address)

No Yes

Yes No

SrcPort

Integer

(Port number)

No Yes

Yes No

Mountpoint

String

(Mountpoint)

No Yes

Yes No

Example

"Request": {

"Command": "SetReturnOverlapServerSettingslicescast",

"SessionID": "7425bcb58ee4d15d04c15ace4299a3",

"Params": {

"ID": 1,

"Alias": "Servort",

"SrcAddress": "192.168.0.1",

"SrcPort": 6504,

"Mountpoint": "abcdefg"

}

Response Ke

Response

Requested

String

SetReturnOverIpServerSettingsiccast

No No No No No

No No No Yes

Yes No

Result

String

(Result of command processing.)

No No No No

No No No Yes

Yes No

Example

"Response": { "Requested": "SetReturnOverlapServerSettingsRecord", "Result": "Success"}

3.8.7. SetReturnOverIpCtrl

This command is used to start/stop Return over IP.

Request Key

Style Value

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC5x0

PZ400

Request

Command

String

SetReturnOverlapCtrl

No No

No Yes

Yes No

SessionID

String

{Session ID in cookie.}

No No

No Yes

Yes No

Params

Operate

String

Streaming Control"Start":start Return over IP / "Stop":stop Return over IP

No No

No Yes

Yes No

Example

"Request": {"Command": "SetReturnOverlapCin", "SessionID": "7425fccb5ree4d15dd4c15ace4299a3", "Params": {"Operate": "Start"}

}

Response Key

Response

HM650

HM660

HM8x0

HM200

HM25x

HM280

LS300

PZ100

HC900

HC050

PZ400

Requested

String

SetReturnOverlapCtrl

No No

Yes Yes

Result

String

(Result of command processing.)

No No

Yes Yes

Example

"Response": { "Requested": "SetReturnOveripCtn", "Result": "Success"}

3.8.8. SetReturnOverIpServerSettingsSRT

Set Return over IP settings for each server ID.

This command is used for SRT protocol.

Request Key

Style

Value

HM650

HM660

HMEx0

HM200

HM25x

HM280

LS300

PZ100

HC800

HC5x0

PZ400

Request

Command

String

SetReturnOveripServerSettingsSRT

Yes

SessionID

String

(Session ID in cookie.)

Yes

Params

Integer

0:server1, 1: server2, 2: server3, 3: server4

Yes

Alias

String

(Another name of server)

Yes

SrcAddress

String

(IP address)

Yes

Port

Integer

(Port number)

Yes

ConnectionMode

Integer

0: Caller 1: Listener, 2: Rendezvous

Yes

Latency

Integer

20 - 8000

Yes

Encryption

Integer

0: OFF, 1: ON

Yes

Passphrase

String

(Passphrase for SRT)

Yes

FrameRate

Integer

1:60p, 2:30p, 4:50p, 5:25p

Yes

Example

{

"Request": {

"Command": "SetReturnOverlapServerSettingsSRT", "SessionID": "7425ftcb58ee4d15dd4c1f5aco4299a3", "Params": {

"ID": 1,

"Alias": "Servor1", "SrcAddress": "192.168.0.1", "Port": 2088, "ConnectionMode": 0, "Latency": 20, "Encryption": 0, "Passphrase": "abcdefghijklmnopqrstuvwxyz", "FrameRate": 1,}

Response Key
Style Value
HM650 HM660 HM6x0 HM200 HM25x HM280 LS300 PZ100 HC900 HC5x0 PZ400

Response
Requested	String	SetReturnOverlipServerSettingsSRT	No No No No No	No No No Yes No
Result	String	(Result of command processing.)	No No No No No	No No No Yes No

Example

"Response": {"Requested": "SetReturnOveripServerSettingsSRT", "Result": "Success"}