KY-PZ100BE - Surveillance Camera JVC - Free user manual and instructions
Find the device manual for free KY-PZ100BE JVC in PDF.
| Product Type | Surveillance Camera, PTZ |
| Brand | JVC |
| Model | KY-PZ100BE |
| Image Sensor | 1/2.8-inch Progressive CMOS |
| Effective Pixels | 1920 x 1080 (2MP) |
| Minimum Illumination | 0.05 lux (color) |
| Pan Range | 360° endless |
| Tilt Range | -30° to 90° |
| Optical Zoom | 20x |
| Digital Zoom | 12x |
| Video Output | HD-SDI, HDMI, IP (H.264/H.265) |
| Power Supply | DC 12V or PoE+ (IEEE 802.3at) |
| Power Consumption | Max 18W |
| Dimensions (W x H x D) | 160 x 200 x 160 mm |
| Weight | 1.5 kg (approx.) |
| Operating Temperature | 0°C to 40°C |
| Ingress Protection | IP51 (indoor use) |
| Main Functions | Auto tracking, preset positions, motion detection, privacy masking |
| Maintenance | Clean lens with soft dry cloth; avoid solvents |
| Safety | CE, FCC compliant; use only supplied adapter |
| Spare Parts | Contact JVC authorized service center for parts |
| General Information | Professional PTZ camera suitable for broadcast or surveillance |
Frequently Asked Questions - KY-PZ100BE JVC
User questions about KY-PZ100BE JVC
0 question about this device. Answer the ones you know or ask your own.
Ask a new question about this device
Download the instructions for your Surveillance Camera in PDF format for free! Find your manual KY-PZ100BE - JVC and take your electronic device back in hand. On this page are published all the documents necessary for the use of your device. KY-PZ100BE by JVC.
USER MANUAL KY-PZ100BE JVC
JVC Camcorder Web API Reference
Version 1.21
JVCKENWOOD 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. | |
| 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 "G" | "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. GetReturnOverlServerSettings" and "3.8.4. SetReturnOverlServerSettings(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.18 Supported | KY-PZ200 newly. | |
| 1.19 Supported | KY-PZ510 newly. | |
| The following Request Params support String in addition to Integer (for PZ100/400/200). 3.4.1 SetPTCtrl: PanPosition, TiltPosition, PanSpeed, TiltSpeed 3.4.3 ZoomSwitchOperation: Speed 3.4.4 SetPTZPreset: No | ||
| Error correction. 3.1.10. Get streaming server settings: PZ400/200 does not support Username and Password in Type of RTSP. 3.1.21. GetVideoSettings: Change param name from EncodeLevel to VideoEncodeLevel. 3.2.1 GetSystemInfo: Model in Response was duplicated. 3.3.1 GetCamStatus: PZ100 does not support "Auto" / "Indoor" / "Outdoor" in Whb Status and does not support Bright . 3.4.5 GetCamStatusMinimum: Corrected wrong description word from "Streaming" to "Detail". | ||
| 1.19.1 Error correction. | 3.1.1. GetStreamingSettings: Add PZ510 to 3840x2160 resolution of Response. Add notes of some resolution for PZ510. 3.1.2. SetStreamingResolution: Add PZ510 to 3840x2160 resolution of Request. Add notes of some resolution for PZ510. 3.1.4 SetStreamingBitrate: Correct typo in command description. 3.1.6 AvailableStreamingFramerateSettings: Correct typo in Example. 3.1.10 GetStreamingServerSettings: Correct typo in Example. 3.1.16 SetStreamingServerSettingsRTMPS: Correct typo in Example. 3.1.19, 3.1.20, 3.1.22, 3.1.23, 3.1.24, 3.1.26: Correct typo in command description. 3.2.6 GetNTPStatus: Correct typo in Status of Response from "-tSyncronized" to "Not Syncronized". 3.2.8 SetNTPSettings: Add range of value. 3.3.9 GetGPSInfo: Correct typo in Example. 3.4.1 SetPTCtrl: Correct typo in Example. 3.4.5 GetCamStatusMinimum: Correct typo in Example. 3.4.6 GetPTPosition: Correct typo in Example. 3.7.3. Relation of commands on Studio tally system: Add notes for PZ510. 3.8.4 SetReturnOverIpServerSettingsRTSP: Correct typo in Example. 3.8.5 SetReturnOverIpServerSettingsZIXI: Correct typo in Example. | |
| 1.20 Added params. | 3.2.10. SystemRequest: Added Restore params. | |
1.21
Supported auto tracking newly:
3.9 Auto Tracking Command: Added new chapter.
3.3.1. GetCamStatus : Add the following to the response
Data/Tracking
Data/TrackingMode
Data/TrackingBoundingBox
Enable/Tracking
Enable/TrackingMode
Enable/TrackingBoundingBox
3.4.2 JoyStickOperation : Add description for auto tracking.
3.4.5.GetCamStatusMinimum:Add the following to the response
Data/Tracking
Data/TrackingMode
Enable/Tracking
Enable/TrackingMode
Other new features:
3.2.10. SystemRequest : Add "Restore" param for request. It works the same as RESTORE in the WebUI.
Error correction.:
3.4.5 GetCamStatusMinimum : "PowerStatus" in Example has been corrected to "VideoOutputStatus" due to typo.
Contents
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.26. Set Network Multicast Settings
3.1.27. Set NDI Settings
3.1.28. Set MPEG2-TS 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.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
3.9 Auto Tracking Command
3.9.1. Set Auto Tracking On/Off
3.9.2. Set Auto Tracking Mode
3.9.3. Set Auto Tracking Bounding Box
3.9.4. Get Auto Tracking Settings of Standard Mode
3.9.5. Set Auto Zoom of Standard Mode of Auto Tracking
3.9.6. Set Auto Tilt of Standard Mode of Auto Tracking
3.9.7. Set Target Retention Time of Standard Mode of Auto Tracking
3.9.8. Set Figrue Size of Standard Mode of Auto Tracking
3.9.9. Set Vertical Position of Standard Mode of Auto Tracking
3.9.10. Set Horizontal Position of Standard Mode of Auto Tracking
3.9.11. Set Tracking Start Position of Standard Mode of Auto Tracking
3.9.12 Get Auto Tracking Settings of Area Mode
3.9.13 Execute Set/Delete Starting Area of Area Mode of Auto Tracking
3.9.14. Set Target Retention Time of Area Mode of Auto Tracking
3.9.15. Set Tracking Starting Area of Area Mode of Auto Tracking
3.9.16 Get Auto Tracking Settings of Stage Mode
3.9.17 Execute Set/Delete Position of Stage Mode of Auto Tracking
3.9.18. Set Target Retention Time of Stage Mode of Auto Tracking
3.9.19. Set Horizontal Position of Stage Mode of Auto Tracking
3.9.20 Get Auto Tracking Settings of Wide Area Mode
3.9.21 Execute Set/Delete Position of Wide Area Mode of Auto Tracking
3.9.22. Set Auto Zoom of Wide Area Mode of Auto Tracking
3.9.23. Set Auto Tilt of Wide Area Mode of Auto Tracking
3.9.24. Set Target Retention Time of Wide Area Mode of Auto Tracking
3.9.25. Set Figrue Size of Wide Area Mode of Auto Tracking
3.9.26. Set Vertical Position of Wide Area Mode of Auto Tracking
3.9.27. Set Horizontal Position of Wide Area Mode of Auto Tracking
3.9.28. Set Tracking Start Position of Wide Area Mode of Auto Tracking
3.9.29 Get Auto Tracking Settings of Fine Adjustment Mode
3.9.30. Set Auto Zoom of Fine Adjustment Mode of Auto Tracking
3.9.31. Set Auto Tilt of Fine Adjustment Mode of Auto Tracking
3.9.32. Set Tracking Duration Time of Fine Adjustment Mode of Auto Tracking
3.9.33. Set Figrue Size of Fine Adjustment Mode of Auto Tracking
3.9.34. Set Vertical Position of Fine Adjustment Mode of Auto Tracking
3.9.35. Set Horizontal Position of Fine Adjustment Mode of Auto Tracking
3.9.36 Get All Detected Objects
3.9.37. Set Tracking Target
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 command - 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-HM8x0 | GY-HM200 | GY-HM25x | GY-HM280 | GY-LS300 KY-PZ100 GY-HC900 | GY-HC6x0 KY | PZ400 KY-PZ200 KY-PZ510 | ||
| 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-018 ---- | ||||||||||
| 1.09 | V0412 ---- - V0101-0121 ---- | ||||||||||
| 1.10 | ---- V0220-0217 V0102-0145 ---- | ||||||||||
| 1.11 | ---- V010-0148 ---- | ||||||||||
| 1.12 | ---- V0300-0250 V0120-0166 ---- | ||||||||||
| 1.13 | ---- V0106-0022 -- V0200-0138 ---- | ||||||||||
| 1.14 | ---- | V0400-0268 | V0200-0201 ---- | ||||||||
| 1.15 | ---- | V0410-0277 | V0220-0232 ---- | ||||||||
| 1.16 | ---- V0202-0034 ---- | ||||||||||
| 1.17 | ---- | V1.1.98 | - | ||||||||
| 1.18 | ---- | V1.1.20 | |||||||||
| 1.19 | ---- | ||||||||||
| 1.20 | ---- | V1.2.46 | V1.1.53 | ||||||||
| 1.21 | ---- | V3.0.12 |
^ This list shows a API version number which is returned by each firmware.
Newest API document supports most recent firmware on all models.
NOTE: Examples for each Request/Response are just for your reference.
Please replace it with the correct API call according to the model you are using.
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
![graph LR A["camera"] -->|access to an authentication page| B["client"] A -->|send the authentication response| B A -->|send an API command with the authentication information| B A -->|Authentication completion| B](/content/2026/06/1348235/images/2837ae7bba639bb41fbaa1b8870cc24a3e3cbe2a2558efd5b2c5ef304537b217.jpg)
(1)Access to an authentication page of a server from the client.
Example
GET /api.php HTTP/1.1\r
Host: 192.168.0.134\rin
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\rin
Accept-Language: ja,en-us;q=0.7,en;q=0.3\r\n
Accept-Encoding: gzip, deflate\r\n
Connection: keep-alive\rin
ln
(2) The response for authentication is returned to a client.
Example
HTTP/1.1 401 Unauthorized\rin
WWW-Authenticate: Digest realm="GY-HM650",
nonce="7a63056b0a608017c405707e682b9adb", qop="auth"irin
Content-Type: text/html\rin
Content-Length: 1458irln
Date: Tue, 03 Mar 2015 11:35:13 GMTIn
Server: CameralrIn
lrln
(3)The client re-access with the authentication information (user name and password) to the authentication page
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\rIn
Accept-Language: ja,en-us;q=0.7,en;q=0.3\r\n
Accept-Encoding: gzip, deflate\r\n
Connection: keep-alive\r\n
Authorization: Digest username="prohd", realm="GY-HM650",
nonce="7a63056b0a608017c405707e682b9adb", uri="/api.php",
response="0f4d23f739a0e9fa3b78b826b33edaf8", qop=auth, nc=00000001,
cnonce="ee16206547e4dd0e"irin
\in
(4) Session ID is returned form the camera.
Example
HTTP/1.1 302 Found\r\n
Status: 302 Moved Temporarily\r\n
Expires: Thu, 19 Nov 1981 08:52:00 GMT|r|n
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0\rin
Pragma: no-cache\rin
Set-Cookie: SessionID=10ffa8dcd1bb1cf5f9c252b7b8a20738\r\n
Content-type: text/html; charset=UTF-8\r\n
Transfer-Encoding: chunked\r\n
Date: Tue, 03 Mar 2015 11:35:23 GMT\r\n
Server: Camerarin
urn 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\r\n
Accept-Encoding: gzip, deflate\r\n
Content-Type: application/x-www-form-urlencoded; charset=UTF-8\rin
X-Requested-With: XMLHttpRequest\rin
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"\r\n
Connection: keep-alive\rin
Pragma: no-cache\rin
Cache-Control: no-cache\rin
lrln
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\lr\nContent-type: application/json\lr\nPragma: no-cache\lr\nCache-Control: no-cache\lr\nExpires: Thu, 01 Dec 1994 16:00:00 GMT\lr\nContent-Length: 105\r\nDate: Tue, 03 Mar 2015 11:35:30 GMT\lr\nServer: Cameraln\lr\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
| Request | |||
| Command | String | GetStreamingSettings / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / . / | |
| SessionID | String | (Session ID in cookie.) | |
| Params | |||
| Stream | Integer | 0: First, 1: Second | |
Example Example(In case of PZ400/200/510)
| "Request": { "Request": { |
| "Command": "GetStreamingSettings", |
| "SessionID": "7425f0cb58ee4d15dd4c15ace4299a3" |
| "Params": { |
| "Stream": 0 |
"Command": "GetStreamingSettings"
"SessionID": "7425fbb58ee4d15004c1f5ace4299a3"
1
Response Key Style
Value
| Response | ||||||||||||||||
| Requested | String | GetStreamingSettings / ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ | ||||||||||||||
| Result | String | (Result of command processing.) ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ | ||||||||||||||
| Data | ||||||||||||||||
| Stream | Integer | 0: First, 1: Second | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ |
| Resolution | String | "3840x2160" (PZ400/510: First stream only) | - | - | - | - | - | - | - | - | - | - | - | ✓ | - | ✓ |
| "1920x1080" (PZ400/200/510: First stream only) / ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ | ||||||||||||||||
| "1440x1080" - - - - - - - - - - - | ||||||||||||||||
| "1280x720" (PZ400/200/510: First stream only) / ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ | ||||||||||||||||
| "1024x576" (PZ400/200/510: First stream only) | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | ||
| "720x480" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | ✓ | ||
| "720x576" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | |||||
| "720x408" | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | ||
| "640x480" | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | ||
| "640x360" | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ||
| "480x320" | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | ||
| "480x270" / - - - - - - - - - - | ||||||||||||||||
| "320x240" | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | ||
| "1080x1080" | - | - | - | - | - | - | - | - | - | - | ✓ | - | - | - | ||
| "606x1080" | - | - | - | - | - | - | - | - | - | - | ✓ | - | - | - | ||
| "720x720" | - | - | - | - | ✓ | ✓ | - | - | - | - | ✓ | - | - | - | ||
| "404x720" | - | - | - | - | ✓ | ✓ | - | - | - | - | ✓ | - | - | - | ||
| Framerate | String | "60p" / "50p" / "60p" / "50p" / "30p" / "25p" / | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - |
| "422_10bit_60p" / "422_10bit_50p" | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | - | - | ||
| Character string for Framerate value "1" - "60" | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | ||
| Bitrate | String | "0.2M" | ✓ | - | - | - | - | - | - | - | - | - | - | - | - | - |
| "0.3M" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | ||
| "0.8M" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | ||
| "1.5M" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | ||
| "2.5M" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | - | - | - | ||
| "3.0M" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | ||
| "5.0M" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | ||
| "8.0M" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | ||
| "10M" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | - | - | - | ||
| "12M" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | - | ||
| "16M" | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | - | - | - | ||
| "20M" | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | - | - | - | ||
| "24M" | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | - | - | ||
| Character string for Bitrate bps value "32K" - "61440K" (This parameter is valid only H.264/H.265 mode.) | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | ||
| Ofactor | String | Character string for quality factor value "1" - "99" (This parameter is valid only MJPEG mode.) | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ |
| EncodeProtocol | String | "H264" / "H265" / "MJPEG" | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ |
| IKeyFrameInterval | Integer | Value of I Key Frame Interval 2 - 60 | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ |
| BitRateControl | String | "CBR" : "VBR" | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ |
* Framerate "422 10bit 60p" and "422 10bit 50p" are effective only if optional adaptor "KA—EN200" is attached on 'GY—HC900' and 'GY—HC5x0'.
* Character string for Framerate value for PZ400/200/510: If the Video setting is 59.94/29.27, then 60=59.94 and 30=29.97.
Example Example (In case of H.264/H.265 for PZ400/200/510) Example (In case of MJPEG for PZ400/200/510)
{{"
"Response": { "Response": { "Response": {
"Requested": "GetStreamingSettings",
"Result": "Success",
"Data": { "Data": { "Data": {
"Resolution": "1920x1080", "Stream": 0, "Stream": 0,
"Framerate": "60",
"Bitrals": "3.0M"
} "Siterate": "4096K", "Ofactor": "80",
} "EncodeProtocol": "H264", "EncodeProtocol": "MJPEG",
}}
"Requested": "GetStreamingSettings",
"Result": "Success",
"Resolution": "1920x1080", "Resolution": "1920x1080",
"Framerate": "60",
"KeyFrameInterval": 30,
"BitRateControl": "CBR"
} }
}/{ }
3.1.2. Set streaming resolution
Set streaming resolution
Camcorder automatically rebools with this command on HM650, HM660, and HM8x0.
Current value can be obtained with the 'AvailableStreamingResolutionSettings' command.
Request Key Style
Value
| Request | ||||||||||||||||||
| Command | String | SetStreamingResolution √ √ √ √ √ √ √ √ √ √ √ | ||||||||||||||||
| SessionID | String | (Session ID in cookie.) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
| Params | ||||||||||||||||||
| Stream | Integer | 0: First, 1: Second | - | - | - | - | - | - | - | - | - | - | - | - | √ | √ | ||
| Resolution | String | "3840x2160" (PZ400/510: First stream only) | - | - | - | - | - | - | - | - | - | - | - | - | √ | √ | ||
| "1920x1080" (PZ400/200/510: First stream only) √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∞ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∪ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∫ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∜ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∬ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∶ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∭ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∨ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∯ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∮ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∖ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∦ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∤ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∩ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∸ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∟ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∥ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∧ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∿ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∎ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∵ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∂ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∤ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∩ \text { } | ||||||||||||||||||
Framerate is fixed by resolution.(HM650/HM660/HM8x0/HM200/HM25x/LS300)
Example
| "Request": { |
| "Command": "SetStreamingResolution", |
| "SessionID": "7425fcbc58ee4d16dd4c1f5ace4299a3", |
| "Params": { |
| "Resolution": "1920x1080" |
| } |
| } |
Example(In case of PZ400/200/510)
| "Request":{ |
| "Command": "SetStreamingResolution". |
| "SessionID": "7425fbb58ee4d15db4c15ace4299a3", |
| "Params": { |
| "Stream": 0, |
| "Resolution": "1920x1080" |
| } |
| } |
Response Key Style
Value
Current value can be obtained with the 'AvailableStreamingFramerateSettings' command.
Request Key Style
Value
| Request | |||||||||||||||
| Command | Siring | SetStreamingFramerate | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| SessionID | Siring | (Session ID in cookie.) | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| Params | |||||||||||||||
| Stream | Integer | 0: First, 1: Second | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | |
| Framerate | Siring | "60p" / "50p" / "60" / "50l" / "30p" / "25p" / | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | |
| "422 10bit 60p" / "422 10bit 50p" | - | - | - | - | - | - | - | - | ✓ | ✓ | - | - | |||
| Character string for Framerate value "1" - "60" | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | |||
* Framerate "422 10bit 60p" and "422 10bit 50p" are effective only if optional adaptor "KA—EN200" is attached on 'GY—HC900' and 'GY—HC5x0'.
* Character string for Framerate value for PZ400/200/510 : If the Video setting is 59.94/29.27, then 60=59.94 and 30=29.97.
Example Example(In case of PZ400/200/510)
| "Request": { "Request": { |
| "Command": "SetStreamingFramerate", |
| "SessionID": "7425fcbc58ce4d15dc4c15ace4299a3", |
| "Params": { "Params": { |
| "Framerate": "30p" |
| } |
| } |
"Command": "SetStreamingFramerate".
"SessionID": "7425fbcb58ee4d15db4c1f5ace4299a3",
"Stream": 0,
"Framerate": "30"
j
Response
Value
| Response | ||||||||||||||
| Requested | String | SetStreamingFramerate | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Result | String | (Result of command processing.) | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
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
| Request | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Command | String | SetStreamingBitrate √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∞ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∨ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∫ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∪ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∮ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∯ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∜ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∭ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∬ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∶ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∤ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∦ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∩ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∖ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∥ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∎ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∸ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∟ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∿ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∧ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∼ √ (√) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SessionID | String | (Session ID in cookie.) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ✓ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | V | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ✗ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | × | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ○ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | □ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
| Params | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Stream | Integer | 0: First, 1: Second | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Bitrate | String | "0.2M" √ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "0.3M" √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∘ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "0.8M" √ √ √ √ √ √ √ √ √ √ √ √ √ √ \sqrt{√} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - . | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "1.5M" √ √ √ √ √ √ √ √ \sqrt{√} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "2.5M" √ √ √ \sqrt{√} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| "3.0M" √ √ \sqrt{√} -√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√苑 ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√)(√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (√) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∮) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∭) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∆) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∅) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∵) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∪) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (�b) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∑) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∏) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∽) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∸) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (�lt) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (�ll) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∛) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∻) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (�le) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (�ve) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (�be) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (∬) ~√ (�}(a + b + c + d + e + f + g + h + i + j + k + l + m + n + o + p + q + r + s + t + u + v + w + x + y + z + w + x + y + z + w + x + y + z + w + x + y + z + w + x + y + z + w + x + y + z + w + x + y + z + w + x + y + z + w + x + y + z + w + x + y + z + w + x + y + z + w + x + y + z + w + x + y + z + w + y + z + w + x + y + z + w + x + y + z + w + y + z + w + x + y + z + w + x + y + z + w + y + z + w + x + y + z + w + x + y + z + w + y + z + w + x + y + z + w + x + y + z + w + y + z + w + x + y +z + w + x + y + z + w + x + y + z + w + x + y + z + w + y + z + w + x + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z +w + x + y + z + w + x + y + z + w + x + y + z + w + x + y + z + w + x + y + z + w + y + z + w + x + y + z + w + x + y + z + w + y + z + w + x + y + z + w + x + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x +y + x + y + z + w + x + y + z + w + y + z + w + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + y + z + w + x + y + z + w + | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
*In case of PZ400/200/510, BitRateControl are always needed. The corresponding Value of Bitrate and Qfactor is used depending on the mode.
*In case of PZ400/200/510, This settings specified in each Params item must be set in the camera after a reboot.
Example Example(In case of PZ400/200/510)
{
"Request": {"Request": {
"Command": "SetStreamingBitrate",
"SessionID": "7425b0c68ee4d1504c1f5ace4299a3",
"Params": {"Params": {
"Bitrate": "3.0M"
}
}
}
"BitRateControl": "CBR"
}
{
"Command": "SetStreamingBitrate",
"SessionID": "7425fccb58ee4d15dd4c15ace4299a3",
"Stream": 0,
"Bitrate": "4096k",
"Ofactor": "80",
}
}
Response Key Style
Value
| Response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Requested | Siting | Set:StreamingBitrate √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∞ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∭ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∪ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∫ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∨ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∯ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∮ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∜ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∬ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∶ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∤ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∦ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∸ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∖ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∵ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∎ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∩ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∝ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∤ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∕ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∎ (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (Continued) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞)(Continued) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (Continuing) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞), (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (∞) (\texttt {f o r} [0, 0] [1, 2]) [3, 4]) [5, 6] [7, 8] [9, 10] [11, 12] [13, 14] [15, 16] [17, 18] [19, 20] [21, 22] [23, 24] [25, 25] [27, 26] [29, 27] [31, 32] [33, 33] [35, 35] [37, 36] [39, 37] [41, 41] [43, 43] [45, 44] [46, 44] [48, 44] [49, 44] [51, 51] [53, 53] [55, 53] [57, 53] [59, 53] [61, 61] [63, 63] [65, 63] [67, 63] [69, 63] [71, 71] [73, 73] [75, 73] [77, 73] [79, 73] [81, 81] [83, 83] [85, 83] [87, 83] [89, 83] [91, 91] [93, 91] [95, 91] [97, 91] [99, 91] [101, 101] [103, 103] [105, 105] [107, 107] [109, 109] [111, 111] [113, 113] [115, 115] [117, 117] [119, 119] [121, 121] [123, 123] [125, 125] [127, 127] [129, 129] [131, 131] [133, 133] [135, 135] [137, 137] [139, 139] [141, 141] [143, 143] [145, 145] [147, 147] [149, 149] [151, 151] [153, 153] [155, 155] [157, 157] [159, 159] [161, 161] [163, 163] [165, 165] [167, 167] [169, 169] [171, 171] [173, 173] [175, 175] [177, 177] [179, 179] [181, 181] [183, 183] [185, 185] [187, 187] [189, 189] [191, 191] [193, 193] [195, 195] [197, 197] [199, 199] [201, 201] [203, 203] [205, 205] [207, 207] [209, 209] [211, 211] [213, 213] [215, 215] [217, 217] [219, 219] [221, 221] [223, 223] [225, 225] [227, 227] [229, 229] [231, 231] [233, 233] [235, 235] [237, 237] [239, 239] [241, 241] [243, 243] [245, 245] [247, 247] [249, 249] [251, 251] [253, 253] [255, 255] [257, 257] [259, 259] [261, 261] [263, 263] [265, 265] [267, 267] [269, 269] [271, 271] [273, 273] [275, 275] [277, 277] [279, 279] [281, 281] [283, 283] [285, 285] [287, 287] [289, 289] [291, 291] [293, 293] [295, 295] [297, 297] [299, 299] [301, 301] [303, 303] [305, 305] [307, 307] [309, 309] [311, 311] [313, 313] [315, 315] [317, 317] [319, 319] [321, 321] [323, 323] [325, 325] [327, 327] [329, 329] [331, 331] [333, 333] [335, 335] [337, 337] [339, 339] [341, 341] [343, 343] [345, 345] [347, 347] [349, 349] [351, 351] [353, 353] [355, 355] [357, 357] [359, 359] [361, 361] [363, 363] [365, 365] [367, 367] [369, 369] [371, 371] [373, 373] [375, 375] [377, 377] [379, 379] [381, 381] [383, 383] [385, 385] [387, 387] [389, 389] [391, 391] [393, 393] [395, 395] [397, 397] [399, 399] [401, 401] [403, 403] [405, 405] [407, 407] [409, 409] [411, 411] [413, 413] [415, 415] [417, 417] [419, 419] [421, 421] [423, 421] [425, 421] [427, 421] [429, 421] [431, 431] [433, 433] [435, 435] [437, 437] [439, 439] [441, 441] [443, 443] [445, 445] [447, 447] [449, 449] [451, 451] [453, 453] [455, 455] [457, 457] [459, 459] [461, 461] [463, 463] [465, 465] [467, 467] [469, 469] [471, 471] [473, 473] [475, 475] [477, 477] [479, 479] [481, 481] [483, 483] [485, 485] [487, 487] [489, 489] [491, 491] [493, 493] [495, 495] [497, 497] [499, 499] [501, 501] [503, 503] [505, 505] [507, 507] [509, 509] [511, 511] [513, 513] [515, 515] [517, 517] [519, 519] [521, 521] [523, 523] [525, 525] [527, 527] [529, 529] [531, 531] [533, 533] [535, 535] [537, 537] [539, 539] [541, 541] [543, 543] [545, 545] [547, 547] [549, 549] [551, 551] [553, 553] [555, 555] [557, 557] [559, 559] [561, 561] [563, 563] [565, 565] [567, 567] [569, 569] [571, 571] [573, 573] [575, 575] [577, 577] [579, 579] [581, 581] [583, 583] [585, 585] [587, 587] [589, 589] [591, 591] [593, 593] [595, 595] [597, 597] [599, 599] [601, 601] [603, 603] [605, 605] [607, 607] [609, 609] [611, 611] [613, 611] [615, 611] [617, 611] [619, 611] [621, 621] [623, 623] [625, 623] [627, 627] [629, 629] [631, 631] [633, 633] [635, 635] [637, 637] [639, 639] [641, 641] [643, 643] [645, 645] [647, 647] [649, 649] [651, 651] [653, 653] [655, 655] [657, 657] [659, 659] [661, 661] [663, 663] [665, 665] [667, 667] [669, 669] [671, 671] [673, 673] [675, 675] [677, 677] [679, 679] [681, 681] [683, 683] [685, 685] [687, 687] [689, 689] [691, 691] [693, 693] [695, 695] [697, 697] [699, 699] [701, 701] [703, 703] [705, 705] [707, 707] [709, 709] [711, 711] [713, 713] [715, 715] [717, 717] [719, 719] [721, 721] [723, 723] [725, 725] [727, 727] [729, 729] [731, 731] [733, 733] [735, 735] [737, 737] [739, 739] [741, 741] [743, 743] [745, 745] [747, 747] [749, 749] [751, 751] [753, 753] [755, 755] [757, 757] [759, 759] [761, 761] [763, 763] [765, 765] [767, 767] [769, 769] [771, 771] [773, 773] [775, 775] [777, 777] [779, 779] [781, 781] [783, 783] [785, 785] [787, 787] [789, 789] [791, 791] [793, 793] [795, 795] [797, 797] [799, 799] [801, 801] [803, 803] [805, 805] [807, 807] [809, 809] [811, 811] [813, 811] [815, 811] [817, 811] [819, 811] [821, 821] [823, 821] [825, 821] [827, 821] [829, 821] [831, 831] [833, 831] [835, 831] [837, 831] [839, 831] [841, 841] [843, 841] [845, 841] [847, 841] [849, 841] [851, 851] [853, 851] [855, 851] [857, 851] [859, 851] [861, 861] [863, 861] [865, 861] [867, 861] [869, 861] [871, 871] [873, 871] [875, 871] [877, 871] [879, 871] [881, 881] [883, 881] [885, 881] [887, 881] [889, 881] [891, 891] [893, 891] [895, 891] [897, 891] [899, 891] [901, 901] [903, 901] [905, 901] [907, 901] [909, 901] [911, 901] [913, 901] [915, 901] [917, 901] [919, 901] [921, 901] [923, 901] [925, 901] [927, 901] [929, 901] [931, 901] [933, 901] [935, 901] [937, 901] [939, 901] [941, 901] [943, 901] [945, 901] [947, 901] [949, 901] [951, 901] [953, 901] [955, 901] [957, 901] [959, 901] [961, 901] [963, 901] [965, 901] [967, 901] [969, 901] [971, 901] [973, 901] [975, 901] [977, 901] [979, 901] [981, 901] [983, 901] [985, 901] [987, 901] [989, 901] [991, 901] [993, 901] [995, 901] [997, 901] [999, 901] [1001, 901] |
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
| Response | ||||||||||||||||||||
| Requested | Siting | AvailableStreaming{ResolutionSettings✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ | ||||||||||||||||||
| Result | Siting | {Result of command processing.} ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ | ||||||||||||||||||
| Data | ||||||||||||||||||||
| Stream | Integer | 0: First, 1: Second | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | |
| AvailableResolution✓ ✓ | ✓ ✓ | ✓ ✓ ✓ ✓ ✓ ✓ ✓ | ||||||||||||||||||
| 3840x2160 | Integer | 0: unselectable , 1: selectable (PZ400/510: First stream only) | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | - | ✓ | |
| 1920x1080 | Integer | 0: unselectable , 1: selectable (PZ400/200/510: First stream only) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| 1440x1080 | Integer | 0: unselectable , 1: selectable | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | |
| 1280x720 | Integer | 0: unselectable , 1: selectable (PZ400/200/510: First stream only) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| 1024x576 | Integer | 0: unselectable , 1: selectable (PZ400/200/510: First stream only) | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | |
| 720x480 | Integer | 0: unselectable , 1: selectable | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| 720x576 | Integer | 0: unselectable , 1: selectable | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | - | - | |
| 720x408 | Integer | 0: unselectable , 1: selectable | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | |
| 640x480 | Integer | 0: unselectable , 1: selectable | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | |
| 640x360 | Integer | 0: unselectable , 1: selectable | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| 480x320 | Integer | 0: unselectable , 1: selectable | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | |
| 480x270 | Integer | 0: unselectable , 1: selectable | ✓ | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | |
| 320x240 | Integer | 0: unselectable , 1: selectable | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | |
| 1080x1080 | Integer | 0: unselectable , 1: selectable | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | - | - | - | - | |
| 606x1080 | Integer | 0: unselectable , 1: selectable | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | - | - | - | - | |
| 720x720 | Integer | 0: unselectable , 1: selectable | - | - | - | - | ✓ | ✓ | - | - | - | - | - | ✓ | - | - | - | - | - | |
| 404x720 | Integer | 0: unselectable , 1: selectable | - | - | - | - | ✓ | ✓ | - | - | - | - | - | ✓ | - | - | - | - | - |
Example Example(In case of PZ400/200/510)
{
"Response": { "Response": {
"Requested": "AvailableStreamingResolutionSettings",
"Result": "Success", "Result": "Success",
"Data": { "Data": {
"AvailableResolution": {
"1920x1080": 1,
"1440x1080": 0, "3840x2160": 1,
"1280x720": 0, "1920x1080": 1,
"720x480": 0, "1280x720": 1,
"720x576": 0, "1024x576": 1,
"640x360": 0, "720x480": 1,
"480x270": 0, "720x408": 1,
{ "640x480": 1,
} "640x360": 1,
{ "480x320": 0,
} "320x240": 0
}
}
}
{
"Requested": "AvailableStreamingResolutionSettings",
"Stream": 0,
"AvailableResolution": {
}
}
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
| Request | ||||||||||||||
| Command | Siring | AvailableStreamingFramerateSettings | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| SessionID | Siting | (Session ID in cookie.) | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| Params | ||||||||||||||
| Stream | Integer | 0: First, 1: Second | - | - | - | - | - | - | - | - | - | ✓ | ✓ | |
| Resolution | Siring | "9840x2160" (PZ400/510: First stream only) | - | - | - | - | - | - | - | - | - | ✓ | - | |
| "1920x1080" (PZ400/200/510: First stream only) | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| "1280x720" (PZ400/200/510: First stream only) | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| "1024x576" (PZ400/200/510: First stream only) | - | - | - | - | - | - | - | - | - | ✓ | ✓ | |||
| "720x480" | - | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | |||
| "720x576" | - | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - | |||
| "720x408" | - | - | - | - | - | - | - | - | - | ✓ | ✓ | |||
| "640x480" | - | - | - | - | - | - | - | - | - | ✓ | ✓ | |||
| "640x360" | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| "480x320" | - | - | - | - | - | - | - | - | - | ✓ | ✓ | |||
| "320x240" | - | - | - | - | - | - | - | - | - | ✓ | ✓ | |||
| "1090x1080" | - | - | - | - | - | - | - | - | ✓ | - | - | |||
| "606x1080" | - | - | - | - | - | - | - | - | ✓ | - | - | |||
| "720x720" | - | - | - | - | ✓ | ✓ | - | - | - | ✓ | - | |||
| "404x720" | - | - | - | - | ✓ | ✓ | - | - | - | ✓ | - | |||
Example
| "Request":{ |
| "Command":"AvailableStreamingFrameratoSettings". |
| "SessionID":"7425fbcc58ee4d15ddNo1f5ece4299a3" |
| "Params":{ |
| "Resolution":"1920x1080" |
| } |
| } |
| } |
Example(In case of PZ400/200/510)
| "Request": { |
| "Command": "AvailableStreamingFrameratoSettings", |
| "SessionID": "7425fcb58ee4d150d4c1f5ace4299a3" |
| "Params": { |
| "Stream": 0. |
| "Resolution": "1920x1080" |
Response Key Style
Value
| Response | |||||||||||||
| Requested | String | AvailableStreamingFramerateSettings | - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ |
| Result | String | (Result of command processing.) | - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ |
| Data | |||||||||||||
| Stream | Integer | 0: First, 1: Second | - | - | - | - | - | - | - | - | - | √ | √ |
| Resolution | String | "3840x2160" (PZ400/510: First stream only) | - | - | - | - | - | - | - | - | - | √ | - |
| "1920x1080" (PZ400/200/510: First stream only) | - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
| "1280x720" (PZ400/200/510: First stream only) | - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
| "1024x576" (PZ400/200/510: First stream only) | - | - | - | - | - | - | - | - | - | √ | √ | ||
| "720x480" | - | √ | √ | √ | √ | √ | √ | - | √ | √ | √ | ||
| "720x576" | - | √ | √ | √ | √ | √ | √ | - | √ | √ | - | ||
| "720x408" | - | - | - | - | - | - | - | - | - | √ | √ | ||
| "640x480" | - | - | - | - | - | - | - | - | - | √ | √ | ||
| "640x360" | - | √ | √ | √ | √ | √ | √ | √ | √ | - | - | ||
| "480x320" | - | - | - | - | - | - | - | - | - | √ | √ | ||
| "320x240" | - | - | - | - | - | - | - | - | - | √ | √ | ||
| "1080x1080" | - | - | - | - | - | - | - | - | √ | - | - | ||
| "606x1080" | - | - | - | - | - | - | - | - | √ | - | - | ||
| "720x720" | - | - | - | - | √ | √ | - | - | √ | - | - | ||
| "404x720" | - | - | - | - | √ | √ | - | - | √ | - | - | ||
| AvailableFramerate | |||||||||||||
| 60p | Integer | 0: unselectable, 1: selectable | - | √ | √ | √ | √ | √ | √ | √ | √ | - | - |
| 60i | Integer | 0: unselectable, 1: selectable | - | √ | √ | √ | √ | √ | √ | √ | √ | - | - |
| 30p | Integer | 0: unselectable, 1: selectable | - | √ | √ | √ | √ | √ | √ | √ | √ | - | - |
| 50p | Integer | 0: unselectable, 1: selectable | - | √ | √ | √ | √ | √ | √ | √ | √ | - | - |
| 50i | Integer | 0: unselectable, 1: selectable | - | √ | √ | √ | √ | √ | √ | √ | √ | - | - |
| 25p | Integer | 0: unselectable, 1: selectable | - | √ | √ | √ | √ | √ | √ | √ | √ | - | - |
| 422 10bit 60p | Integer | 0: unselectable, 1: selectable | - | - | - | - | - | - | - | √ | √ | - | - |
| 422 10bit 50p | Integer | 0: unselectable, 1: selectable | - | - | - | - | - | - | - | √ | √ | - | - |
| max_25 | Integer | 0: unselectable, 1: selectable | - | - | - | - | - | - | - | - | - | √ | √ |
| max_30 | Integer | 0: unselectable, 1: selectable | - | - | - | - | - | - | - | - | - | √ | √ |
| max_50 | Integer | 0: unselectable, 1: selectable | - | - | - | - | - | - | - | - | - | √ | √ |
| max_60 | Integer | 0: unselectable, 1: selectable | - | - | - | - | - | - | - | - | - | √ | √ |
* 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/200/510)
{
"Response": { "Response": {
"Requested": "AvailableStreamingFramorateSettings",
"Result": "Success", "Result": "Success",
"Data": { "Data": {
"Resolution": "1920x1080", "Stream": 0,
"AvailableFramerate": { "Resolution": "1920x1080",
"60p": 1, "AvailableFramerate": {
"60": 0, "max_25": 0,
"30p": 0, "max_30": 0,
"50p": 0, "max_50": 0,
"50": 0, "max_60": 1
"25p": 0, }
"422_10bit_60p": 0, }
"422_10bit_50p": 0 }
}
}
}
"Requested": "AvailableStreamingFramerateSettings",
3.1.7. Available streaming bitrate settings
Get available streaming bitrate settings
Request Key Style
| Type | Value | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H 4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4701 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4800 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Request | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Command | String | AvailableStreamingBitrateSettings✓✓✓✓✓✓✓✓✓✓✓✓✓✓✓ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SessionID | String | (Session ID in cookie.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | √ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | < | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Params | ✓ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Stream | Integer | 0: First, 1: Second | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | String | "UDP"/"UDPN"(PCR Jitter is -rmal)/"UDPL"(PCR Jitter is Low)/"TCP"/"RTSP"/"ZIXM"(Zxi Medium/Minimum/High Latency)/"ZIXIL"(Zxi Low Latency)/"ZIXI"/"RTMP"/"RTMPS"/"RTP"/"Facebook"/"YouTube"/"SRT" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | √ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | >200000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000.000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 19920x1980"(PZ400/200/510: First stream only) -1920x1980"(PZ400/200/510: First stream only)-1280x720"(PZ400/200/510: First stream only)-1024x576"(PZ400/200/510: First stream only)-720x480"-720x576"-720x480"-640x360"-480x320"-320x240"-1080x1080"-606x1080"-720x720"-404x720"60p" "50p" "60p" "50p" "30p" "25p"Character string for Framerate value "1" - "60" | -422_10b1_60p" "422_10bit_50p"Character string for Framerate value "1" - "60" | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
* Framerate "422_10bit_60p" and "422_10bit_50p" are effective only if optional adaptor "KA-EN200" is attached on 'GY-HC900' and 'GY-HC5x0'.
* Character string for Framerate value for PZ400/200/510: If the Video setting is 59.94/29.27, then 60-59.94 and 30-29.97.
Example Example(In case of PZ400/200/510)
| "Request": { "Request": { |
| "Command": "AvailableStreamingFiltrateSettings", "SessionID": "7425fbb58ee4d15dd4c1f5ace4299a3", "Params": { "Params": { |
| "Type": TCP", "Stream": 0, "Resolution": "1920x1080", "Framerate": "600", "Resolution": "1920x1080", "Framerate": "30" |
| } "Framerate": "30" |
| } |
| } |
"Command": "AvailableStreamingBitrateSettings", "SessionID": "7425bcb68ee4d15dd4c1f5ace4299a3",
"Type": "RTSP",
Response Key Style
Value
| Response | |||||||||||||||
| Requested | String | AvailableStreamingBitrateSettings / √ √ √ √ √ √ √ √ √ √ √ | |||||||||||||
| Result | String | (Result of command processing.) √ √ √ √ √ √ √ √ √ √ √ | |||||||||||||
| Data | |||||||||||||||
| Stream | Integer | 0: First, 1: Second | - | - | - | - | - | - | - | - | - | - | - | √ | √ |
| Type | String | "UDP" / | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | √ |
| "UDPN" (PCR Jitter is -rmal) / | - | √ | √ | - | - | - | - | - | - | - | - | - | - | ||
| "UDPL" (PCR Jitter is Low) / | - | √ | √ | - | - | - | - | - | - | - | - | - | - | ||
| "TCP" / | √ | - | - | - | - | - | - | - | - | √ | - | - | - | ||
| "RTSP" / | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
| "ZIXIM" (Zxi Medium/Minimum/High Latency) / | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - | ||
| "ZIXIL" (Zxi Low Latency) / | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - | ||
| "ZIXI" / | - | - | - | - | - | - | - | - | - | √ | - | - | - | ||
| "RTMP" | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
| "RTMPS" / | - | - | - | - | √ | √ | - | √ | √ | √ | √ | √ | √ | ||
| "RTP" / | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | √ | ||
| "Facebook" / | - | - | - | - | √ | √ | - | - | - | √ | - | - | - | ||
| "You tube" / | - | - | - | - | - | - | - | - | - | √ | - | - | - | ||
| "SRT" | - | - | - | - | - | - | - | - | - | √ | √ | √ | √ | ||
| Resolution | String | "3840x2160" (PZ400/510: First stream only) | - | - | - | - | - | - | - | - | - | - | √ | - | √ |
| "1920x1080" (PZ400/200/510: First stream only) | - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
| "1280x720" (PZ400/200/510: First stream only) | - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
| "1024x576" (PZ400/200/510: First stream only) | - | - | - | - | - | - | - | - | - | - | √ | √ | √ | ||
| "720x480" | - | √ | √ | √ | √ | √ | √ | - | √ | √ | √ | √ | √ | ||
| "720x576" | - | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | ||
| "720x408" | - | - | - | - | - | - | - | - | - | - | √ | √ | √ | ||
| "640x480" | - | - | - | - | - | - | - | - | - | - | √ | √ | √ | ||
| "640x360" | - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
| "480x320" | - | - | - | - | - | - | - | - | - | - | √ | √ | √ | ||
| "320x240" | - | - | - | - | - | - | - | - | - | - | √ | √ | √ | ||
| "1080x1080" | - | - | - | - | - | - | - | - | - | √ | - | - | - | ||
| "606x1080" | - | - | - | - | - | - | - | - | - | √ | - | - | - | ||
| "720x720" | - | - | - | - | √ | √ | - | - | - | √ | - | - | - | ||
| "404x720" | - | - | - | - | √ | √ | - | - | - | √ | - | - | - | ||
| Framerate | String | "60p" / "50p" / "60l" / "50l" / "30p" / "25p" / | - | - | - | - | - | - | - | √ | √ | √ | - | - | |
| "422 10bit 60p" / "422 10bit 50p" | - | - | - | - | - | - | - | - | √ | √ | - | - | - | ||
| Character string for Framerate value "1" - "60" | - | - | - | - | - | - | - | - | - | - | √ | √ | √ |
| AvailableBitrate | |||||||||||||||||||
| 0.2M | integer | 0 : unselectable , 1 : selectable √ - - - - - - - - - - - - - | |||||||||||||||||
| 0.3M | integer | 0 : unselectable , 1 : selectable √ √ √ √ √ √ √ √ √ - - - | |||||||||||||||||
| 0.8M | integer | 0 : unselectable , 1 : selectable √ √ √ √ √ √ √ √ √ - - - | |||||||||||||||||
| 1.5M | integer | 0 : unselectable , 1 : selectable √ √ √ √ √ √ √ √ √ - - - | |||||||||||||||||
| 2.5M | integer | 0 : unselectable , 1 : selectable - - - - - - - - - - - - - - | |||||||||||||||||
| 3.0M | integer | 0 : unselectable , 1 : selectable √ √ √ √ √ √ √ √ - - - | |||||||||||||||||
| 5.0M | integer | 0 : unselectable , 1 : selectable √ √ √ √ √ √ √ √ √ - - - | |||||||||||||||||
| 8.0M | integer | 0 : unselectable , 1 : selectable √ √ √ √ √ √ √ √ √ - - - | |||||||||||||||||
| 10M | integer | 0 : unselectable , 1 : selectable - - - - - - - - - - - - | |||||||||||||||||
| 12M | integer | 0 : unselectable , 1 : selectable √ √ √ √ √ √ √ √ - - - | |||||||||||||||||
| 16M | integer | 0 : unselectable , 1 : selectable | - - - - - - - - - - √ √ √ - - - | ||||||||||||||||
| 20M | integer | 0 : unselectable , 1 : selectable | - - - - - - - - - - √ √ √ - - - | ||||||||||||||||
| 24M | integer | 0 : unselectable , 1 : selectable | - - - - - - - - - - - √ √ - - - | ||||||||||||||||
| 32K-61440K | integer | 0 : unselectable , 1 : selectable * For the second stream, read as 32K 20480K. | - - - - - - - - - - - √ √ √ | ||||||||||||||||
* Framerate *422 10bit 60p* and "422 10bit 50p" are effective only if optional adaptor "KA-EN200" is attached on 'GY-HC900' and 'GY-HC5x0'.
* Character string for Framerate value for PZ400/200/510 : If the Video setting is 59.94/29.27, then 60=59.94 and 30=29.97.
Example Example(In case of PZ400/200/510)
{
"Response": { "Response": {
"Requested": "AvailableStreamingBitrateSettings",
"Result": "Success", "Result": "Success",
"Data": { "Data": {
"Type": "TCP", "Stream": 0,
"Resolution": "1920x1080", "Typo": "RTSP",
"Framerate": "80p", "Resolution": "1920x1080",
"AvailableBitrate": { "Framerate": "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": "AvailableStreamingBikrateSettings",
3.1.8. Get current streaming server number
Get current streaming server ID.
There are four settings of streaming server.
| Request Key Size Value | ||
| Command | String | GetCurrentStreamingServerID √ √ √ √ √ √ √ √ √ - - - |
| SessionID | String | (Session ID in cookie.) |
Example
| "Request": |
| "Command": "GetCurrentStreamingServerID", |
| "SessionID": "7425f0c658ee4d15dd4c1f5ace4298a3" |
| Response Key Style Value | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Requested | Siting | GetCurrentStreamingServerID √ √ √ √ √ √ √ √ √ - - - | - | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Result | Siting | (Result of command processing.) √ √ √ √ √ √ √ √ √ √ - - - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ID | Integer | 0:server1, 1: server2, 2: server3, 3: server4 | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | V | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | ✗ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | □ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | × | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example
| 'Response': { |
| "Requested": "GetCurrentStreamingServerID", |
| 'Result': 'Success', |
| 'Data': { |
| "ID': 3 |
| } |
| } |
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
| Request | |||||||||||||||||||
| Command | Siting | SetCurrentStreamingServerID √ √ √ √ √ √ √ √ √ - - - | |||||||||||||||||
| SessionID | Siting | (Session ID in cookie.) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - | |||
| Params | |||||||||||||||||||
| ID | Integer | 0:server1, 1: server2, 2: server3, 3: server4 | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - | |||
Example
| "Request": { |
| "Command": "SetCurrentStreamingServerID", |
| "SessionID": "7425fbb586e4d150d4c1f5ace4299a3", |
| "Params": { |
| "ID": 3 |
| } |
| } |
Response Key Style
Value
| Response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Requested | Siting | SetCurrentStreamingServerID | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Result | Siting | (Result of command processing.) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example
| { |
| "Response": { |
| "Requested": "SetCurrentStreamingServerID". |
| "Result": "Success" |
| } |
3.1.10. Get streaming server settings
Get streaming settings for each server ID.
Request Key Style
Value
| Request | |||||||||||||||||||||
| Command | Siring | GetStreamingServerSettings✓✓✓✓✓✓✓✓✓✓✓✓✓ | |||||||||||||||||||
| SessionID | Siring | (Session ID in cookie.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ||
| Params | |||||||||||||||||||||
| ID | Integer | 0:server1, 1: server2, 2: server3, 3: server4 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | ||
| Type | Siring | "RTSP" / "RTSP2" / "RTMP" / "RTMP2" / "RTMPS" / "RTMPS2" / "SRT" / "Multicast" / "NDI" | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | ||
| "RTSP" / "RTSP2" / "RTMP" / "RTMP2" / "RTMPS" / "RTMPS2" / "SRT" / "NDI" / "MPEG2 TS2" / "MPEG2 TS2" | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | ||||
Example Example(In case of PZ400/200/510)
| "Request": { "Request": { "Command": "GetStreamingServerSettings", "SessionID": "7425bcb58ee4d15db4c15aco4299a3", "Params": { "Params": { "ID": 1 } } } | { "Command": "GetStreamingServerSettings", "SessionID": "7425bcb58ee4d15db4c15aco4299a3", "Type": "RTSP" } } } |
Response
Value
| Response | |||||||||||||||||
| Requested | Sling | GetStreamingServerSettings✓✓✓✓✓✓✓✓✓✓✓✓ | |||||||||||||||
| Result | Sling | (Result of command processing.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| Data | |||||||||||||||||
| Alias | Sling | (Another name of server) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | |
| Type | Sling | "UDP"/ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | |
| "TCP"/ | ✓ | - | - | - | - | - | - | - | - | ✓ | ✓ | - | - | - | |||
| "RTSP"/ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| "RTSP2"/ | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | |||
| "ZIXI"/ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | |||
| "RTMP" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| "RTMP2" | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | |||
| "RTMPS"/ | - | - | - | - | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| "RTMPS2"/ | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | |||
| "RTP"/ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | |||
| "Facebook"/ | - | - | - | - | ✓ | ✓ | - | - | - | ✓ | - | - | - | - | |||
| "YouTube"/ | - | - | - | - | - | - | - | - | - | ✓ | - | - | - | - | |||
| "SRT" | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| "Multicast" | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | |||
| "NDI" | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | |||
| "MPEG2-TS" | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | |||
| "MPEG2-TS2" | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | |||
| Udp (Selected by Type) | ||||||||||||||||
| DstAddress | String | (IP address) √ √ √ √ √ √ √ √ - - - | ||||||||||||||
| DstPort | Integer | (Port number) √ √ √ √ √ √ √ √ - - - | ||||||||||||||
| PcrJitter | Integer | 0:-RMAL, 1:LOW | - | √ | √ | √ | √ | √ | √ | - | - | - | - | - | - | - |
| PcrMode | Integer | 0:Standard, 1:Fast | - | - | - | - | - | - | - | - | - | √ | √ | - | - | - |
| Tcp (Selected by Type) | ||||||||||||||||
| DstAddress | String | (IP address) | √ | - | - | - | - | - | - | - | - | √ | √ | - | - | - |
| DstPort | Integer | (Port number) | √ | - | - | - | - | - | - | - | - | √ | √ | - | - | - |
| Risp (Selected by Type) | ||||||||||||||||
| DstPort | Integer | (Port number) √ √ √ √ √ √ √ √ √ √ √ | ||||||||||||||
| StreamId | String | (Stream ID) √ √ √ √ √ √ √ √ √ √ √ | ||||||||||||||
| Username | String | (User name) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - |
| Password | String | (Password for RTSP:RTP) √ √ √ √ √ √ √ √ √ - - - | ||||||||||||||
| Auth | Integer | 0:OFF, 1:ON | - | - | - | - | - | - | - | - | - | - | - | √ | √ | √ |
| Zixi (Selected by Type) | ||||||||||||||||
| DstAddress | String | (IP address) √ √ √ √ √ √ √ √ √ - - - | ||||||||||||||
| DstPort | Integer | (Port number) √ √ √ √ √ √ √ √ √ √ - - - | ||||||||||||||
| StreamId | String | (Stream ID for ZIXI) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - |
| Password | String | (Password for ZIXI) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - |
| Latency | Integer | 0:Low, 1:Medium, 2:Minimum(Zixi OFF), 3:High | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - |
| PcrMode | Integer | 0:Standard, 1:Fast | - | - | - | - | - | - | - | - | - | √ | √ | - | - | - |
| AdaptiveBitrate | Integer | 0:OFF, 1:ON | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - |
| Rimp | (Selected by Type) | |||||||||||||||
| DstUrl | String | (Network URL for Delivery) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ |
| StreamKey | String | (Key for Delivery) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ |
| Status | Integer | 0:OFF, 1:ON | - | - | - | - | - | - | - | - | - | - | - | √ | √ | √ |
| Video | Integer | 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | √ | √ | √ |
| Audio | Integer | 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | √ | √ | √ |
| Rimps | (Selected by Type) | |||||||||||||||
| DstUrl | String | (Network URL for Delivery) | - | - | - | - | √ | √ | - | √ | √ | √ | √ | √ | √ | √ |
| StreamKey | String | (Key for Delivery) | - | - | - | - | √ | √ | - | √ | √ | √ | √ | √ | √ | √ |
| Status | Integer | 0:OFF, 1:ON | - | - | - | - | - | - | - | - | - | - | - | √ | √ | √ |
| Video | Integer | 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | √ | √ | - |
| Audio | Integer | 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | √ | √ | √ |
| Rtp (Selected by Type) | ||||||||||||||||
| DstAddress | String | (IP address) | - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - |
| DstPort | Integer | (Port number) | - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - |
| PcrMode | Integer | 0:Standard, 1:Fast | - | - | - | - | - | - | - | - | - | √ | √ | - | - | - |
| Simple2022Foc | Integer | 0:OFF, 1:ON | - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - |
| FecMatrixL | Integer | 4 - 20 | - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - |
| FecMatrixD | Integer | 4 - 20 | - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - |
| Srt | (Selected by Type) | |||||||||||||||
| DstAddress | String | (IP address) | - | - | - | - | - | - | - | - | - | √ | √ | √ | √ | √ |
| DstPort | Integer | (Port number) | - | - | - | - | - | - | - | - | - | √ | √ | √ | √ | √ |
| StreamId | String | (Stream ID for SRT) | - | - | - | - | - | - | - | - | - | √ | √ | √ | √ | √ |
| ConnectionMode | Integer | 0: Caller, 1:Listener, 2: Rendezvous | - | - | - | - | - | - | - | - | - | √ | √ | √ | √ | √ |
| BandwidthOverhead | Integer | 5 - 100 | - | - | - | - | - | - | - | - | - | √ | √ | √ | √ | √ |
| Latency | Integer | 20 - 8000 | - | - | - | - | - | - | - | - | - | √ | √ | √ | √ | √ |
| Encryption | Integer | 0: Off, 1: AES-128, 2: AES-192, 3: AES-256 | - | - | - | - | - | - | - | - | - | √ | √ | √ | √ | √ |
| FEC | Integer | 0: Off, 1: 10x10, 2: 8x8, 3: 6x6 | - | - | - | - | - | - | - | - | - | √ | √ | √ | √ | √ |
| AdaptiveBitrate | Integer | 0:OFF, 1:ON | - | - | - | - | - | - | - | - | - | √ | √ | - | - | - |
| PcrMode | Integer | 0:Standard, 1:Fast | - | - | - | - | - | - | - | - | - | √ | √ | - | - | - |
| Passphrase | String | ASCII 10-79 character | - | - | - | - | - | - | - | - | - | √ | √ | √ | √ | √ |
| Status | Integer | 0:OFF, 1:ON | - | - | - | - | - | - | - | - | - | - | - | √ | √ | √ |
| Multicast (Selected by Type) | |||||||||||||||
| Status | Integer | 0:OFF, 1:ON | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - |
| DstAddress | String | (IP address) | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - |
| DstPort | Integer | (Port number) | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - |
| Nci (Selected by Type) | |||||||||||||||
| DeviceName | String | (text) | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ |
| GroupName | String | (text) | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ |
| Mpeg2Ts (Selected by Type "MPEG2-TS" and "MPEG2-TS2") | |||||||||||||||
| Type | Integer | 0: UDP, 1: RTP 'A setting for either MPEG-TS or MPEG-TS2 is valid for both. | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| DstAddress | String | (IP address / Server name) *Multicast address is valid | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| DstPort | Integer | (Port number) -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- - √ | |||||||||||||
| Status | Integer | 0:OFF, 1:ON -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- | - | ||||||||||||
Example Example(In case of PZ400/200/510)
{
"Response": { "Response": {
"Requested": "GetStreamingServerSettings",
"Result": "Success",
"Data": {
"Alias": "Server1",
"Type": "TCP",
"Tcp": {
"DstAddress": "192.168.0.1",
"DstPort": 6504
}
}
}
{
"Requested": "GetStreamingServerSettings",
"Result": "Success",
"Data": {
"Type": "RTSP",
"Rtsp": {
"DstPort": 554,
"StreamId": "",
"Auth": 1
}
}
}
3.1.11. Set streaming server settings(UDP)
Set streaming settings for each server ID.
Request Key Style
| Systc | Value | H4650 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H 4700 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Request | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Command | Sling | SetStreamingServerSettingsUDP √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∞ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∫ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∦ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∬ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∪ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∜ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∭ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∨ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∩ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∯ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∶ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∮ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∖ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∸ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∥ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∎ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∤ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∵ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∧ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∟ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∼ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∿ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∑ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∂ (√) (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∏) (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ ( ) (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∐) (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (\ ) (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ ()) (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∸) (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ \textsuperscript* { ~ } ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ (~) (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ (∑ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example
| "Request":{ |
| "Command": "SetStreamingServerSettingsUDP", |
| "SessionID": "7425bcb58ee4d15dd4c1f5ace4299a3", |
| "Params":{ |
| "ID": 1, |
| "Alias": "Servor1", |
| "DstAddress": "192.168.0.1", |
| "DstPort": 6504, |
| "PorJitter": 1 |
| } |
| } |
Response Key Style
| By Style | Value | H4M50 | H4M60 | H4M80 | H4M20 | H4M25x | H4M80 | H4M30 | C5X70 | P7100 | H4M90 | H4M50 | H4M40 | P7200 | P2510 | ||
| Response | |||||||||||||||||
| Requested | Sling | SetStreamingServerSettingsUDP √ √ √ √ √ √ √ √ √ √ - - - | |||||||||||||||
| Result | Sling | {Result of command processing.} √ √ √ √ √ √ √ √ √ - - - | |||||||||||||||
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
| Request | |||||||||||||||
| Command | Siring | SetStreamingServerSettingsTCP | √ | - | - | - | - | - | - | √ | √ | - | - | - | |
| SessionID | Siring | (Session ID in cookie.) | √ | - | - | - | - | - | - | √ | √ | - | - | - | |
| Params | |||||||||||||||
| ID | Integer | 0:server1, 1: server2, 2: server3, 3: server4 | √ | - | - | - | - | - | - | √ | √ | - | - | - | |
| Alias | Siring | (Another name of server) | √ | - | - | - | - | - | - | √ | √ | - | - | - | |
| DatAddress | Siring | (IP address) | √ | - | - | - | - | - | - | √ | √ | - | - | - | |
| DstPort | Integer | (Port number) | √ | - | - | - | - | - | - | √ | √ | - | - | - | |
Example
| "Request": { |
| "Command": "SetStreamingServerSettings1CP", "SessionID": "7425fbcb58ee4d15dd4c15aco4299a3", "Params": { |
| "ID": 1, |
| "Alias": "Server1", "DatAddress": "192.168.0.1", "DatPont": 6504} |
Response Key Style
Value
| Response | ||||||||||||||
| Requested | String | SetStreamingServerSettingsTCP | √ | - | - | - | - | - | - | - | √ | √ | - | - |
| Result | String | (Result of command processing.) | √ | - | - | - | - | - | - | - | √ | √ | - | - |
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
| Request | ||||||||||||||||||
| Command | String | Set:StreamingServerSettingsRTSP✓✓✓✓✓✓✓✓✓✓✓✓✓✓ | ||||||||||||||||
| SessionID | String | (Session ID in cookie.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| Params | ||||||||||||||||||
| ID | Integer | 0:server1, 1: server2, 2: server3, 3: server4 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | |
| Alias | String | (Another name of server)✓✓✓✓✓✓✓✓✓✓--- | ||||||||||||||||
| Username | String | (Username for RTSP/RTP) | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | - | - | |
| Password | String | (Password for RTSP/RTP)✓✓✓✓✓✓✓✓✓✓--- | ||||||||||||||||
| DstPort | Integer | (Port number) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | |
| Auth | Integer | 0:OFF, 1:ON | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ✓ | |
Example Example(In case of PZ400/200/510)
| "Request": {Command": "SetStreamingServerSettingsRTSP", "SessionID": "7425fcbc58ee4d15dd4c15ace4299a3", "Params": {"ID": 1, "Alias": "Server1", "Username": "user", "Password": "abcde"} } | "Request": {Command": "SetStreamingServerSettingsRTSP", "SessionID": "7425fcbc58ee4d15dd4c15ace4299a3", "Params": {"DstPort": 554, "Auth": {}} } } |
Response Key Style
Value
| Response | ||||||||||||||||||||||
| Requested | String | Set:StreamingServerSettingsRTSP √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∞ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∭ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∶ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∪ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∨ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∬ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∮ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∯ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∜ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∤ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∵ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∖ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∫ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∦ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∎ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∸ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∥ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∩ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∿ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∧ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∑ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∟ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∞ √ √ √ √ √ √ √ √ √ √ √ √ ∞ √ √ √ √ √ √ √ ∞ √ √ √ √ √ √ ∞ √ √ √ √ √ √ ∞ √ √ √ √ √ ∞ √ √ √ √ √ ∞ √ √ √ √ ∞ ∞ √ √ √ √ √ ∞ ∞ √ √ √ √ √ ∞ ∞ √ √ √ √ √ ∞ ∞ √ √ √ √ √ ∞ ∞ √ √ √ √ √ ∞ ∞ √ √ √ √ √ ∞ ∞ √ √ √ √ √ ∞ ∞ √ ∞ | ||||||||||||||||||||
| Result | String | (Result of command processing.) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
Example
| 'Response' : { "Requested" : "SetStreamingServerSettingsATSP", "Result" : "Success"} |
3.1.14. Set streaming server settings(ZIXI)
Set streaming settings for each server ID.
Request Key Style
Value
| Request | |||||||||||||||||||
| Command | String | SetStreamingServerSettingsZIXI | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - | |
| SessionID | String | (Session ID in cookie.) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - | |
| Params | |||||||||||||||||||
| ID | Integer | 0:server1, 1: server2, 2: server3, 3: server4 | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - | |
| Alias | String | (Another name of server) √ √ √ √ √ √ √ √ √ - - - | |||||||||||||||||
| DstAddress | String | (IP address) √ √ √ √ √ √ √ √ √ - - - | |||||||||||||||||
| DstPort | Integer | (Port number) √ √ √ √ √ √ √ √ √ - - - | |||||||||||||||||
| StreamId | String | (Stream ID for ZIXI) √ √ √ √ √ √ √ √ √ - - - | |||||||||||||||||
| Password | String | (Password for ZIXI) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - | |
| Latency | Integer | 0:Low, 1:Medium, 2:Minimum(Zixi OFF), 3:High | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - | |
| PcrMode | Integer | 0:Standard, 1:Fast | - | - | - | - | - | - | - | - | - | - | - | √ | √ | - | - | - | |
| AdaptiveBitrate | Integer | 0:OFF, 1:ON √ √ √ √ √ √ √ √ - - - | |||||||||||||||||
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": "7425fcbc58ee4d15dd4c1f5acc4299a3", |
| "Params": { |
| "ID": 1, |
| "Alias": "Server1", |
| "DstAddress": "192.168.0.1", |
| "DstPort": 2088, |
| "StreamId": "NM650-1234", |
| "Password": "abode", |
| "Latency": 1, |
| "AdaptiveBitrate": 0 |
| } |
| } |
Response Key Style
Value
| Response | |||||||||||||||
| Requested | Sitting | SatStreamingServerSettingsZIXI | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | |
| Result | Sitting | (Result of command processing.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - |
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
| Request | ||||||||||||||||||||||
| Command | Siring | SetStreamingServerSettingsRTMP √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∞ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∨ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∦ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∭ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∪ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∫ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∮ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∬ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∜ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∶ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∖ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∯ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∤ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∵ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∎ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∸ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∩ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∥ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∿ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∧ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∟ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∂ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∤ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∝ \{√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√} | ||||||||||||||||||||
Example Example(In case of PZ400/200/510)
"Request": {
"Command": "SetStreamingServerSettingsRTMF",
"SessionID": "74250bcb58e04d150b4c16a0c4299a3",
"Params": {
"ID": 1,
"Alias": "Server1",
"DatUrl": "http://xxx.xxxx.xxxx-xxx.com/play",
"StreamKey": "livestreaming"
}
}
"Request": {
"Command": "SetStreamingServerSettingsRTMF",
"SessionID": "7425tbc658ce4d15d4c15aco4299a3",
"Params": {
"Stream": 0,
"DstUrl": "http://xxxx.xxxx.xxxx-xxx.com/live",
"StreamKey": "stream0",
"Status": 1,
"Video": 0,
"Apolio": 0
}
}
Response
Value
| Response | ||||||||||||||||||||
| Requested | Siting | SetStreamingServerSettingsRTMP √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∞ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∭ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∶ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∂ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∨ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∯ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∮ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∪ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∬ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∜ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∤ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∖ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∫ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∦ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∎ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∵ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∸ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∩ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∥ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∞ √ √ √ √ √ √ √ √ ∞ √ √ √ √ √ √ √ ∞ √ √ √ √ √ √ ∞ √ √ √ √ √ √ ∞ √ √ √ √ √ ∞ √ √ √ √ √ ∞ √ √ √ √ √ ∞ √ √ √ √ √ ∞ √ √ √ √ √ ∞ √ √ √ √ √ ∞ √ √ √ √ √ ∞ √ √ √ √ √ ∞ √ ∞ √ √ √ √ ∞ √ ∞ √ √ √ √ ∞ √ ∞ √ √ √ √ ∞ √ ∞ √ √ √ √ ∞ √ ∞ √ √ √ √ ∞ √ ∞ ∞ √ √ √ √ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∝ \{√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√,√} |
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
| Request | ||||||||||||||
| Command | Siring | SetStreamingServerSettingsRTMPS | - | - | - | - | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | |
| SessionID | Siring | (Session ID in cookie.) | - | - | - | - | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | |
| Params | ||||||||||||||
| ID | Integer | 0:server1, 1: server2, 2: server3, 3: server4 | - | - | - | - | ✓ | ✓ | - | ✓ | ✓ | - | - | |
| Alias | Siring | (Another name of server) | - | - | - | - | ✓ | ✓ | - | ✓ | ✓ | - | - | |
| Stream | Integer | 0: First, 1: Second | - | - | - | - | - | - | - | - | - | ✓ | ✓ | |
| DstUrl | Siring | (Network URL for Delivery) | - | - | - | - | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | |
| StreamKey | Siring | (Key for Delivery) | - | - | - | - | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | |
| Status | Integer | 0:OFF, 1:ON (Other settings are valid when this is ON.) | - | - | - | - | - | - | - | - | - | ✓ | ✓ | |
| Video | Integer | 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | ✓ | ✓ | |
| Audio | Integer | 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | ✓ | ✓ | |
Example Example(In case of PZ400/200/510)
| {"Request": { "Command": "SetStreamingServerSettingsRTMPS", "SessionID": "7425fbb68ee4d15dd4c15ace4299a3", "Params": { "ID": 1, "Alias": "Server1", "DstUI": "nmps/xxxxxxxxxxxxxx.com/play", "StreamKey": "livestreaming" }} } |
Response
Value
| Response | ||||||||||||||
| Requested | String | SetStreamingServerSettingsRTMPS | - | - | - | - | ✓ | ✓ | - | ✓ | - | ✓ | ✓ | ✓ |
| Result | string | (Result of command processing.) | - | - | - | - | ✓ | ✓ | - | ✓ | - | ✓ | ✓ | ✓ |
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
| Request | ||||||||||||||
| Command | Siting | SetStreamingServerSettingsRTP | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | |
| SessionID | Siting | (Session ID in cookie.) | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | |
| Params | ||||||||||||||
| ID | Integer | 0:server1, 1: server2, 2: server3, 3: server4 | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | |
| Alias | String | (Another name of server) | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | |
| DstAddress | Siting | (IP address) | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | |
| DstPort | Integer | (Port number) | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | |
| PortMode | Integer | 0:Standard, 1:Fast | - | - | - | - | - | - | - | ✓ | ✓ | - | - | |
| Smpte2022Fec | Integer | 0:OFF, 1:ON | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | |
| FecMatrixL | Integer | 4 - 20 | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | |
| FecMatrixD | Integer | 4 - 20 | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | |
* FecMatorixL and FecMatrixD value are satisfy A×B=100 condition.
Example
| "Request": { |
| "Command": "SetStreamingServerSettingsRTP", |
| "SessionID": "7425ibcb58ee4d15dd4c1f5ace4299e3", |
| "Params": { |
| "ID": 1, |
| "Alias": "Server1", |
| "DstAddress": "192.168.0.1", |
| "DstPort": 2088, |
| "Simple2022Fac": 1, |
| "FecMatrixL": 10, |
| "FecMatrixD": 10 |
| } |
| } |
Response Key Style
Value
| Response | ||||||||||||||
| Requested | String | SetStreamingServerSettingsRTP | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - |
| Result | String | (Result of command processing.) | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - |
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
| Request | |||||||||||||||
| Command | String | SetStreamingServerSettingsSRT | - | - | - | - | - | - | - | - | √ | √ | √ | √ | |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | √ | √ | √ | |
| Params | |||||||||||||||
| ID | integer | 0:server1, 1: server2, 2: server3, 3: server4 | - | - | - | - | - | - | - | - | √ | √ | - | - | |
| Alias | string | (Another name of server) | - | - | - | - | - | - | - | - | √ | √ | - | - | |
| DstAddress | string | (IP Address) | - | - | - | - | - | - | - | - | - | √ | √ | √ | |
| DstPort | integer | 1 - 65535 | - | - | - | - | - | - | - | - | √ | √ | √ | √ | |
| StreamId | string | (Stream ID for SRT) | - | - | - | - | - | - | - | - | √ | √ | √ | √ | |
| ConnectionMode | integer | 0: Caller 1: Listener, 2: Rendezvous | - | - | - | - | - | - | - | - | - | √ | √ | √ | |
| BandwidthOverhead | integer | 5 - 100 | - | - | - | - | - | - | - | - | √ | √ | √ | √ | |
| Latency | integer | 20 - 8000 | - | - | - | - | - | - | - | - | √ | √ | √ | √ | |
| Encryption | integer | 0: OFF, 1: AES-128, 2: AES-192 3: AES-256 | - | - | - | - | - | - | - | - | √ | √ | √ | √ | |
| FEC | integer | 0: OFF, 1: 10x10, 2: 8x8 3: 6x6 | - | - | - | - | - | - | - | - | √ | √ | √ | √ | |
| AdaptiveBitrate | integer | 0:OFF, 1:ON | - | - | - | - | - | - | - | - | √ | √ | - | - | |
| PcrMode | integer | 0:Standard, 1:Fast | - | - | - | - | - | - | - | - | √ | √ | - | - | |
| Passphrase | string | ASCII 10-79 character | - | - | - | - | - | - | - | - | √ | √ | √ | √ | |
| Status | integer | 0: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.) | - | - | - | - | - | - | - | - | - | √ | √ | √ | |
Example
| "Request":{ |
| "Command": "SetStreamingServerSettingsSRT", |
| "SessionID": "7425fbbc58ee4d1504c15a0e4299a3", |
| "Params":{ |
| "ID": 0, |
| "Alias": "Server1", |
| "DstAddress": "192.168.0.1", |
| "DstPort": 6504 |
| "ConnectionMode": 0 |
| "BandwidthOverhead": 10 |
| "Latency": 20 |
| "Encryption": 0 |
| "Passphrase": "abcdefghijklmnopqrstuvwxyz", |
| } |
| } |
Example(In case of PZ400/200/510)
| "Request":{ |
| "Command": "SetStreamingServerSettingsSRT", "SessionID": "7425fbbc58ee4d15ddfc16ace4299a3", "Params":} |
| "DstAddress": "192.0.2.1", "DstPort": 4578, "StreamId": "P2510-AABBCCDD", "ConnectionMode": 1, "BandwidthOverhead": 25, "Latency": 500, "Encryption": 0, "FEC": 0, "Passphrase": "1234567890", "Status": 1} |
Response Key Style
Value
| Response | ||||||||||||||
| Requested | String | SetStreamingServerSettingsSRT | - | - | - | - | - | - | - | - | √ | √ | √ | √ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | √ | √ | √ | √ |
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
| Request | |||||||||||||||
| Command | String | SetStreamingEncodeProtocol | - | - | - | - | - | - | - | - | - | - | √ | √ | |
| SessionID | String | {Session ID in cookie.} | - | - | - | - | - | - | - | - | - | - | - | √ | |
| Params | |||||||||||||||
| Stream | Integer | 0: First, 1: Second | - | - | - | - | - | - | - | - | - | - | √ | √ | |
| EncodeProtocol | String | "H264" / "H265" / "MJPEG" | - | - | - | - | - | - | - | - | - | - | √ | √ | |
Example
| "Request":{ |
| "Command": "SetStreamingEncodeProtocol", |
| "SessionID": "7425fcbc58ee4d15dd4c15ace4299a3", |
| "Params":{ |
| "Stream": 0. |
| "EncodeProtocol": "H264" |
| } |
| } |
Response Key Style
Value
| Response | ||||||||||||
| Requested | String | Set:StreamingEncodeProtocol | ||||||||||
| Result | String | (Result of command processing.) | ||||||||||
Example
| "Response":{ "Requested": "SetStreamingEncodeProtocol", "Result": "Success" } |
3.1.20. Set Streaming | Key Frame Interval
Set Streaming | Key Frame Interval
This setting will not take effect until reboot.
Request Key Style
Value
| Request | ||||||||||||||
| Command | String | SetStreaming|KeyFrameInterval | - | - | - | - | - | - | - | - | - | √ | √ | |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | √ | |
| Params | ||||||||||||||
| Stream | Integer | 0: First. 1: Second | - | - | - | - | - | - | - | - | - | √ | √ | |
| Interval | Integer | Value of 1 Key Frame Interval 2 - 60 | - | - | - | - | - | - | - | - | - | √ | √ | |
Example
| "Request":{ |
| "Command": "SetStreaminglKeyFrameInterval". |
| "SessionID": "7425fcbc58ee4d150d4c1f5ace4299a3". |
| "Params":{ |
| "Stream": 0. |
| "Interval": 30 |
| } |
| } |
Response Key Style
Value
| Response | ||||||||||||
| Requested | String | SetStreaming|KeyFrameInterval | ||||||||||
| Result | String | (Result of command processing.) | ||||||||||
Example
| "Response":{ "Requested": "SetStreaming/KeyFrameInterval", "Result": "Success" } |
3.1.21. Get Video Settings
Get the Video settings
Request Key Style
Value
| Request | ||||||||||||
| Command | String | GetVideoSettings | - | - | - | - | - | - | - | - | √ | √ |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | √ | √ |
Example
| "Request": { |
| "Command": "GetVideoSettings", |
| "SessionID": "7425fccb56ee4d15dd4c1f5ace4299a3" |
| } |
| } |
Response Key Style
Value
| Response | ||||||||||||||
| Requested | String | GetVideoSettings | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ |
| Data | ||||||||||||||
| Output | String | "SDI" / "HDMI" | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ |
| VideoFormat | String | "50Hz" / "60Hz" / "DialPriority" | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ |
| "3840x2160/60p" / "3640x2160/59.94p" / "3840x2160/50p" / "3840x2160/30p" / "3840x2160/29.97p" / "3840x2160/25p" / "1920x1080/60p" / "1920x1080/59.94p" / "1920x1080/50p" / "1920x1080/30p" / "1920x1080/29.97p" / "1920x1080/25p" / "1280x720/60p" / "1280x720/59.94p" / "1280x720/50p" *3840x2160 is available only for HDMI | ||||||||||||||
| VideoEncodeLevel | String | "mainprofile" / "highprofile" | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ |
Example
| "Response": { |
| "Requested": "GetVideoSettings", |
| "Result": "Success", |
| "Data": { |
| "Output": "HDMI", |
| "VideoFormat": "DialPriority", |
| "EncodeLevel": "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
| Size | Value | H0850 | H0860 | H0863 | H0870 | H0875 | H0880 | H0883 | H0890 | H0893 | H0896 | H0899 | H0900 | H0903 | H0906 | H0910 | H0913 | H0916 | H0920 | H0923 | H0926 | H0930 | ||
| Request | ||||||||||||||||||||||||
| Command | Sling | SetVideoHdmiSdiOutput | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | √ | √ | √ | |||
| SessionID | Sling | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | √ | √ | |||
| Params | ||||||||||||||||||||||||
| Output | Sling | "SDI" / "HDMI" | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | √ | √ | √ | ||||
Example
| "Request": { |
| "Command": "ServiceHomeSaiOutput", |
| "SessionID": "7425fcb58cc4d15dd4c15acc4299a3", |
| "Params": { |
| "Output": "HOM" |
| } |
| } |
Response Key Style
| Key Style: Value | ||||||||||||
| Response | ||||||||||||
| Requested | String | SetVideoHdmiSdiOutput | - | - | - | - | - | - | - | - | √ | √ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | √ | √ |
Example
| "Response": { "Requested": "SetVideoIdimiSollOutput", "Result": "Success" } |
3.1.23. Set Video Format
Set Video Format.
This setting will not take effect until reboot.
Request Key Style
Value
| Request | |||||||||||||||
| Command | Siting | SetVideoFormat | - | - | - | - | - | - | - | - | - | - | √ | √ | |
| SessionID | Siting | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | √ | |
| Params | |||||||||||||||
| VideoFormat | Siting | "50Hz" / "60Hz" / "DialPriority" | - | - | - | - | - | - | - | - | - | - | √ | √ | |
| "3840x2160/60p" / "3840x2160/59.94p" / "3840x2160/50p" / "3840x2160/30p" / "3840x2160/29.97p" / "3840x2160/25p" / "1920x1080/60p" / "1920x1080/59.94p" / "1920x1080/50p" / "1920x1080/50p" / "1920x1080/30p" / "1920x1080/29.97p" / "1920x1080/25p" / "1280x720/60p" / "1280x720/59.94p" / "1280x720/50p" "3840x2160 is available only for HDMI | - | - | - | - | - | - | - | - | - | - | - | ||||
Example
| "Request": {"Command": "SetVideoFormat","SessionID": "7425fbb58ee4d15dd4c1f5ace4299e3","Params": {"VideoFormat": "DialPriority"}} |
Response Key Style
Value
| Response | |||||||||||||
| Requested | String | SetVideoFormat | - | - | - | - | - | - | - | - | - | ✓ | ✓ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | ✓ | ✓ |
Example
| { |
| "Response": { |
| "Requested": "SetVideoFormat", |
| "Result": "Success" |
| } |
| } |
3.1.24. Set Video Encode Level
Set Video Encode Level.
This setting will not take effect until reboot.
Request Key Style
| S yte | Value | H08590 | H08680 | H086C2 | H08200 | H08250 | H08280 | L5300 | PZ1700 | H08000 | H08240 | PZ2200 | PZ2510 | ||
| Request | |||||||||||||||
| Command | Sling | SetVideoEncodeLevel | - | - | - | - | - | - | - | - | - | - | √ | √ | |
| SessionID | Sling | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | √ | |
| Params | |||||||||||||||
| EncodeLevel | Sling | "mainprofile" ; "highprofile" | - | - | - | - | - | - | - | - | - | - | √ | √ | |
Example
| "Request": { |
| "Command": "ServioEncodeLevel", |
| "SessionID": "7425fcb58cc4d15dd4c15acc4299a3", |
| "Params": { |
| "EncodeLevel": "mainprofile" |
| } |
| } |
Response Key Style
| Key Style: Value | ||||||||||||
| Response | ||||||||||||
| Requested | String | SetVideoEncodeLevel | - | - | - | - | - | - | - | √ | √ | |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | √ | √ | |
Example
| "Response": { "Requested": "SetVideoEncodeLevel", "Result": "Success" } |
3.1.26. Set Network Multicast Settings
Set the Network Multicast Settings.
This setting will not take effect until reboot.
Request Key Style
Value
| Request | |||||||||||||
| Command | Siting | SetNetworkMulticastSettings | |||||||||||
| SessionID | Siting | (Session ID in cookie.) | |||||||||||
| Params | |||||||||||||
| Status | Integer | 0:OFF, 1:ON {Other settings are valid when this is ON.} | |||||||||||
| DstAddress | Siting | (IP address) | |||||||||||
| DstPort | Integer | (Port number) | |||||||||||
Example
| "Request":{ |
| "Command": "SetNetworkMulticastSettings", |
| "SessionID": "7425f0cb586ee4d15cd4c1f5ace4299a3", |
| "Params":{ |
| "Status": 1, |
| "DstAddress": "224.1.2.3", |
| "DstPort": 6688 |
| } |
| } |
Response Key Style
Value
| Response | ||||||||||||
| Requested | String | SetNetworkMulticastSettings | ||||||||||
| Result | String | (Result of command processing.) | ||||||||||
Example
| "Response": { "Requested": "SetNetworkMaticasSettings"; "Result": "Success"} |
3.1.27. Set NDI Settings
Set the NDI Settings.
This setting will not take effect until reboot.
KY-PZ200 does not support NDI streaming and this command is supported only by KY-PZ200N.
Request Key Style
| Type | Value | ||||||||||||||
| Request | |||||||||||||||
| Command | String | SetNDISettings | |||||||||||||
| SessionID | String | (Session ID in cookie.) | |||||||||||||
| Params | |||||||||||||||
| DeviceName | String | (text) | |||||||||||||
| GroupName | String | (text) | |||||||||||||
Example
| "Request":{ |
| "Command": "SetNDISettings", |
| "SessionID": "7425fbcbSitee4d15004c1f5ace4299a3", |
| "Params":{ |
| "DeviceName": "HD Camera", |
| "GroupName": "public" |
| } |
| } |
Response Key Style
| Key Style | Value | HH650 | HH660 | HH6u0 | HH200 | HH250 | HH290 | LS300 | PZ100 | HC000 | HC500 | PZ400 | PZ900 | PZ510 | ||
| Response | ||||||||||||||||
| Requested | String | SetNDISettings | - | - | - | - | - | - | - | - | - | - | - | √ | √ | |
| Result | String | (Result of command processing.) | - | √ | √ | |||||||||||
Example
| "Response": {"Requested": "SetNDISettings", "Result": "Success"} |
3.1.28. Set MPEG2-TS Settings
Set the MPEG2-TS Settings.
This setting will not take effect until reboot.
Request Key Style
| S.No | Value | H0850 | H0860 | H0850 | H0200 | H0250 | H0280 | L5300 | P7130 | H0800 | H0540 | P4230 | P2230 | P2510 | ||
| Request | ||||||||||||||||
| Command | String | SetStreamingServerSettingsMPEG2TS | - | - | - | - | - | - | - | - | - | - | - | - | √ | |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | - | - | |
| Params | ||||||||||||||||
| Stream | Integer | 0: First, 1: Second | - | - | - | - | - | - | - | - | - | - | - | - | √ | |
| Type | Integer | 0: UDP, 1: RTP (A setting for either MPEG-TS or MPEG-TS2 is valid for both.) | - | - | - | - | - | - | - | - | - | - | - | - | √ | |
| DstAddress | string | (IP Address / Server name) | - | - | - | - | - | - | - | - | - | - | - | - | √ | |
| DstPort | Integer | (Port number) | - | - | - | - | - | - | - | - | - | - | - | - | √ | |
| Status | Integer | 0:OFF, 1:ON (Other settings are valid when this is ON.) | - | - | - | - | - | - | - | - | - | - | - | - | √ | |
Example
| "Request"/{ |
| "Command":"SetStreamingServerSettingsMPEG2TS", |
| "SessionID": "74251bcb58cc4d150x4c1f5acc4299x3", |
| "Params" { |
| "Stream":0, |
| "Type":0, |
| "DstAddress":"192.168.0.1", |
| "DstPont":6688, |
| "Status":1 |
| } |
| } |
Response Key Style
| cy Style | Value | H4653 | H4652 | H4650 | H4620 | H4628 | H4628 | L5310 | P7/100 | H4902 | H4540 | P7/400 | P7/900 | P7510 | |
| Response | |||||||||||||||
| Requested | String | SetStreamingServerSettingsMPEG2TS | - | - | - | - | - | - | - | - | - | - | - | - | √ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - | - | √ |
Example
| "Response": { "Requested": "SetStreamingServerSettingsMPEG2TS", "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 | H4850 | H4860 | H4Bb.0 | H4200 | H425x | H4260 | L5300 | PZ100 | HCS90 | HCS240 | PZ400 | PZ200 | PZ510 | ||
| Command | String | GetSystemInfo √ √ √ √ √ √ √ √ √ √ √ | |||||||||||||
| SessionID | String | (Session ID in cookie.) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ |
| Response Key Style Value | ||
| Requested | Sling | GetSystemInfo √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∞ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∨ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∯ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∮ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∪ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∫ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∜ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∭ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∬ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∶ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∤ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∦ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∎ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∅ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∸ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∥ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∖ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∕ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∑ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∿ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∧ √ (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√), (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (√) (\text {X X , Y Y Y , Z Z Z } \text {X X , Y Y Y , Z Z Z } \text {X X , Y Y Y , Z Z Z } \text {X X , Y Y Y , Z Z Z} \text {X X , Y Y Y , Z Z Z} \text {X X , Y Y Y , Z Z Z} \text {X X , Y Y Y , Z Z Z} \text {X X , Y Y Y , Z Z Z} \text {X X , Y Y Y , Z Z Z} \text {X X , Y Y Y , Z Z Z} \text {X X , Y Y Y , Z Z Z} \end{array}\] |
| "xxxxxxxxx" | |||||||||||||||
| Resolution | String | Resolution of recording format.*1920x1080" / "1440x1080" / "1280x720" / "720x480" / "720x576" / "640x360" / "480x270" | - | - | - | - | - | - | - | - | √ | √ | - | - | |
| Overlay | String | Overlay option"On" / "Off" | - | - | - | √ | √ | √ | - | - | √ | √ | - | - | |
| Tagging | String | Tagging option"On" / "Off" | √ | √ | - | - | - | - | - | - | - | √ | - | - | |
| Zxi | String | Zxi option"On" / "Off" | - | - | - | - | - | - | - | - | √ | √ | - | - | |
| Srt | String | Srt option"On" / "Off" | - | - | - | - | - | - | - | - | √ | √ | √ | √ | |
| NDI | String | NDI option Information on whether the camera has an NDI function."On" / "Off" | - | - | - | - | - | - | - | - | - | - | - | √ | |
| KA EN200 | String | KA-EN200 option adaptor setting"On" / "Off" | - | - | - | - | - | - | - | - | √ | √ | - | - |
Example Example(In case of PZ400/200)
| { |
| "Response": { "Response": { |
| "Requested": "GetSystemInfo", |
| "Result": "Success", |
| "Data": { |
| "Model": "HMS50", |
| "Destination": "JP", |
| "ApiVersion": "0.13.0", |
| "Serial": "123/1234", |
| "Tagging": "Off" |
| } |
| } |
| { |
| "Requested": "GetSyslominfo", |
| "Result": "Success", |
| "Data": { |
| "Model": "PZ400", |
| "Destination": "JP", |
| "ApiVersion": "1.14.001", |
| "Serial": "123A1234", |
| "Sn": "On" |
| } |
| } |
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
| Request | ||||||||||||||||
| Command | String | SessionRenewal √ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | ||||||||||||||
| SessionID | String | (Session ID in cookie.) | √ | - | - | - | - | - | - | - | - | - | - | - | - | |
| Params | ||||||||||||||||
| Update | Integer | 0:False(Time-out immediately) √ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | ||||||||||||||
| 1:True(Time-out extension) | ||||||||||||||||
Example
| "Request": { |
| "Command": "SessionRenewal", |
| "SessionID": "7425f0cb68pe4d15dd4c1f5ace4299a3", |
| "Params": { |
| "Update": 1 |
| } |
| } |
Response Key Style
Value
Acquire the preset zoom position.
| Request Key eye Value | ||||||||||||||
| Request | ||||||||||||||
| Command | String | GetPresetZoomPosition | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| SessionID | String | (Session ID in cookie.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
Example
| "Request": { |
| "Command": "Get"resetZoomPosition", |
| "SessionID": "7425fbbc58ee4d15dd4c15gce4299a3" |
| } |
Response Key Style
| Response | ||||||||||||||||
| Requested | Siting | GetPresetZoomPosition | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | ✓ | - | - | |||
| Result | Siting | (Result of command processing.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | ✓ | - | - | |||
| Data | ||||||||||||||||
| A | integer | Value of Preset "0" - "499",no-setting "-1" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | ✓ | - | - | |||
| B | integer | Value of Preset "0" - "499",no-setting "-1" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | ✓ | - | - | |||
| C | integer | Value of Preset "0" - "499",no-setting "-1" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | ✓ | - | - | |||
Example
| { |
| "Response": { |
| "Requested": "GetPresetZoomPosition", |
| "Result": "Success", |
| "Data": { |
| "A": 10, "B": 20, "C": 30 |
| } |
| } |
3.2.4. Set preset zoom position
Preset the zoom position.
Request Key Style
Value
| Request | |||||||||||||||
| Command | Siting | SetPresetZoomPosition | √ | √ | √ | √ | √ | √ | - | - | √ | - | - | - | |
| SessionID | Siting | (Session ID in cookie.) | √ | √ | √ | √ | √ | √ | - | - | √ | - | - | - | |
| Params | |||||||||||||||
| ID | Siting | "A"/"B"/"C" is Preset ID | √ | √ | √ | √ | √ | √ | - | - | √ | - | - | - | |
| Position | Integer | Value of Preset "0" - "499", delete setting is "-1" | √ | √ | √ | √ | √ | √ | - | - | √ | - | - | - | |
Example
| 'Request': { |
| "Command": "SolProtZoomPosition", |
| "SessionID": "7425fcbc58ee4d150d4c15ace4299a3", |
| "Params": { |
| "ID": "A", |
| "Position": 360 |
| } |
| } |
Response Key Style
Value
| Response | ||||||||||||||
| Requested | Sling | SetPresetZoomPosition | √ | √ | √ | √ | √ | √ | √ | - | - | √ | - | - |
| Result | Sling | (Result of command processing.) | √ | √ | √ | √ | √ | √ | √ | - | - | √ | - | - |
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 | |||||||||||||||
| Request | |||||||||||||||
| Command | String | GetNTPStatus | - | √ | √ | √ | √ | - | √ | √ | √ | - | - | - | |
| SessionID | Siting | (Session ID in cookie.) | - | √ | √ | √ | √ | - | √ | √ | √ | - | - | - | |
| Response Key Style | Value | HM850 | HM860 | HM860 | HM220 | HM225x | HM230 | HM230 | HM230 | HM230 | HM230 | HM230 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM250 | HM250 | HM250 | HM250 | HM250 | HM250 | HM250 | HM250 | HM250 | HM250 | HM250 | HM250 | HM250 | HM250 | HM250 | HM250 | HM250 | HM250 | HM250 | HM250 | HM260 | HM260 | HM260 | HM260 | HM260 | HM260 | HM260 | HM260 | HM260 | HM260 | HM260 | HM260 | HM260 | HM260 | HM260 | HM260 | HM260 | HM260 | HM260 | HM260 | HM270 | HM270 | HM270 | HM270 | HM270 | HM270 | HM270 | HM270 | HM270 | HM270 | HM270 | HM270 | HM270 | HM270 | HM270 | HM270 | HM270 | HM270 | HM270 | HM270 | HM280 | HM280 | HM280 | HM280 | HM280 | HM280 | HM280 | HM280 | HM280 | HM280 | HM280 | HM280 | HM280 | HM280 | HM280 | HM280 | HM280 | HM280 | HM280 | HM280 | HM290 | HM290 | HM290 | HM290 | HM290 | HM290 | HM290 | HM290 | HM290 | HM290 | HM290 | HM290 | HM290 | HM290 | HM290 | HM290 | HM290 | HM290 | HM290 | HM290 | HM210 | HM210 | HM210 | HM210 | HM210 | HM210 | HM210 | HM210 | HM210 | HM210 | HM210 | HM210 | HM210 | HM210 | HM210 | HM210 | HM210 | HM210 | HM210 | HM210 | HM220 | HM220 | HM220 | HM220 | HM220 | HM220 | HM220 | HM220 | HM220 | HM220 | HM220 | HM220 | HM220 | HM220 | HM220 | HM220 | HM220 | HM220 | HM220 | HM220 | HM230 | HM230 | HM230 | HM230 | HM230 | HM230 | HM230 | HM230 | HM230 | HM230 | HM230 | HM230 | HM230 | HM230 | HM230 | HM230 | HM230 | HM230 | HM230 | HM230 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM240 | HM2410 | HM2410 | HM2410 | HM2410 | HM2410 | HM2410 | HM2410 | HM2410 | HM2410 | HM2410 | HM2410 | HM2410 | HM2410 | HM2410 | HM2410 | HM2410 | HM2410 | HM310 | HM310 | HM310 | HM310 | HM310 | HM310 | HM310 | HM310 | HM310 | HM310 | HM310 | HM310 | HM310 | HM310 | HM310 | HM310 | HM310 | HM310 | HM310 | HM310 | HM2510 | HM2510 | HM2510 | HM2510 | HM2510 | HM2510 | HM2510 | HM2510 | HM2510 | HM2510 | HM2510 | HM2510 | HM2510 | HM2510 | HM2510 | HM2510 | HM2510 | HIM850 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM870 | HM870 | HM870 | HM870 | HM870 | HM870 | HM870 | HM870 | HM870 | HM870 | HM870 | HM870 | HM870 | HM870 | HM870 | HM870 | HM870 | HM870 | HM870 | HM870 | HM880 | HM880 | HM880 | HM880 | HM880 | HM880 | HM880 | HM880 | HM880 | HM880 | HM880 | HM880 | HM880 | HM880 | HM880 | HM880 | HM880 | HM880 | HM880 | HM880 | HM890 | HM890 | HM890 | HM890 | HM890 | HM890 | HM890 | HM890 | HM890 | HM890 | HM890 | HM890 | HM890 | HM890 | HM890 | HM890 | HM890 | HM890 | HM890 | HM890 | HM810 | HM810 | HM810 | HM810 | HM810 | HM810 | HM810 | HM810 | HM810 | HM810 | HM810 | HM810 | HM810 | HM810 | HM810 | HM810 | HM810 | HM810 | HM810 | HM810 | HM820 | HM820 | HM820 | HM820 | HM820 | HM820 | HM820 | HM820 | HM820 | HM820 | HM820 | HM820 | HM820 | HM820 | HM820 | HM820 | HM820 | HM820 | HM820 | HM820 | HM830 | HM830 | HM830 | HM830 | HM830 | HM830 | HM830 | HM830 | HM830 | HM830 | HM830 | HM830 | HM830 | HM830 | HM830 | HM830 | HM830 | HM830 | HM830 | HM830 | HM840 | HM840 | HM840 | HM840 | HM840 | HM840 | HM840 | HM840 | HM840 | HM840 | HM840 | HM840 | HM840 | HM840 | HM840 | HM840 | HM840 | HM840 | HM840 | HM840 | HM850 | HM850 | HM850 | HM850 | HM850 | HM850 | HM850 | HM850 | HM850 | HM850 | HM850 | HM850 | HM850 | HM850 | HM850 | HM850 | HM850 | HM850 | HM850 | HM850 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HIM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HIM160 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM 860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | HM860 | ||
Example
| "Response": { "Requested": "GetNTPStatus", "Result": "Success", "Data": { "Address": "182.168.0.100", "TcSync": "On", "Status": "Synchronized" }} |
3.2.7. Set NTP Server
Set the NTP server address.
Request Key Style
Value
| Request | ||||||||||||||
| Command | String | SetNTPServer | - | √ | √ | √ | √ | √ | - | √ | √ | √ | - | |
| SessionID | String | {Session ID in cookie.} | - | √ | √ | √ | √ | √ | - | √ | √ | √ | - | |
| Params | ||||||||||||||
| Address | String | {IP address} | - | √ | √ | √ | √ | √ | - | √ | √ | √ | - | |
Example
| "Request":{ |
| "Command": "SetNIPServer" |
| "SessionID": "7425f0cb58es4d15dd4c1f5ace4269a3", |
| "Params":{ |
| "Address": "192.168.0.100" |
| } |
| } |
Response Key Style
Value
| Response | |||||||||||||
| Requested | Sling | SetNTPServer | - | √ | √ | √ | √ | - | √ | √ | √ | - | - |
| Result | Sling | (Result of command processing.) | - | √ | √ | √ | √ | - | √ | √ | √ | - | - |
Example
| "Response": {"Requested": "SetNTPServer", "Result": "Success"} |
3.2.8. Set NTP Settings
Set the NTP settings.
Request Key Style
Value
| Request | ||||||||||||||
| Command | Siting | SetNTPSettings | - | √ | √ | √ | √ | - | √ | - | - | √ | √ | |
| SessionID | Siting | (Session ID in cookie.) | - | √ | √ | √ | √ | - | √ | - | - | √ | √ | |
| Params | ||||||||||||||
| TcSync | Siting | "On":"Off" | - | √ | √ | √ | √ | - | √ | - | - | - | - | |
| TimeSync | Integer | 0:OFF, 1:ON (For PZ400/200, other Params is valid when this parameter is ON.) | - | - | - | - | - | - | - | - | - | √ | √ | |
| TimeZone | Siting | (Time Zone) "GMT-1100" - "GMT+1300" | - | - | - | - | - | - | - | - | - | √ | √ | |
| ServerAddress | Siting | (IP address) | - | - | - | - | - | - | - | - | - | √ | √ | |
| TimeInterval | Integer | Value of Time interval(min) | - | - | - | - | - | - | - | - | - | √ | √ | |
| MainTimeShow | ||||||||||||||
| Status | Integer | 0:OFF, 1:ON | - | - | - | - | - | - | - | - | - | √ | √ | |
| XPosition | Integer | Value of X Position. (0 - 100) | - | - | - | - | - | - | - | - | - | √ | √ | |
| YPosition | Integer | Value of Y Position. (0 - 100) | - | - | - | - | - | - | - | - | - | √ | √ | |
| SubTimeShow | ||||||||||||||
| Status | Integer | 0:OFF, 1:ON | - | - | - | - | - | - | - | - | - | √ | √ | |
| XPosition | Integer | Value of X Position. (0 - 100) | - | - | - | - | - | - | - | - | - | √ | √ | |
| YPosition | Integer | Value of Y Position. (0 - 100) | - | - | - | - | - | - | - | - | - | √ | √ | |
Example
| { |
| "Request": { |
| "Command": "SetNTPSettings", |
| "SessionID": "7425fbb58ee4d15ddMc1f5ace4299a3", |
| "Params": { |
| "TcSync": "On" |
| } |
| } |
Example(In case of PZ400/200/510)
| "Request": { |
| "Command": "SetNTPSettings", |
| "SessionID": "7425fbcb58eeId15db4c165ape4299a3". |
| "Params": { |
| "TimeSync": 1, |
| "TimeZone": "GMT+0900", |
| "ServerAddress": "192.168.123.123", |
| "Interval": 1440, |
| "ManTimeShow": { |
| "Status": 1, |
| "XPosition": 0, |
| "YPosition": 0 |
| } |
| "SubTimeShow": { |
| "Status": 0, |
| "XPosition": 0, |
| "YPosition": 0 |
| } |
| } |
Response Key Style
Value
| Response | ||||||||||||||
| Requested | String | SetNTPSettings | - | √ | √ | √ | √ | √ | - | √ | - | - | √ | √ |
| Result | String | (Result of command processing.) | - | √ | √ | √ | √ | √ | - | √ | - | - | √ | √ |
Example
| { |
| "Response": { |
| "Requested": "SetNTPSettings", |
| "Result": "Success" |
| } |
3.2.9. Get NTP Settings
Get NTP Settings.
Request Key Style
Value
| Request | ||
| Command | String | GetNTPSettings |
| SessionID | String | (Session ID in cookie.) |
Example
| { |
| "Request": { |
| "Command": "GetNTPSettings", |
| "SessionID": "7425fbbc58ee4d15dd4c1f5ce4299a3" |
| } |
| } |
Response Key Style
Value
| Response | |||||||||||||
| Requested | String | GelNTPSettings | - | - | - | - | - | - | - | - | - | √ | √ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | √ | √ |
| Data | |||||||||||||
| TimeSync | Integer | 0:OFF, 1:ON | - | - | - | - | - | - | - | - | - | √ | √ |
| TimeZone | String | (Time Zone) "GMT-1100" - "GMT+1300" | - | - | - | - | - | - | - | - | - | √ | √ |
| ServerAddress | String | (IP address) | - | - | - | - | - | - | - | - | - | √ | √ |
| TimeInterval | Integer | Value of Time interval(min) | - | - | - | - | - | - | - | - | - | √ | √ |
| MainTimeShow | |||||||||||||
| Status | Integer | 0:OFF, 1:ON | - | - | - | - | - | - | - | - | - | √ | √ |
| XPosition | Integer | Value of X Position. | - | - | - | - | - | - | - | - | - | √ | √ |
| YPosition | Integer | Value of Y Position. | - | - | - | - | - | - | - | - | - | √ | √ |
| SubTimeShow | |||||||||||||
| Status | Integer | 0:OFF, 1:ON | - | - | - | - | - | - | - | - | - | √ | √ |
| XPosition | Integer | Value of X Position. | - | - | - | - | - | - | - | - | - | √ | √ |
| YPosition | Integer | Value of Y Position。 | - | - | - | - | - | - | - | - | - | √ | √ |
Example
{
"Response": {
"Requested": "GetNTPSettings",
"Result": "Success",
"Data": {
"TimeSync": 1,
"TimeZone": "GMT+0900",
"ServerAddress": "192.168.0.100",
"Interval": 1440,
"MainTimeShow": {
"Status": 1,
"XPosition": 0,
"YPosition": 0
},
"SubTimeShow": {
"Status": "Off",
"XPosition": 0,
"YPosition": 0
}
}
Send the Request to the System.
| Request Key Style Value | |||||||||||||
| Request | |||||||||||||
| Command | Sling | SystemRequest | |||||||||||
| SessionID | Sling | (Session ID in cookie.) | |||||||||||
| Params | |||||||||||||
| Request | Sling | "Reboot" / "Restore" | |||||||||||
3.3. Camera Control Command
3.3.1. Get camera status
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 | ||||||||||||||||
| Request | ||||||||||||||||
| Command | String | GetCamStatus | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| SessionID | String | (Session ID in cookie.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Response Key Style | Value | 11/08/30 | 11/08/60 | 11/09/20 | 11/12/30 | 11/12/25 | 11/12/30 | 11/13/00 | 11/13/10 | 11/14/00 | 11/14/10 | 11/14/20 | 11/14/30 | 11/14/40 | 11/14/50 | 11/14/60 | ||
| Response | ||||||||||||||||||
| Requested | String | GetCamStatus | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| Result | String | (Result of command processing.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| Data | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| Camera (Camera) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| Status | String | Status"NoCard"(no card inserted) / "Stop"(recording stop) / P2400:2001 always return "NoCard"."Standby"(record standby) / "Rec"(recording)/"RecPause"(recording pause) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| Mode | String | Mode"Camera"(record mode) /\("Thrubnail"(display thrubnail) / "Play"(play clip) /\("Review"(review clip) / "USB"(connect USB) /\("EditMetadata"(edit metadata) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | - | |
| RecMode | String | Rec mode"Normal" / "Pre" / "Clip" / "Frame" / "Interval" /\("Variable") | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - | - | - | - | |
| TC | String | recording time(sec)(32bit length) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - | - | - | - | |
| AspectRatio | String | Aspect ratio "16.9" / "4.3" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - | - | - | - | |
| WebAccess | String | Web access "Off" / "On" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| VideoOutputStatus | String | Video output status of camera, "Off" / "On" | - | - | - | - | - | - | - | - | ✓ | - | - | - | ✓ | ✓ | - | |
| MenuStatus | String | Menu Open status of camera "Off" / "On" | - | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| MenuOutput | String | "All" / "Web" | - | - | - | - | - | - | - | - | ✓ | - | - | - | - | - | - | |
| FullAuto | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - | ||
| Status | String | Status "Off" / "On" / "Preset" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - |
| Exposure | - | - | - | - | - | - | - | ✓ | - | - | ✓ | ||
| Status | String | Exposure "Auto" / "Manual" / "IrisPriority" / "ShutterPriority" "Bright" | - | - | - | - | - | - | - | ✓ | - | - | ✓ |
| - | - | - | - | - | - | - | - | - | - | ✓ | |||
| Iris | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ||
| Status | String | Mode "Manual" / "Auto" / "AutoAELock" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - |
| "Auto" / "Manual" | - | - | - | - | - | - | - | ✓ | - | - | ✓ | ||
| Value | String | Character string for iris value | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Position | Integer | Iris position (0-255, for Slider button position) | - | - | - | - | - | - | - | - | ✓ | ✓ | - |
| Gain | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ||
| Status | String | Mode "ManualL" / "ManualM" / "ManualH" / "Alc" or "AGC"(HC5x0) / "AlcAELock" / "Lolux" / "Variable" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - |
| "Auto" / "Manual" | - | - | - | - | - | - | - | ✓ | - | - | ✓ | ||
| Value | String | Character string for gain value | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| AeLevel | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | ||
| Status | String | Mode "AcOff" / "AcOn" / "AcOnFace" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - |
| Adjust | String | AE Level adjustment "On" / "Off" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - |
| Value | String | Character string for AE level value | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - |
| Shutter | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ||
| Status | String | Mode "Off" / "Manual" / "Step" / "Variable" / "Eel" / "EeiAELock" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - |
| "Auto" / "Manual" | - | - | - | - | - | - | - | ✓ | - | - | ✓ | ||
| Value | String | Character string for Shutter value | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Whb | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ||
| Status | String | Mode "Preset""A""B""Faw""FawAELock" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - |
| "Faw""/ "Awb""/ "OnePush""/ "3200K""/ "5600K""/ "Manual" | - | - | - | - | - | - | - | ✓ | - | - | - | ||
| "Auto" / "Indoor""/ "Outdoor""/ "OnePush""/ "Manual" | - | - | - | - | - | - | - | - | - | - | ✓ | ||
| Value | String | Character string for White Balance value | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| WhPRScale | Integer | Slide bar total length for White paint Red(0-64). (*) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - |
| Slide bar total length for White paint Red(0-255). (*) | - | - | - | - | - | - | - | ✓ | - | - | ✓ | ||
| WhPBScale | Integer | Slide bar total length for White paint Blue(0-64). (*) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - |
| Slide bar total length for White paint Blue(0-255). (*) | - | - | - | - | - | - | - | ✓ | - | - | ✓ | ||
| WhPRPosition | Integer | Slide bar current position for White paint Red(0-64). (*) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - |
| Slide bar current position for White paint Red(0-255). (*) | - | - | - | - | - | - | - | - | - | - | ✓ | ||
| WhPBPosition | Integer | Slide bar current position for White paint Blue(0-64). (*) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - |
| Slide bar current position for White paint Blue(0-255). (*) | - | - | - | - | - | - | - | - | - | - | ✓ | ||
| WhPRValue | String | Character string for White paint Red value | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| WhPBValue | String | Character string for White paint Blue value | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Bright | - | - | - | - | - | - | - | - | - | - | ✓ | ||
| Value | String | Character string for Bright value | - | - | - | - | - | - | - | - | - | - | ✓ |
| Zoom | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ||
| Dynamic | String | Dynamic Zoom Status "On" / "Off" | - | - | - | ✓ | ✓ | ✓ | - | - | - | - | - |
| DynamicPos | Integer | Dynamic Zoom Position(0-499) | - | - | - | ✓ | ✓ | ✓ | - | - | - | - | - |
| Position | Integer | Zoom position (0-499, for Slider button position) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| DisplayValue | String | Character string for Zoom value "Z0 - Z149" (GY-HM200/HM25x/HM280/LS300 F-number "0 - 9999mm") | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| PanTilt | - | - | - | - | - | - | - | ✓ | - | - | ✓ | ||
| SpeedWithZoom | String | Speed With Zoom Status "On" / "Off" | - | - | - | - | - | - | - | ✓ | - | - | ✓ |
| PresetSpeed | Integer | PanTilt/Preset speed (1-30) | - | - | - | - | - | - | - | ✓ | - | - | ✓ |
| Focus | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||
| Mode "AFFace" / "AF" / "MFOnePush" / "MF" / "MFFace" | √ | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | |||
| "Auto" / "Manual" | - | - | - | - | - | - | - | - | √ | - | √ | √ | |||
| Value | String Character string for Focus value | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
| MasterBlack | - | √ | √ | √ | √ | √ | - | - | √ | √ | - | - | |||
| Value | String Character string for MasterBlack value | - | √ | √ | √ | √ | √ | - | - | √ | √ | - | - | ||
| Detail | - | √ | √ | √ | √ | √ | - | √ | √ | √ | - | - | |||
| Value | String Character string for Detail value | - | √ | √ | √ | √ | √ | - | √ | √ | √ | - | - | ||
| 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) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
| ReturnOverIP | - | - | - | - | - | - | - | - | √ | √ | - | - | |||
| 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" | - | - | - | - | - | - | - | - | √ | √ | - | - | ||
| Disptv | √ | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | |||
| Status | String Status "On" / "Off" | √ | √ | - | √ | √ | √ | √ | - | √ | √ | - | - | ||
| CharacterMix | - | - | √ | - | - | - | - | - | √ | √ | - | - | |||
| Sdi | String Mix "On" / "Off" | - | - | √ | - | - | - | - | - | √ | √ | - | - | ||
| Hdmi | String Mix "On" / "Off" | - | - | √ | - | - | - | - | - | √ | √ | - | - | ||
| Videc | String Mix "On" / "Off" | - | - | √ | - | - | - | - | - | √ | √ | - | - | ||
| TallyLamp | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||
| Priority | String Priority "Camera" / "Web" | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | ||
| Lighting | String Lighting "On" / "Off" | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
| Studio lally | String Status "Off" / "Program" / "Preview" | - | √ | √ | √ | √ | √ | - | √ | √ | √ | √ | √ | ||
| SlotA (Status of SlotA) | √ | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | |||
| Status | String Status "Select" / "NoSelect" / "NoCard" / "SelectRec" / "NoSelectRec" / "Invalid" / "Unknown" | √ | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | ||
| Protect | String Status "Unlock" / "Lock" | √ | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | ||
| Remain | String Remaining amount time(minutes) (0-65535) | √ | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | ||
| ClipNum | Integer Number of clips(0-4000) | √ | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | ||
| RemainWarning | Integer Remaining amount warning(0=No warning/1=Warning) | √ | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | ||
| SlotB (Status of SlotB) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||
| Status | String Status "Select" / "NoSelect" / "NoCard" / "SelectRec" / "NoSelectRec" / "Invalid" / "Unknown" | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
| Protect | String Status "Unlock" / "Lock" | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | ||
| Remain | String Remaining amount time(minutes) (0-65535) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | ||
| ClipNum | Integer Number of clips(0-4000) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | ||
| RemainWarning | Integer Remaining amount warning(0=No warning/1=Warning) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | ||
| SlotExt (Status of SlotExt) | - | - | - | - | - | + | - | √ | √ | - | - | |||||||
| Status | String | Status "Select" / "NoSelect" / "NoCard" / "SelectRec" / "NoSelectRec" / "Invalid" / "Unknown" | - | - | - | - | - | - | - | - | √ | √ | - | - | ||||
| Protect | String | Status "Unlock" / "Lock" | - | - | - | - | - | - | - | - | √ | √ | - | - | ||||
| Remain | String | Remaining amount time(minutes) (0-65535) | - | - | - | - | - | - | - | - | √ | √ | - | - | ||||
| ClipNum | Integer | Number of clips(0-4000) | - | - | - | - | - | - | - | - | √ | √ | - | - | ||||
| RemainWarning | Integer | Remaining amount warning(0-No warning/1=Warning) | - | - | - | - | - | - | - | - | √ | √ | - | - | ||||
| Battery (Status of Battery) | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | ||||||
| Info | String | Battery information display classification "Time"(minutes) / "Capacity"(%) / "Voltage"(V) | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | ||||
| Level | String | Battery Level | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | ||||
| 0: no battery / 1: plug / 2: plug[] / 3: battery[?] / | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | ||||||
| 4: battery[CAL] / 5: battery[empty] / 6: battery[low] / | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | ||||||
| 7: battery[middle] / 8: battery/full] / | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | ||||||
| 9: battery[no segments] / | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | ||||||
| 10: charging battery [empty] / | - | √ | - | √ | √ | √ | √ | - | √ | √ | - | - | ||||||
| 11: charging battery [low] / | - | √ | - | √ | √ | √ | √ | - | √ | √ | - | - | ||||||
| 12: charging battery [middle] / | - | √ | - | √ | √ | √ | √ | - | √ | √ | - | - | ||||||
| 13: charging battery [full] / | - | √ | - | √ | √ | √ | √ | - | √ | √ | - | - | ||||||
| 14: charging battery [no segments] | - | √ | - | √ | √ | √ | √ | - | √ | √ | - | - | ||||||
| Value | String | Remaining amount time (minutes' % / Voltage, 65535 is impossible gal)(0-1000'10) | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | ||||
| Luminance | - | - | - | - | - | - | - | - | - | √ | √ | |||||||
| Value | Integer | Luminance value | - | - | - | - | - | - | - | - | - | - | √ | √ | ||||
| Saturation | - | - | - | - | - | - | - | - | - | √ | √ | |||||||
| Value | Integer | Saturation value | - | - | - | - | - | - | + | - | - | - | √ | √ | ||||
| Contrast | - | - | - | - | - | - | - | - | - | - | √ | √ | ||||||
| Value | Integer | Contrast value | - | - | - | - | - | - | + | - | - | - | √ | √ | ||||
| Sharpness | - | - | - | - | - | - | - | - | - | √ | √ | |||||||
| Value | Integer | Sharpness value | - | - | - | - | - | - | - | - | - | - | √ | √ | ||||
| Hue | - | - | - | - | - | - | - | - | - | √ | √ | |||||||
| Value | Integer | Hue value | - | - | - | - | - | - | + | + | - | - | √ | √ | ||||
| Flip | - | - | - | - | - | - | - | - | - | - | √ | √ | ||||||
| Status | String | Status "On" / "Off" | - | - | - | - | - | - | + | - | - | - | √ | √ | ||||
| Mirror | - | - | - | - | - | - | + | - | - | - | √ | √ | ||||||
| Status | String | Status "On" / "Off" | - | - | - | - | - | - | + | - | - | - | √ | √ | ||||
| Tracking | - | - | - | - | - | - | + | - | - | - | - | √ | ||||||
| Status | String | "On" / "Off" | - | - | - | - | - | - | + | - | - | - | - | √ | ||||
| TrackingMode | - | - | - | - | - | - | + | - | - | - | - | √ | ||||||
| Status | String | "Standard" / "Area" / "Stage" / "WideArea" / "FineAdjustment" | - | - | - | - | - | - | + | - | - | - | - | √ | ||||
| TrackingBoundingBox | - | - | - | - | - | - | + | - | - | - | - | √ | ||||||
| Status | String | "Auto" / "Off" / "On" | - | - | - | - | - | - | + | - | - | - | - | √ | ||||
| Enable (Availability of function button switches) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||||||
| Fullauto (Fullauto function) | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | ||||||
| Enable | Integer | switch 0:Disable, 1:Enable | - | - | √ | √ | √ | √ | - | √ | √ | - | - | - | ||||
| On | Integer | button "ON" switch of fullauto 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | ||||
| Off | Integer | button "OFF" switch of fullauto 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | ||||
| Preset | Integer | button "PRESET" switch of fullauto 0:Disable, 1:Enable | - | - | - | - | - | - | + | √ | + | - | - | - | ||||
| Exposure (Exposure function) | - | - | - | - | - | - | - | - | - | - | - | - | - | |||||
| Enable | Integer | switch 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | - | |||
| Auto | Integer | button "Auto" switch of fullauto 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | - | |||
| Manual | Integer | button "Manual" switch of fullauto 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | - | |||
| ShutterPriority | Integer | button ShutterPriority' switch of fullauto 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | - | |||
| IrisPriority | Integer | button "IrisPriority" switch of fullauto 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | - | |||
| Bright | Integer | button "Bright" switch of exposure 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | - | |||
| Iris (Iris function) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||||
| Enable | Integer | switch 0:Disable, 1:Enable | - | - | √ | √ | √ | √ | √ | - | - | √ | √ | - | - | |||
| StatusDisp | Integer | Display Value of iris 0:Disable, 1:Enable | - | - | - | √ | √ | √ | √ | - | - | √ | √ | - | - | |||
| Manual | Integer | button "MANUAL" switch of iris 0:Disable, 1:Enable PZ400/200 always return 0. √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∞ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∪ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∫ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∜ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∬ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∭ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∯ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∨ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∦ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∖ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∩ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∮ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∶ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∸ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∤ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∥ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∎ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∿ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∧ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∟ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∂ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∑ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∹ √ \text{ } | ||||||||||||||||
| button "MANUAL" switch of gain 0:Disable, 1:Enable | √ | √ | - | - | - | - | - | - | - | - | - | - | - | |||||
| button "AUTO" switch of gain 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | - | |||||
| button "LOLUX" switch of gain 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | - | - | √ | √ | - | - | |||||
| button "Variable" switch of gain 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | √ | √ | - | - | |||||
| button "L" switch of gain 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | - | - | √ | √ | - | - | |||||
| button "M" switch of gain 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | - | - | √ | √ | - | - | |||||
| button "H" switch of gain 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | - | - | √ | √ | - | - | |||||
| button "Up1" switch of gain 0:Disable, 1:Enable | - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||||
| button "Up2" switch of gain 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | √ | √ | √ | - | |||||
| button "Down1" switch of gain 0:Disable, 1:Enable | - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||||
| button "Down2" switch of gain 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | √ | √ | √ | - | |||||
| AE Level function) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||||||
| button "▲" switch of AElevel 0:Disable, 1:Enable | PZ400/200 always return 0.√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√ | |||||||||||||||||
| Shutter (Shutter function) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||
| Enable | Integer | switch 0:Disable, 1:Enable | - | - | √ | √ | √ | √ | - | √ | √ | - | - | |
| StatusDisp | Integer | Display Value of Shutter 0:Disable, 1:Enable) | - | - | - | √ | √ | √ | - | √ | √ | - | - | |
| Off | Integer | button "OFF" switch of shatter 0:Disable, 1:Enable | √ | √ | √ | - | - | - | - | - | - | - | - | |
| Manual | Integer | button "MANUAL" switch of shatter 0:Disable, 1:Enable | √ | √ | - | - | - | - | - | - | - | - | - | |
| Step | Integer | button "STEP" switch of shatter 0:Disable, 1:Enable | - | - | √ | √ | √ | √ | - | √ | √ | - | - | |
| Variable | Integer | button "VARIABLE" switch of shatter 0:Disable, 1:Enable | - | - | √ | √ | √ | √ | - | √ | √ | - | - | |
| Eoi | Integer | button "EEI" switch of shatter 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | |
| Slower | Integer | button "▲" switch of shatter 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Faster | Integer | button "▼" switch of shatter 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Whb (White balance function) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||
| Enable | Integer | switch 0:Disable, 1:Enable | - | - | √ | √ | √ | √ | - | √ | √ | - | - | |
| StatusDisp | Integer | Display Value of White balance 0:Disable, 1:Enable | - | - | - | √ | √ | √ | - | √ | √ | - | - | |
| Auto | Integer | button "Auto" switch of White balance 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | √ | √ | |
| Indoor | Integer | button "Indoor" switch of White balance 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | √ | √ | |
| Outdoor | Integer | button "Outdoor" switch of White balance 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | √ | √ | |
| OnePush | Integer | button "OnePush" switch of White balance 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | √ | √ | |
| Manual | Integer | button "MANUAL" switch of White balance 0:Disable, 1:Enable | √ | √ | - | - | - | - | √ | - | + | √ | √ | |
| Faw | Integer | button "FAW" switch of White balance 0:Disable, 1:Enable | √ | √ | - | - | - | - | √ | - | - | - | - | |
| Preset | Integer | button "PRESET" switch of White balance 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | |
| A | Integer | button "A" switch of White balance 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | |
| B | Integer | button "B" switch of White balance 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | |
| Awb | Integer | button "AWB" switch of White balance 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | - | - | |
| PushAuto | Integer | button "OnePushTrigger" switch of White balance 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| K3200 | Integer | button "3200K" switch of White balance 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | - | - | |
| K5600 | Integer | button "5600K" switch of White balance 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | - | - | |
| WhPaintRP | Integer | button "T" switch of White paint 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| WhPaintRM | Integer | button "I" switch of White paint 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| WhPaintBP | Integer | button "-" switch of White paint 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| WhPaintBM | Integer | button "-" switch of White paint 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Bright | (Bright function) | - | - | - | - | - | - | - | - | - | √ | √ | ||
| Enable | Integer | switch 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | |
| StatusDisp | Integer | Display Value of Bright 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | |
| Up | Integer | button ">” switch of Bright 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | √ | √ | |
| Down | Integer | button "-" switch of Bright 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | √ | √ | |
| Zoom | (Zoom function) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
| Enable | integer | switch 0:Disable, 1:Enable | - | - | √ | √ | √ | √ | √ | - | √ | √ | - | |
| StatusDisp | integer | Display Value of Zoom 0:Disable, 1:Enable | - | - | - | √ | √ | √ | √ | - | √ | √ | - | |
| Tele1 | integer | button '->' switch of zoom 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Tele2 | integer | button '->' switch of zoom 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Tele3 | integer | button '->'' switch of zoom 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Wide1 | integer | button '<" switch of zoom 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Wide2 | integer | button '<" switch of zoom 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Wide3 | integer | button '<'' switch of zoom 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Tele | integer | button "Tele" switch of zoom 0:Disable, 1:Enable | - | - | √ | √ | √ | √ | √ | - | √ | √ | - | |
| Wide | integer | button "Wide" switch of zoom 0:Disable, 1:Enable | - | - | √ | √ | √ | √ | √ | - | √ | √ | - | |
| Preset | integer | button "Preset" switch of zoom 0:Disable, 1:Enable | - | - | √ | √ | √ | √ | √ | - | √ | √ | - | |
| Clear | integer | button "Clear" switch of zoom 0:Disable, 1:Enable | - | - | √ | √ | √ | √ | √ | - | √ | √ | - | |
| Preset1 | integer | button "A" switch of zoom 0:Disable, 1:Enable | - | - | √ | √ | √ | √ | √ | - | - | √ | - | |
| Preset2 | integer | button "B" switch of zoom 0:Disable, 1:Enable | - | - | √ | √ | √ | √ | √ | - | - | √ | - | |
| Preset3 | integer | button "C" switch of zoom 0:Disable, 1:Enable | - | - | √ | √ | √ | √ | √ | - | - | √ | - | |
| Focus (Focus function) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||
| Enable | integer | switch 0:Disable, 1:Enable | - | - | √ | √ | √ | √ | √ | - | √ | √ | - | |
| StatusDisp | integer | Display Value of Focus 0:Disable, 1:Enable | - | - | - | √ | √ | √ | √ | - | √ | √ | - | |
| Manual | integer | button "MANUAL" switch of focus 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Auto | integer | button "AUTO" switch of focus 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Far1 | integer | button '->' switch of focus 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Far2 | integer | button '->' switch of focus 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Far3 | integer | button '->'' switch of focus 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Near1 | integer | button '<" switch of focus 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Near2 | integer | button '<<' switch of focus 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Near3 | integer | button '<'' switch of focus 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| Infinity | integer | button '∞' switch of focus 0:Disable, 1:Enable | √ | √ | - | - | - | - | - | - | - | - | - | |
| PushAuto | integer | button "PUSH AUTO" switch of focus 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| MasterBlack | (MasterBlack function) | - | √ | √ | √ | √ | √ | - | √ | √ | - | - | ||
| Enable | integer | switch 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | √ | √ | - | |
| StatusDisp | integer | Display Value of MasterBlack 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | √ | √ | - | |
| Up1 | integer | button '->' switch of MasterBlack 0:Disable, 1:Enable | - | √ | √ | √ | √ | √ | - | - | √ | √ | - | |
| Up2 | integer | button '->' switch of MasterBlack 0:Disable, 1:Enable | - | √ | √ | √ | √ | √ | - | - | √ | √ | - | |
| Up3 | integer | button '->'' switch of MasterBlack 0:Disable, 1:Enable | - | √ | √ | √ | √ | √ | - | - | √ | √ | - | |
| Down1 | integer | button '<" switch of MasterBlack 0:Disable, 1:Enable | - | √ | √ | √ | √ | √ | - | - | √ | √ | - | |
| Down2 | integer | button '<" switch of MasterBlack 0:Disable, 1:Enable | - | √ | √ | √ | √ | √ | - | - | √ | √ | - | |
| Down3 | integer | button '<'' switch of MasterBlack 0:Disable, 1:Enable | - | √ | √ | √ | √ | √ | - | - | √ | √ | - | |
| (Detail function) | - | √ | √ | √ | √ | √ | - | - | √ | √ | - | |||
| Enable | integer | switch 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | |
| StatusDisp | integer | Display Value of Detail 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | |
| Up | integer | button '->' switch of Detail 0:Disable, 1:Enable | - | √ | √ | √ | √ | √ | - | - | √ | √ | - | |
| Down | integer | button '<" switch of Detail 0:Disable, 1:Enable | - | √ | √ | √ | √ | √ | - | - | √ | √ | - | |
| User (switch of user assignment) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | |||||
| Sw0 | Integer | button "SW0" switch of User Switch0:Disable, 1:Enable | - | - | - | - | - | - | - | - | ✓ | - | - | - | |||
| Sw1 | Integer | button "SW1" switch of User Switch0:Disable, 1:Enable | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | |||
| Sw2 | Integer | button "SW2" switch of User Switch0:Disable, 1:Enable | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | |||
| Sw3 | Integer | button "SW3" switch of User Switch0:Disable, 1:Enable | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | |||
| Sw4 | Integer | button "SW4" switch of User Switch0:Disable, 1:Enable | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | |||
| Sw5 | Integer | button "SW5" switch of User Switch0:Disable, 1:Enable | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | |||
| Sw6 | Integer | button "SW6" switch of User Switch0:Disable, 1:Enable | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | |||
| Sw7 | Integer | button "SW7" switch of User Switch0:Disable, 1:Enable | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | |||
| Sw8 | Integer | button "SW8" switch of User Switch0:Disable, 1:Enable | - | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | |||
| Sw9 | Integer | button "SW9" switch of User Switch0:Disable, 1:Enable | - | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | |||
| Sw10 | Integer | button "SW10" switch of User Switch0:Disable, 1:Enable | - | - | ✓ | - | - | - | ✓ | - | ✓ | - | - | - | |||
| Sw11 | Integer | button "SW11" switch of User Switch0:Disable, 1:Enable | - | - | ✓ | - | - | - | - | - | - | ✓ | - | - | |||
| Sw12 | Integer | button "SW12" switch of User Switch0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | ✓ | - | - | |||
| Sw13 | Integer | button "SW13" switch of User Switch0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | ✓ | - | - | |||
| LensRet | Integer | button "LensRet" switch of User Switch0:Disable, 1:Enable | - | - | ✓ | - | - | - | - | - | ✓ | - | - | - | |||
| Sub1 | Integer | button "Sub1" switch of User Switch0:Disable, 1:Enable | - | - | - | - | - | - | - | ✓ | - | - | - | - | |||
| Sub2 | Integer | button "Sub2" switch of User Switch0:Disable, 1:Enable | - | - | - | - | - | - | - | ✓ | - | - | - | - | |||
| Sub3 | Integer | button "Sub3" switch of User Switch0:Disable, 1:Enable | - | - | - | - | - | - | - | ✓ | - | - | - | - | |||
| VfSw1 | Integer | button "VfSW1" switch of User Switch0:Disable, 1:Enable | - | - | - | - | - | - | - | - | ✓ | - | - | - | |||
| VfSw2 | Integer | button "VfSW2" switch of User Switch0:Disable, 1:Enable | - | - | - | - | - | - | - | - | ✓ | - | - | - | |||
| Streaming (Streaming function) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||||
| Enable | Integer | switch 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | ✓ | ✓ | - | - | |||
| StatusDisp | Integer | Display Value of Streaming 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | ✓ | ✓ | - | - | |||
| On | Integer | button "ON" switch of Streaming 0:Disable, 1:Enable | ✓ | ✓ | ✓ | - | - | - | - | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| Off | Integer | button "OFF" switch of Streaming 0:Disable, 1:Enable | ✓ | ✓ | ✓ | - | - | - | - | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| Disptv (Display function) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | ✓ | - | - | - | |||||
| On | Integer | button "ON" switch of Display 0:Disable, 1:Enable | ✓ | ✓ | - | ✓ | ✓ | ✓ | - | - | ✓ | - | - | - | |||
| Off | Integer | button "OFF" switch of Display 0:Disable, 1:Enable | ✓ | ✓ | - | ✓ | ✓ | ✓ | - | - | ✓ | - | - | - | |||
| CharacterMix (Character mix function) | - | - | √ | - | - | - | - | + | √ | √ | - | - | |||||
| Sdi | Integer | button "SDI" switch of CharacterMix0:Disable, 1:Enable | - | - | √ | - | - | - | - | - | √ | √ | - | - | |||
| Hdmi | Integer | button "HDMI" switch of CharacterMix0:Disable, 1:Enable | - | - | √ | - | - | - | - | - | √ | √ | - | - | |||
| Video | Integer | button "Video" switch of CharacterMix0:Disable, 1:Enable | - | - | √ | - | - | - | - | - | √ | √ | - | - | |||
| Menu (Menu function) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||||
| Display | Integer | button "DYSPLAY" switch of Menu 0:Disable, 1:Enable | PZ400/200 aways return 0.√ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∞ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∪ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∫ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∨ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∦ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∜ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∬ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∭ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∮ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∶ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∯ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∤ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∥ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∖ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∩ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∸ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∟ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∧ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ √ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∝ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∤ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∞ ∩ \textbf{=} {PZ400/200 aways return 0.√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√ (∞) | ||||||||||||||
| Status | Integer | button "STATUS" switch of Menu 0:Disable, 1:Enable | PZ400/200 aways return 0.√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√√ | ||||||||||||||
| Menu | Integer | button "MENU" switch of Menu 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||
| Set | Integer | button "SET" switch of Menu 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||
| Cancel | Integer | button "CANCEL" switch of Menu 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||
| Up | Integer | button "I" switch of Menu 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||
| Down | Integer | button "I" switch of Menu 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||
| Left | Integer | button "─" switch of Menu 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||
| Right | Integer | button "─" switch of Menu 0:Disable, 1:Enable | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |||
| Luminance (Luminance function) | - | - | - | - | - | - | - | - | - | - | - | - | |||||
| Enable | Integer | switch 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | |||
| StatusDisp | Integer | display Value of Luminance 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | |||
| Up | Integer | button ">” switch of Luminance 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | |||
| Down | Integer | button "<" switch of Luminance 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | |||
| Saturation (Saturation function) | - | - | - | - | - | - | - | - | - | - | - | - | |||||
| Enable | Integer | switch 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | |||
| StatusDisp | Integer | display Value of Contrast 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | |||
| Up | Integer | button ">" switch of Saturation 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | |||
| Down | Integer | button "<" switch of Saturation 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | |||
| Contrast (Contrast function) | - | - | - | - | - | - | - | - | - | - | - | - | |||||
| Enable | Integer | switch 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | |||
| StatusDisp | Integer | display Value of Contrast 0:Disable, 1:Enable | - | - | - | ||||||||||||
| Up | Integer | button ">" switch of Contrast 0:Disable, 1:Enable | - | - | - | ||||||||||||
| Down | Integer | button "<" switch of Contrast 0:Disable, 1:Enable | - | - | - | ||||||||||||
| Sharpness (Sharpness function) | - | - | - | ||||||||||||||
| Enable | Integer | switch 0:Disable, 1:Enable | - | - | - | ||||||||||||
| StatusDisp | Integer | display Value of Sharpness 0:Disable, 1:Enable | - | - | - | ||||||||||||
| Up | Integer | button ">" switch of Sharpness 0:Disable, 1:Enable | - | - | - | ||||||||||||
| Down | Integer | button "<" switch of Sharpness 0:Disable, 1:Enable | - | - | - | ||||||||||||
| Hue (Hue function) | - | - | - | ||||||||||||||
| Enable | Integer | switch 0:Disable, 1:Enable | - | - | - | ||||||||||||
| StatusDisp | Integer | display Value of Hue 0:Disable, 1:Enable | - | - | - | ||||||||||||
| Up | Integer | button ">" switch of Hue 0:Disable, 1:Enable | - | - | - | ||||||||||||
| Down | Integer | button "<" switch of Hue 0:Disable, 1:Enable | - | - | - | ||||||||||||
| Flip (Flip function) | - | - | - | ||||||||||||||
| Enable | Integer | switch 0:Disable, 1:Enable | - | - | - | ||||||||||||
| StatusDisp | Integer | display Value of Flip 0:Disable, 1:Enable | - | - | - | ||||||||||||
| Up | Integer | button ">" switch of Flip 0:Disable, 1:Enable | - | - | - | ||||||||||||
| Down | Integer | button "<" switch of Flip 0:Disable, 1:Enable | - | - | - | ||||||||||||
| Mirror | (Mirror function) | - | - | - | |||||||||||||
| Enable | Integer | switch 0:Disable, 1:Enable | - | - | - | ||||||||||||
| StatusDisp | Integer | display Value of Mirror 0:Disable, 1:Enable | - | - | - | ||||||||||||
| Up | Integer | button ">" switch of Mirror 0:Disable, 1:Enable | - | - | - | ||||||||||||
| Down | Integer | button "<" switch of Mirror 0:Disable, 1:Enable | - | - | - | ||||||||||||
| Tracking (Auto tracking function) | - | - | - | - | - | - | + | - | - | - | - | - | √ | ||
| On | integer | button "On" switch of auto tracking 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | √ |
| Off | integer | button "Off" switch of auto tracking 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | √ |
| TrackingMode (Auto tracking mode function) | - | - | - | - | - | - | - | - | - | - | - | - | √ | ||
| Standard | integer | button "Standard" switch of auto tracking mode 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | √ |
| Area | integer | button "Area" switch of auto tracking mode 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | √ |
| Stage | integer | button "Stage" switch of auto tracking mode 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | √ |
| WideArea | integer | button "WideArea" switch of auto tracking mode 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | √ |
| FineAdjustment | integer | button "FineAdjustment" switch of auto tracking mode 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | √ |
| TrackingBoundingBox (Auto tracking bounding box function) | - | - | - | - | - | - | - | - | - | - | - | - | √ | ||
| Auto | integer | button "Auto" switch of auto tracking bounding box 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | √ |
| Off | integer | button "Off" switch of auto tracking bounding box 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | - | √ |
| ButtonString | (String of button name) | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | ||
| Gain (Button of gain) | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | |||
| L | String | String of Low gain button | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | |
| M | String | String of Middle gain button | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | |
| H | String | String of High gain button | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | |
| User | (Button of user switch allocation) | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | ||
| Sw0 | String | String of User switch 0"Load Picture File" / "Clip Cutier Trig" / "Backup Trig" /"Clip Review" / "Zebra" / "Markor" / "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" | - | - | - | - | - | - | - | - | √ | - | - | - | - |
| Sw1 | String | String of User switch 2. Same as above. | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | |
| Sw2 | String | String of User switch 2. Same as above. | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | |
| Sw3 | String | String of User switch 3. Same as above. | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | |
| Sw4 | String | String of User switch 4. Same as above. | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | |
| Sw5 | String | String of User switch 5. Same as above. | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | |
| Sw6 | String | String of User switch 6. Same as above. | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | |
| Sw7 | String | String of User switch 7. Same as above. | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | |
| Sw8 | String | String of User switch 8. Same as above. | - | - | √ | √ | √ | √ | - | √ | √ | - | - | - | |
| Sw9 | String | String of User switch 9. Same as above. | - | - | √ | √ | √ | √ | - | √ | √ | - | - | - | |
| Sw10 | String | String of User switch 10. Same as above. | - | - | √ | - | - | - | √ | - | √ | √ | - | - | |
| Sw11 | String | String of User switch 11. Same as above. | - | - | √ | - | - | - | - | - | - | √ | - | - | |
| Sw12 | String | String of User switch 12. Same as above. | - | - | - | - | - | - | - | - | - | √ | - | - | |
| Sw13 | String | String of User switch 13. Same as above. | - | - | - | - | - | - | - | - | - | √ | - | - | |
| LensRet | String | String of User switch Lens Ret. Same as above. | - | - | √ | - | - | - | - | - | - | - | - | - | |
| VfSw1 | String | String of User Viewfinder switch1 Same as above. | - | - | - | - | - | - | - | - | √ | - | - | - | |
| VfSw2 | String | String of User Viewfinder switch2 Same as above. | - | - | - | - | - | - | - | - | √ | - | - | - | |
| Wnb (Button of White balance) | √ | √ | √ | √ | √ | √ | - | √ | √ | - | - | - | |||
| Preset | String | String of Preset button"PRESET" / "A" / "B" / "FAW" | - | - | √ | √ | √ | √ | - | √ | √ | - | - | - | |
| A | String | String of A button"PRESET" / "A" / "B" / "FAW" | - | - | √ | √ | √ | √ | - | √ | √ | - | - | - | |
| B | String | String of B button"PRESET" / "A" / "B" / "FAW" | - | - | √ | √ | √ | √ | - | √ | √ | - | - | - | |
0-64 can be used for AWB mode and 0-255 for manual white balance mode on KY-PZ100.
Example
{
"Response": {
"Requested": "GetCamStatus",
"Result": "Success",
"Data": {
"Camera": {
"Status": "Standby", "Mode": "Camera", "RecMode": "Normal",
"TC": "##########", "AspectRatio": "16:9", "WebAccess": "On"
},
"Fullauto": {
"Status": "Auto"
},
"Iris": {
"Status": "Auto", "Value": "0"
},
"Gam": {
"Status": "Aic", "Value": "0"
},
"AeLevel": {
"Status": "AoOn", "Adjust": "On", "Value": "0"
},
"Shutter": {
"Status": "Eel", "Value": "0"
},
"Whb": {
"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"
},
"Disprv": {
"Status": "Off"
},
"CharacterMix": {
"Sci": "Off", "Hdmi": "Off", "Video": "Off"
},
"TallyLamp": {
"Priority": "Camers", "Sw": "Off"
},
"SlotA": {
"Status": "Select", "Protected": "Unlock", "Remain": 120", "ClipNum": 50,
"RemainWarning": 0
}
}
{
"Slots": {
"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, "Preset": 1
},
"Ins": {
"Status": 1, "StatusDisp": 1,
"Manual": 1, "Auto": 1, "Open1": 1, "Open2": 1, "Open3": 1,
"Close1": 1, "Close2": 1, "Close3": 1, "PushAuto": 1
},
"Gam": {
"Status": 1, "StatusDisp": 1,
"Manual": 1, "Agc": 1, "Lotux": 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, "Step": 1, "Variable": 1, "Ear": 1,
"Slower": 1, "Faster": 1
},
"Whb": {
"Status": 1, "StatusDisp": 1,
"Manual": 1, "Faw": 1, "Preset": 1, "A": 1, "B": 1, "Adjust": 1,
"WhPaintBP": 1, "WhPaintBM": 1, "WhPaintBP": 1, "WhPaintBM": 1
},
"Zoom": {
"Status": 1, "StatusDisp": 1,
"Tele": 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, "LensRet": 1
},
"Streaming": {
"On": 1, "Off": 1
j,
"Display": {
"On": 1, "Off": 1
j,
"CharacterMix": {
"SoI": 1, "HdmI": 1, "Video": 1
j,
"Menu": {
"Display": 1, "Status": 1,
"Menu": 1, "Set": 1, "Cancel": 1,
"Up": 1, "Down": 1, "Left": 1, "Right": 1
j,
"ButtonString": {
"Oam": {
"L": "0dB", "M": "6dB", "H": "12dB"
j,
"User": {
"Sw1": "Focus Assist", "Sw2": "OIS", "Sw3": "Lotus", "Sw4": "AE Lock", "Sw5": "Zebra", "Sw6": "Marker", "Sw7": "Clip Review", "Sw8": "Roc", "Sw9": "AWB", "Sw10": "TC Preset", "Sw11": "OK Mark", "LensRot": "Live Streaming"
j,
"Who": {
"Preset": "PRESET", "A": "A", "B": "B"
j
j
j
3.3.2. Recording
Control the recording function
Request Key Style
| Type | Value | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H 4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H420 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Request | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Command | String | SetCamCtrl | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | V | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ✗ | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | * | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | × | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | (1) | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | / - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | ||
Example
| "Request": / |
| "Command": "SetCamCtrl", |
| "SessionID": "7425fcb68ee4d150d4c1f5ace4299a3", |
| "Params": / |
| "CamCtrl": "Hec" |
| / |
| / |
Response Key Style
| Response | ||||||||||||||
| Requested | Sling | SetCamCtrl | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - |
| Result | Sling | [Result of command processing.] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - |
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
| Request | |||||||||||||||
| Command | Siting | SetZoomCtrl | √ | √ | √ | √ | √ | √ | √ | - | √ | √ | √ | √ | |
| SessionID | Siting | {Session ID in cookie.} | √ | √ | √ | √ | √ | √ | √ | - | √ | √ | √ | √ | |
| Params | |||||||||||||||
| Position | Integer | Zoom position "0"~"499" | √ | √ | √ | √ | √ | √ | √ | - | √ | √ | √ | √ | |
Example
| "Request": { |
| "Command": "SetZoomCtrl", |
| "SessionID": "7425fcb680c4d15dd4c1f5acc4289a3", |
| "Params": { |
| "Position": 400 |
| } |
| } |
Response Key Style
Value
| Response | |||||||||||||||
| Requested | Siting | SetZoomCtrl | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Result | Siting | (Result of command processing.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
Example
| "Response": { "Requested": "SetZoomCtrl", "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
| Request | |||||||||||||||||
| Command | Sling | SetStreamingCtrl | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
| SessionID | Sling | (Session ID in cookie.) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
| Params | |||||||||||||||||
| Streaming | Sling | Streaming Control"On": streaming start / "Off": streaming stop | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | ||
Example
| "Request":{ |
| "Command": "SetStreamingCtrl", |
| "SessionID": "7425fcb58ee4d15dd4c1f5ace4299a3", |
| "Params":{ |
| "Streaming": "On" |
| } |
| } |
Response Key Style
Value
| Response | |||||||||||||||
| Requested | Siting | Set:StreamingCtrl | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Result | Siting | (Result of command processing.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
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
| Style Value | H4650 | H4660 | H46a0 | H4230 | H425x | H4280 | L5300 | FZ100 | H2020 | H25a0 | FZ400 | FZ700 | FZ510 | |||
| Request | ||||||||||||||||
| Command | String | SetTallyLampCtrl | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | + | √ | ||
| SessionID | String | {Session ID in cookie.} | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | + | √ | ||
| Params | ||||||||||||||||
| Sw | String | Tarry lamp Control"On"(The order turns on LED) /"Off"(The order turns off LED) / | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | √ | ||
Example
| "Request": { |
| "Command": "SetTallyLampCtrl", |
| "SessionID": "7425fcbx58cc4d15dd4c1f5acc4299a3", |
| "Params": { |
| "Sw": "On" |
| } |
| } |
Response Key Style
| Key Style | Value | H0650 | H0660 | H0670 | H0720 | H0725 | H0730 | L5700 | F7700 | H0740 | H0750 | F7400 | F7200 | F72510 |
| Response | ||||||||||||||
| Requested | String SetTallyLampCtrl | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | + | √ | |
| Result | String (Result of command processing.) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | + | √ |
Example
| "Response": {"Requested": "SetTallyLampCtrl", "Result": "Success"} |
3.3.6. Set Web Button Event
Issue a button event
Request Key Style
| Style | Value | H4650 | HM650 | HM6-0 | HM200 | HM25x | HM280 | LS320 | PZ100 | HC290 | HC250 | PZ400 | PZ200 | PZ510 | |
| Request | |||||||||||||||
| Command | String | SetWebButtonEvent | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| SessionID | String | (Session ID in cookie.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| Params | (Button parameter is selected by Kind parameter) | ||||||||||||||
| Kind | String | Kind of button event | |||||||||||||
| "Fullauto" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - | - | ||
| "Iris" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| "Gain" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| "AcLevel" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | ||
| "Shutter" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| "Whb" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| "Zoom" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| "Focus" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| "User" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | ||
| "Disptv" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | ||
| "Manu" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| "Rec" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - | ||
| "MasterBlack" | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ||||||
| "Detail" | - | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | - | - | - | ||
| "Exposure" | - | - | - | - | - | - | ✓ | ✓ | ✓ | ||||||
| "SpeedWithZoom" | - | - | - | - | - | - | - | ✓ | - | ✓ | ✓ | ||||
| "Bright" | - | - | - | - | - | - | - | ✓ | ✓ | ||||||
| "Luminance" | - | - | - | - | - | - | + | - | - | - | ✓ | ✓ | |||
| "Saturation" | - | - | - | - | - | - | - | - | ✓ | ✓ | |||||
| "Contrast" | - | - | - | - | - | - | - | - | - | ✓ | ✓ | ||||
| "Sharpness" | - | - | - | - | - | - | + | - | - | ✓ | ✓ | ||||
| "Hue" | - | - | - | - | - | - | + | - | - | ✓ | ✓ | ||||
| "Flip" | - | - | - | - | - | - | + | - | - | ✓ | ✓ | ||||
| "Mirror" | - | - | - | - | - | - | + | - | - | ✓ | ✓ | ||||
| Button | String | Fullauto event | |||||||||||||
| "On" / "Off" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | ||||
| "Presat" | - | - | - | - | - | - | + | + | - | - | - | ||||
| Exposure event | |||||||||||||||
| "Auto" / "Manual" / "IrisPriority" (AAE on PZ400/200/510) / "ShutterPriority" (SAE on PZ400/200/510) / "Bright" (only PZ400/200/510) | - | - | - | - | - | - | - | ✓ | - | ✓ | ✓ | ||||
| Iris event | |||||||||||||||
| "Manual" / "Auto" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | ||||
| "Open1" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| "Open2" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | |||||
| "Open3" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||||||
| "Close1" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ||||
| "Close2" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||||||
| "Close3" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ||||||
| "PushAuto" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ||||||||
| Gain event | |||||||||||||||
| "Alc" | ✓ | ✓ | - | ||||||||||||
| "Lolux" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ||||||
| "L" / "M" / "H" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - | - |
| "Variable" | - | - | - | - | - | - | ✓ | - | - | - | - | - | - |
| "Up1" | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| "Up2" | - | - | - | - | - | - | ✓ | - | - | - | - | - | - |
| "Down1" | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| "Down2" | - | - | - | - | - | - | ✓ | - | - | - | - | - | - |
| "Manual" / "Auto" | - | - | - | - | - | - | - | - | - | - | - | - | - |
| AeLevel event | |||||||||||||
| "AeLevelUp" / "AeLevelDown" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - | - |
| "AdjustOn" / "AdjustOff" | - | - | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - | - |
| "Up" / "Down" | - | - | - | - | - | - | - | ✓ | - | - | - | - | - |
| Shutter event | |||||||||||||
| "Off" | ✓ | ✓ | ✓ | - | - | - | - | - | - | - | + | - | - |
| "Step" | - | - | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - | - |
| "Variable" | - | - | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - | - |
| "Manual" | ✓ | ✓ | - | - | - | - | - | - | - | - | - | - | - |
| "Ecl" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - | - | - |
| "Slower" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| "Faster" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Whb event | |||||||||||||
| "Faw" | ✓ | ✓ | - | - | - | - | - | ✓ | - | - | - | - | - |
| "Preset" / "A" / "B" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | - | - | - | - |
| "Adjust" (Awb trigger when PZ100, OnePush trigger when PZ400/200/510) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| "WhPaintRP"/'WhPaintRM" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | ✓ | ✓ | ✓ | ✓ | ✓ |
| "WhPaintBP"/'WhPaintBM" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| "Awb" | - | - | - | - | - | - | - | ✓ | - | - | - | - | - |
| "3200K" | - | - | - | - | - | - | - | ✓ | - | - | - | - | - |
| "5600K" | - | - | - | - | - | - | - | ✓ | - | - | - | - | - |
| "Manual" | - | - | - | - | - | - | - | ✓ | - | - | ✓ | ✓ | ✓ |
| "Auto" | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ |
| "Indoor" | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ |
| "Outdoor" | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ |
| "OnePush" | - | - | - | - | - | - | - | - | - | - | - | ✓ | ✓ |
| Zoom event | |||||||||||||
| "Tele1" / "Tele2" / "Tele3" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| "Wide1" / "Wide2" / "Wide3" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| "Stop"※"Tele" or "Wide" events need "Stop" in KY-PZ100 / PZ400 / PZ200 / PZ510. | - | - | - | - | - | - | - | ✓ | - | - | ✓ | ✓ | ✓ |
| Focus event | |||||||||||||
| "Manual" / "Auto" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ |
| "Far1" / "Far2" / "Far3" / "Near1" / "Near2" / "Near3" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| "Infinity" | ✓ | ✓ | - | - | - | - | - | - | - | - | - | - | - |
| "PushAuto" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | |
| "Stop"※"Far" or "Near" events need "Stop" in KY-PZ100 / PZ400 / PZ200 / PZ510. | - | - | - | - | - | - | - | ✓ | - | - | ✓ | ✓ | ✓ |
| MasterBlack event | |||||||||||||
| "Up1" / "Up2" / "Up3" / "Down1" / "Down2" / "Down3" | - | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | ✓ | ✓ | - | - | - |
| User event | |||||||||||||
| "Sw0" | - | - | ✓ | - | - | - | - | - | ✓ | - | - | ||
| "Sw1" / "Sw2" / "Sw3" / "Sw4" / "Sw5" / "Sw6" / "Sw7" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | ✓ | ✓ | - | - | - |
| "Sw8" | - | - | ✓ | ✓ | ✓ | ✓ | - | - | ✓ | ✓ | - | - | - |
| "Sw9" | - | - | ✓ | ✓ | ✓ | ✓ | - | - | ✓ | - | - | - | |
| "Sw10" | - | - | ✓ | - | - | - | ✓ | - | + | ✓ | - | - | |
| "Sw11" | - | - | ✓ | - | - | - | - | + | + | ✓ | - | - | - |
| "Sw12" / "Sw13" | - | - | - | - | - | + | + | - | - | √ | - | - | |
| "LensRef" | - | - | √ | - | - | - | - | - | √ | - | - | - | |
| "Sub1" / "Sub2" / "Sub3" | - | - | - | - | - | - | - | √ | - | - | - | - | |
| "VISw1" / "VISw2" | - | - | - | - | - | - | - | - | √ | - | - | - | |
| Disptv event | |||||||||||||
| "On":(Display on TV) / "Off":(Display on TV) | √ | √ | - | √ | √ | √ | √ | - | - | - | - | - | |
| "Sci":(Character Mix) | - | - | √ | - | - | - | - | - | √ | √ | - | - | |
| "Hdmi":(Character Mix) | - | - | √ | - | - | - | - | - | √ | √ | - | - | |
| "Video":(Character Mix) | - | - | √ | - | - | - | - | - | √ | √ | - | - | |
| Menu event | |||||||||||||
| "Display":(Menu) / "Status":(Menu) / | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - | |
| "Menu":(Menu) / "Cancel":(Menu) / "Set":(Menu) / | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| "Up":(Menu) / "Down":(Menu) / "Left":(Menu) / "Right":(Menu) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | |
| ※ "Up", "Down", "Left", and "Right" events call assigned function when menu is closed. | - | - | - | - | - | - | - | - | √ | √ | - | - | |
| Rec event | |||||||||||||
| "Start":Recording start / "Stop":Recording stop | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - | - | |
| Detail event "Up" / "Down" | - | √ | √ | √ | √ | - | √ | √ | √ | - | - | - | |
| SpeedWithZoom event "Off" / "On" | - | - | - | - | - | - | - | √ | - | - | √ | √ | |
| Bright event | |||||||||||||
| "Up" / "Down" | - | - | - | - | - | - | - | - | - | - | √ | √ | |
| Luminance event | |||||||||||||
| "Up" / "Down" | - | - | - | - | - | - | - | - | - | - | √ | √ | |
| Saturation event | |||||||||||||
| "Up" / "Down" | - | - | - | - | - | - | - | - | - | - | √ | √ | |
| Contrast event | |||||||||||||
| "Up" / "Down" | - | - | - | - | - | - | - | - | - | - | √ | √ | |
| Sharpness event | |||||||||||||
| "Up" / "Down" | - | - | - | - | - | - | - | - | - | - | √ | √ | |
| Hue event | |||||||||||||
| "Up" / "Down" | - | - | - | - | - | - | - | - | - | - | √ | √ | |
| Flip event | |||||||||||||
| "On" / "Off" | - | - | - | - | - | - | - | - | - | - | √ | √ | |
| Mirror event | |||||||||||||
| "On" / "Off" | - | - | - | - | - | - | - | - | - | - | √ | √ |
Example
| "Request": { |
| "Command": "SetWebButtonEvent", |
| "SessionID": "7425fcbc58cc4d15dd4c1f5acc4299a3", |
| "Params": { |
| "Kind": "Fullauto", |
| "Button": "On" |
| } |
| } |
Response Key Style
Value
| Response | |||||||||||||||
| Requested | String | SetWebButtonEvent | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ |
| Result | String | (Result of command processing.) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ |
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 | HM850 | HM860 | HM870 | HM200 | HM250 | HM260 | HM300 | HM350 | HM400 | HM450 | HM500 | HM550 | ||
| Command | String | SetWebSliderEvent | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| SessionID | String | (Session ID in cookie.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| Params | |||||||||||||||
| Kind | String | Kind of Slider event | |||||||||||||
| "ZoomBar " | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| "IrisBar " | - | - | - | - | - | - | - | - | ✓ | ✓ | - | - | |||
| Position | Integer | Slider event | |||||||||||||
| ZoomBar 0~499:Zoom position | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | |||
| IrisBar 0~255:Iris position | - | - | - | - | - | - | - | - | ✓ | ✓ | - | - | |||
Example
| "Request": { |
| "Command": "SetWebSliderEvent", |
| "SessionID": "7425fbcb580c4d15dd4c1f5aco4299a3", |
| "Params": { |
| "Kind": "ZoomBar", |
| "Position": 73 |
| } |
| } |
| Response Key Style Value | |||||||||||||||
| Response | |||||||||||||||
| Requested | String | SetWebSliderEvent | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Result | String | (Result of command processing.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
Example
| "Response": {"Requested": "SetWebSliderEvent", "Result": "Success"} |
3.3.8. Set Web XYField Event
Issue a two-dimensional slider event
Request Key Style
Value
| Request | ||||||||||||||||
| Command | Siting | SetWebXYFieldEvent | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| SessionID | Siting | (Session ID in cookie.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| Params | ||||||||||||||||
| Kind | Siting | Kind of XYField event"WhPaintRB "White paint R and B | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| XPosition | Integer | XYField eventWhPaintRB "0"~"64" (White paint B position) (PZ400/200/510: Max value of Whb Auto is 20, Whb manual is 255) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| YPosition | Integer | XYField eventWhPaintRB "0"~"64" (White paint R position) (PZ400/200/510: Max value of Whb Auto is 20, Whb manual is 255) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
Example
| "Request":{ |
| "Command": "SetWebXYFieldEvent1", |
| "SessionID": "7425fbb58se4d15dd4c1f5ace4299a3", |
| "Params":{ |
| "Kind": "WhPaintRB", |
| "XPosition": 32, |
| "YPosition": 32 |
| } |
| } |
Response Key Style
Value
| Response | ||||||||||||||||
| Requested | String | SetWebXYFieldEvent | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
| Result | String | (Result of command processing.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |||
Example
| "Response": { "Requested": "SetWebXYFieldEvent", "Result": "Success"} |
3.3.9. Get GPS Information
Request location information of camera GPS function.
Request Key Style
| Syc | Value | H4650 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H 4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H466 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Request | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Command | Siting | GetGPSInfo | √ | √ | √ | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4660 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H4200 | H 4200 | H 4200 | H 4200 | H 4200 | H 4200 | H 4200 | H 4200 | H 4200 | H 4200 | H 4200 | H 4200 | H 4200 | H 4200 | H 4200 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 410 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | H 4100 | |
| SessionID | Siting | (Session ID in cookie.) | √ | √ | √ | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example
| "Request": {Command": "GetCIPInfo",SessionID": "7425fbb68ee4d15dd4c1f5ace4209a3"}; |
Response Key Style
| Response | |||||||||||||||
| Requested | Siting | GetGPSInfo | ✓ | ✓ | ✓ | - | - | - | - | - | ✓ | ✓ | - | - | |
| Result | Siting | {Result of command processing.} | ✓ | ✓ | ✓ | - | - | - | - | - | ✓ | ✓ | - | - | |
| Data | |||||||||||||||
| AntennaLevel | Siting | "None" / "Losi" / "Searching" / "Level1" / "Level2" / "Level3" | ✓ | ✓ | ✓ | - | - | - | - | - | ✓ | ✓ | - | - | |
| Location | Siting | "+/-"<=/"-<Longitude>"/-/*<Altitude>/*"Latitude + North, -South,00.00000(min) - 90.000000(max)Longitude + East, -West,000.000000(min) - 179.9999999(max)Altitude +, .0.000000(min) - 99999999(max) | ✓ | ✓ | ✓ | - | - | - | - | - | ✓ | ✓ | - | - | |
*Location data is valid only if AntennaLevel is "Level1", "Level2", or "Level3".
Example
| 'Response': { "Requested": "GetG/Sinto", "Result": "Success", "Data": { "AntennaLevel": "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
| Style | Value | HM650 | HM660 | HM6u0 | HM200 | HM25x | HM420 | HM330 | PZ100 | H2900 | H25w0 | PZ400 | PZ700 | PZ510 | |||||||||||||||
| Request | |||||||||||||||||||||||||||||
| Command | String | SeesawSwitchOperation | - | √ | √ | √ | √ | √ | - | - | - | √ | √ | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | |
| SessionID | String | (Session ID in cookie.) | - | √ | √ | √ | √ | √ | - | - | - | √ | √ | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | |
| Params | |||||||||||||||||||||||||||||
| Kind | String | Kind of Seesaw event"ZoomSeesaw" / "IrisSeesaw" / "MasterBlackSeesaw" / "FocusSeesaw" | - | √ | √ | √ | √ | √ | - | - | - | √ | √ | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | |
| Direction | String | Zoom operation"Stop" / "Wide" / "Tele"Iris operation"Open" / "Close" / "Stop"MasterBlack operation"Up" / "Down" / "Stop"Focus operation"Far" / "Near" / "Stop" | - | √ | √ | √ | √ | √ | - | - | - | √ | √ | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | |
| Speed | Integer | 0 - 8 | - | √ | √ | √ | √ | √ | - | - | - | √ | √ | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | |
"Speed = 0" has the same meaning as "Direction = Stop".
Example
| "Request": { |
| "Command": "SeesawSwitchOperation", |
| "SessionID": "7425fbb58ee4d15dd4c1f5ace4299a3", |
| "Params": { |
| "King": "MasterBlack", |
| "Direction": "Up", |
| "Speed": 5 |
| } |
| } |
Response Key Style
| by Style | Value | HM850 | HM860 | HM830 | HM220 | HM250 | HM280 | LS390 | PZ130 | HC300 | HC540 | PZ420 | PZ220 | PZ510 | ||
| Response | ||||||||||||||||
| Requested | Siting | SeesawSwitchOperation | - | √ | √ | √ | √ | - | - | √ | √ | - | - | - | - | |
| Result | Siting | {Result of command processing.} | - | √ | √ | √ | √ | - | - | √ | √ | - | - | - | - | |
Example
| { |
| "Response": { |
| "Requested": "SeesawSwitchOperation", |
| "Result": "Success" |
| } |
3.4.1. Set Pan Tilt Control
Pan / Tilt control command with direct position parameters.
| Request Key Style | Value | H16650 | H16650 | H16650 | H16200 | H16250 | H16250 | H13300 | H13300 | H13300 | H12900 | H12900 | H12500 | H12400 | H12400 | F2510 | ||
| Request | ||||||||||||||||||
| Command | String | SetPTCtrl | - | - | - | - | - | - | - | - | √ | - | - | √ | √ | √ | ||
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | √ | - | - | √ | √ | √ | ||
| Params | ||||||||||||||||||
| PanDirection | String | "Stop" / "Left" / "Right" / "Home" / "Position" | - | - | - | - | - | - | - | - | √ | - | - | √ | √ | √ | ||
| PanPosition | Integer / String | 0~0"(Back left limit)- 17540~17540"(Front)- 35080~35080"(Back right limit)PanPosition is valid when "PanDirection" is "Position". | - | - | - | - | - | - | - | - | √ | - | - | √ | √ | √ | ||
| PanSpeed | Integer / String | 0 - 30/0"~"30" | - | - | - | - | - | - | - | - | √ | - | - | √ | √ | √ | ||
| TiltDirection | String | "Stop" / "Up" / "Down" / "Home" / "Position" | - | - | - | - | - | - | - | - | √ | - | - | √ | √ | √ | ||
| TiltPosition | Integer / String | 0~0"(Just above)- 9040~9040"(Just beside)- 12080~12080"( diagonally downward)"TiltPosition" is valid when "TiltDirection" is "Position". | - | - | - | - | - | - | - | - | √ | - | - | √ | √ | √ | ||
| TiltSpeed | Integer / String | 0 - 30/0"~"30" | - | - | - | - | - | - | - | - | √ | - | - | √ | √ | √ | ||
"Speed = 0" has the same meaning as "Direction = Stop".
Example
| "Request":{ |
| "Command": "SetPTCtr", |
| "SessionID": "7425fbcbSsee4d15dd4c1f5ace4298a3", |
| "Params":{ |
| "PanDirection": "Left", |
| "PanPosition": 32768, |
| "PanSpeed": 10, |
| "TiltDirection": "Up", |
| "TiltPosition": 32768, |
| "TiltSpeed": 10 |
| } |
| } |
Response Key Style
Value
| Response | |||||||||||||
| Requested | String | SetPTCtrl | |||||||||||
| Result | String | (Result of command processing.) | |||||||||||
Example
| { |
| "Response": { |
| "Requested": "SetPTCm". |
| "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.
When auto tracking is on, the tracking target is switched by pan (left or right).
Request Key Style
Value
| Request | |||||||||||||||
| Command | Siring | JoyStickOperation | - | - | - | - | - | - | - | √ | - | - | √ | √ | |
| SessionID | Siring | {Session ID in cookie.} | - | - | - | - | - | - | - | √ | - | - | √ | √ | |
| Params | |||||||||||||||
| PanDirection | Siring | "Stop" / "Left" / "Right" | - | - | - | - | - | - | - | √ | - | - | √ | √ | |
| PanSpeed | Integer | 0 - 30 | - | - | - | - | - | - | - | √ | - | - | √ | √ | |
| TiltDirection | Siring | "Stop" / "Up" / "Down" | - | - | - | - | - | - | - | √ | - | - | √ | √ | |
| TiltSpeed | Integer | 0 - 30 | - | - | - | - | - | - | - | √ | - | - | √ | √ | |
"Speed = 0" has the same meaning as "Direction = Stop".
Example
| "Request":{ |
| "Command": "JoyStickOperation", |
| "SessionID": "7425fbb68cc4d15dd4c1f5acc4299a3", |
| "Params":{ |
| "PanDirection": "Left", |
| "PanSpeed": 10, |
| "TiltDirection": "Up", |
| "TiltSpeed": 10 |
| } |
| } |
Response Key Style
Value
| Response | ||||||||||||||
| Requested | String | JoyStickOperation | - | - | - | - | - | + | + | √ | - | - | √ | √ |
| Result | String | (Result of command processing.) | - | - | - | - | - | + | + | √ | - | - | √ | √ |
Example
| "Response":{ "Requested": "JoyStickOperation", "Result": "Success"} |
3.4.3. Zoom switch operation
Zoom switch operation command is changing zoom by a seesaw-switch.
Request Key Style
Value
| Request | |||||||||||||||
| Command | String | ZoomSwitchOperation | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| SessionID | String | (Session ID in cookie.) | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| Params | |||||||||||||||
| Direction | String | "Stop" / "Wide" / "Tele" | - | ✓ | ✓ | ✓ | ✓ | - | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| Speed | Integer | 0 - 8 | - | ✓ | ✓ | ✓ | ✓ | - | - | ✓ | ✓ | - | - | - | |
| Integer / String | 0 - 8"0"~"8" | - | - | - | - | - | - | - | ✓ | - | - | ✓ | ✓ | ||
"Speed = 0" has the same meaning as "Direction = Stop".
Example
| "Request":{ |
| "Command": "ZoomSwitchOperation", |
| "SessionID": "7425fbr656ce4d15004c15acc4299a3", |
| "Params":{ |
| "Direction": "Woe", |
| "Speed": 5 |
| } |
| } |
Response Key Style
Value
| Response | ||||||||||||||
| Requested | String | ZoomSwitchOperation | - | √ | √ | √ | √ | √ | - | √ | √ | √ | √ | √ |
| Result | String | (Result of command processing.) | - | √ | √ | √ | √ | √ | - | √ | √ | √ | √ | √ |
Example
| "Response": { "Requested": "ZoomSwitchOperation", "Result": "Success"} |
3.4.4. Set Pan / Tilt / Zoom preset
Control pan / tilt / zoom preset position.
Request Key Style
Value
| Request | |||||||||||||||||
| Command | Siting | SetPTZPreset | - | - | - | - | - | - | - | - | √ | - | - | √ | √ | √ | |
| SessionID | Siting | (Session ID in cookie.) | - | - | - | - | - | - | - | - | √ | - | - | √ | √ | √ | |
| Params | |||||||||||||||||
| No | Integer / String | 1 - 100"/1"~"100"(Number of preset position) | - | - | - | - | - | - | - | - | √ | - | - | √ | √ | √ | |
| 1 - 255"/1"~"255"(Number of preset position in case of PZ400/200/510) | |||||||||||||||||
| Operation | Siting | "Move"(Move to preset position) | - | - | - | - | - | - | - | - | √ | - | - | √ | √ | √ | |
| "Set" (Current position is stored) | |||||||||||||||||
| "Delete"(Delete the preset position) | |||||||||||||||||
Example
| 'Request': { |
| "Command": "Set"T27"reset", |
| "SessionID": "7425fbcr56ce4d150d4c15acc4299a3", |
| "Params": { |
| "No": 90, |
| "Operation": "Move" |
| } |
| } |
Response Key Style
Value
| Response | |||||||||||||
| Requested | Siting | SetPTZPreset | - | - | - | - | - | - | - | - | - | - | ✓ |
| Result | Siting | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | ✓ |
Example
| { |
| "Response": { |
| "Requested": "SetPTZProset", |
| "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 Style Value | HM650 | HM660 | HM6a0 | HM200 | HM25x | HM280 | HM300 | HM320 | HM330 | FV100 | HC200 | HC250 | FV400 | FV400 | FV700 | FV2510 | ||
| Request | ||||||||||||||||||
| Command | Siring | GetCamStatusMinimum | - | - | - | - | - | - | - | - | - | √ | - | - | √ | √ | √ | √ |
| SessionID | Siring | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | √ | - | - | √ | √ | √ | √ |
| Response Key Style | Value | HH650 | HH680 | HH690 | HH700 | HH725x | HH7300 | HH7400 | HH7500 | HH7600 | HH7700 | |
| Response | ||||||||||||
| Requested | String | GetCamStatusMinimum | - | - | - | - | - | - | - | √ | - | √ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | √ | - | √ |
| Data | ||||||||||||
| Camera (Camera) | ||||||||||||
| Status | String | Status"NoCard"(no card inserted) / "Stop"(recording stop) / PZ100:200 always return "NoCard"."Standby"(record standby) / "Rec"(recording)/"RecPause"(recording pause) | - | - | - | - | - | - | - | √ | - | √ |
| VideoOutputStatus | String | "On" / "Off" | - | - | - | - | - | - | - | √ | - | √ |
| MenuStatus | String | "On" / "Off" | - | - | - | - | - | - | - | √ | - | √ |
| Exposure | ||||||||||||
| Status | String | "Auto" / "Manual" / "IrisPriority" / "ShutterPriority"Bright" | - | - | - | - | - | + | - | √ | - | √ |
| - | - | - | - | - | - | - | - | - | √ | |||
| Ins | ||||||||||||
| Status | String | "Auto" / "Manual" | - | - | - | - | - | - | - | √ | - | √ |
| Value | String | Character string for iris value | - | - | - | - | - | - | - | √ | - | √ |
| Shutter | ||||||||||||
| Status | String | "Auto" / "Manual" | - | - | - | - | - | - | - | √ | - | √ |
| Value | String | Character string for Shutter value | - | - | - | - | - | - | - | √ | - | √ |
| Gain | ||||||||||||
| Status | String | "Auto" / "Manual" | - | - | - | - | - | - | - | √ | - | √ |
| Value | String | Character string for gain value | - | - | - | - | - | - | - | √ | - | √ |
| AeLevel | ||||||||||||
| Status | String | "AeOff" / "AeOn" | - | - | - | - | - | - | - | √ | - | - |
| Value | String | Character string for AE level value | - | - | - | - | - | - | - | √ | - | - |
| Whb | ||||||||||||||
| Status | String | "Faw" / OnePush" / "3200K" / "5600K" / "Manual" | - | - | - | - | - | + | - | / | + | - | - | |
| "OnePush" / "Manual" / "Auto" / "Indoor" / "Outdoor" | - | - | - | - | - | - | - | - | - | √ | √ | |||
| Value | String | Character string for White Balance value | - | - | - | - | - | + | - | √ | - | √ | √ | |
| WhPRScale | Integer | Slide bar total length for White paint Red(0-255) | - | - | - | - | - | - | - | √ | - | √ | √ | |
| WhPBScale | Integer | Slide bar total length for White paint Blue(0-255) | - | - | - | - | - | + | - | √ | - | √ | √ | |
| WhPRPosition | Integer | Slide bar current position for White paint Red(0-255) | - | - | - | - | - | - | - | √ | - | √ | √ | |
| WhPBPosition | Integer | Slide bar current position for White paint Blue(0-255) | - | - | - | - | - | + | - | √ | - | √ | √ | |
| WhPRValue | String | Character string for White paint Red value | - | - | - | - | - | + | - | √ | - | √ | √ | |
| WhPBValue | String | Character string for White paint Blue value | - | - | - | - | - | + | - | √ | - | √ | √ | |
| Focus | ||||||||||||||
| Status | String | "Auto" / "Manual" | - | - | - | - | - | + | - | √ | - | √ | √ | |
| Value | String | Character string for Focus value | - | - | - | - | - | + | - | √ | - | √ | √ | |
| Zoom | ||||||||||||||
| Position | Integer | Zoom position (0 499) | - | - | - | - | - | + | - | √ | - | √ | √ | |
| Detail | ||||||||||||||
| Value | String | Character string for detail value | - | - | - | - | - | + | - | √ | - | - | - | |
| Bright | ||||||||||||||
| Value | String | Character string for Bright value | - | - | - | - | - | + | - | - | - | √ | √ | |
| 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.RISP/RTP)..."Error"(Error occurred or waiting to start RTSP/RTP streaming and SRT Listener mode) | - | - | - | - | - | + | - | √ | - | √ | √ | |
| TallyLamp | ||||||||||||||
| Priority | String | Priority "Camera" / "Web" | - | - | - | - | - | + | - | √ | - | - | - | |
| Lighting | String | Lighting "On" / "Off" | - | - | - | - | - | - | - | √ | - | √ | √ | |
| StudioTally | String | Status "Off" / "Program" / "Preview" | - | - | - | - | - | + | - | √ | - | √ | √ | |
| Tracking | ||||||||||||||
| Status | String | "On" / "Off" | - | - | - | - | - | + | - | - | - | - | - | |
| TrackingMode | ||||||||||||||
| Status | String | "Standard" / "Area" / "Stage" / "WideArea" / "FineAdjustment" | - | - | - | - | - | + | - | - | - | - | - | |
| Enable (Availability of function button switches) | ||||||||||||||
| Exposure (Exposure function) | ||||||||||||||
| Auto | Integer | button "Auto" switch of exposure 0:Disable, 1:Enable | - | - | - | - | - | + | - | √ | - | √ | √ | |
| Manual | Integer | button "Manual" switch of exposure 0:Disable, 1:Enable | - | - | - | - | - | - | - | √ | - | √ | √ | |
| ShutterPriority | Integer | button ShutterPriority" switch of exposure0:Disable, 1:Enable | - | - | - | - | - | + | - | √ | - | √ | √ | |
| IrisPriority | Integer | button "IrisPriority" switch of exposure0:Disable, 1:Enable | - | - | - | - | - | + | - | √ | - | √ | √ | |
| Bright | Integer | button "Bright" switch of exposure0:Disable, 1:Enable | - | - | - | - | - | + | - | - | - | √ | √ | |
| Iris (Iris function) | ||||||||||||||
| Open1 | Integer | button "-" switch of iris 0:Disable, 1:Enable | - | - | - | - | - | + | - | √ | - | √ | √ | |
| Close1 | Integer | button "<" switch of iris 0:Disable, 1:Enable | - | - | - | - | - | + | - | √ | - | √ | √ | |
| Gain (Gain function) | |||||||||||||||
| Auto | Integer | Display Value of gain 0:Disable, 1:Enable PZ400/200 always return 0. | - | - | - | - | - | - | √ | - | - | √ | √ | ||
| Manual | Integer | button "MANUAL" switch of gain 0:Disable, 1:Enable PZ400/200 always return 0. | - | - | - | - | - | - | √ | - | - | √ | √ | ||
| Up1 | Integer | button "Up1" switch of gain 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | √ | √ | ||
| Down1 | Integer | button "Down1" switch of gain 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | √ | √ | ||
| AeLevel | (AE Level function) | ||||||||||||||
| Up | Integer | button "▲" switch of AElevel 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | - | - | ||
| Down | Integer | button "▼" switch of AElevel 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | - | - | ||
| Shutter (Shutter function) | |||||||||||||||
| Slower | Integer | button "▲" switch of shatter 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | √ | √ | ||
| Faster | Integer | button "▼" switch of shatter 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | √ | √ | ||
| Wnb (White balance function) | |||||||||||||||
| Faw | Integer | button "FAW" switch of White balance 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | - | - | ||
| Auto | Integer | button "Auto" switch of White balance 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | √ | √ | ||
| Indoor | Integer | button "Indoor" switch of White balance 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | √ | √ | ||
| Outdoor | Integer | button "Outdoor" switch of White balance 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | √ | √ | ||
| OnePush | Integer | button "OnePush" switch of White balance 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | √ | √ | ||
| Manual | Integer | button "MANUAL" switch of White balance 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | √ | √ | ||
| Awb | Integer | button "AWB" switch of White balance 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | - | - | ||
| K3200 | Integer | button "3200K" switch of White balance 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | - | - | ||
| K5600 | Integer | button "5600K" switch of White balance 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | - | - | ||
| AwbTrigger | Integer | button "AWB trigger" switch of White balance 0:Disable, 1:Enable (In case of PZ400/200/510, this may Enable only in OnePush mode.) | - | - | - | - | - | - | √ | - | - | √ | √ | ||
| Focus (Focus function) | |||||||||||||||
| Manual | Integer | button "MANUAL" switch of focus 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | √ | √ | ||
| Auto | Integer | button "AUTO" switch of focus 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | √ | √ | ||
| Detail | (Detail function) | ||||||||||||||
| Up | Integer | button "ON" switch of Detail 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | - | - | ||
| Down | Integer | button "OFF" switch of Detail 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | - | - | ||
| Bright | (Bright function) | ||||||||||||||
| Up | Integer | button "ON" switch of Bright 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | √ | √ | ||
| Down | Integer | button "OFF" switch of Bright 0:Disable, 1:Enable | - | - | - | - | - | - | √ | - | - | √ | √ | ||
| Tracking (Auto tracking function) | |||||||||||||||
| On | Integer | button "On" switch of auto tracking 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | ||
| Off | Integer | button "Off" switch of auto tracking 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | ||
| TrackingMode (Auto tracking mode function) | |||||||||||||||
| Standard | Integer | button "Standard" switch of auto tracking mode 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | ||
| Area | Integer | button "Area" switch of auto tracking mode 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | ||
| Stage | Integer | button "Stage" switch of auto tracking mode 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | ||
| WideArea | Integer | button "WideArea" switch of auto tracking mode 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | ||
| FineAdjustment | Integer | button "FineAdjustment" switch of auto tracking mode 0:Disable, 1:Enable | - | - | - | - | - | - | - | - | - | - | - | ||
| Preset (Availability of preset number) | |||||||||||||||
| 1 | Integer | PTZ preset number is operatable. 0:Disable, 1:Enable | - | - | - | - | - | + | - | √ | - | - | √ | √ | |
| 2 | Integer | PTZ preset number is operatable. 0:Disable, 1:Enable | - | - | - | - | - | - | - | √ | - | - | √ | √ | |
| ········· | |||||||||||||||
| # | Integer | PTZ preset number is operatable. 0:Disable, 1:Enable | - | - | - | - | - | - | - | √ | - | - | √ | √ | |
| 100 | Integer | PTZ preset number is operatable. 0:Disable, 1:Enable | - | - | - | - | - | + | - | √ | - | - | √ | √ | |
Example
{
"Response": {
"Requested": "GotCamStatusMinimum",
"Result": "Success",
"Data": {
"Camera": {
"VideoOutputStatus": "On", "MenuStatus": "On"
},
"Exposure": {
"Status": "Auto"
},
"Iris": {
"Status": "Auto", "Value": "0"
},
"Shutter": {
"Status": "Auto", "Value": "0"
},
"Gain": {
"Status": "Auto", "Value": "0"
},
"AeLevel": {
"Status": "AeOn", "Value": "0"
},
"Whb": {
"Status": "Faw", "Value": "0",
"WhPRScale": 0, "WhPBScale": 0,
"WhPRPosition": 64, "WhPBPosition": 64,
"WhPRValue": "64", "WhPBValue": "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, "InsPriority": 1
},
"Iris": {
"Open": 1, "Close": 1
},
"Gown": {
"Auto": 1, "Manual": 1, "Up": 1, "Down": 1
},
"AeLevel": {
"Up": 1, "Down": 1
},
"Shutter": {
"Slower": 1, "Faster": 1
},
"Who": {
"Faw": 1, "Manual": 1, "OnePush": 1, "K3200": 1, "K5600": 1, "OnePushTrigger": 1
},
"Focus": {
"Auto": 1, "Manual": 1
},
"Detail": {
"Up": 1, "Down": 1
},
"Reset": {
"1": 1, 2": 1, 3": 1, 4": 1, 5": 1, 6": 1, 7": 1, 8": 1, 9": 1, 10": 1,
"1": 1, "2": 1, "3": 1, "4": 1, "5": 1, "6": 1, "7": 1, "8": 1, "9": 1, "10": 1,
"2": 1, "22": 1, "23": 1, "24": 1, "25": 1, "26": 1, "27": 1, "28": 1, "29": 1, "30": 1,
"3": 1, "32": 1, "33": 1, "34": 1, "35": 1, "36": 1, "37": 1, "38": 1, "39": 1, "40": 1,
"4": 1, "42": 1, "43": 1, "44": 1, "45": 1, "46": 1, "47": 1, "48": 1, "49": 1, "50": 1,
"5": 1, "52": 1, "53": 1, "54": 1, "55": 1, "56": 1, "57": 1, "58": 1, "59": 1, "60": 1,
"6": 1, "62": 1, "63": 1, "64": 1, "65": 1, "66": 1, "67": 1, "68": 1, "69": 1, "70": 1,
"7": 1, "72": 1, "73": 1, "74": 1, "75": 1, "76": 1, "77": 1, "78": 1, "79": 1, "80": 1,
"8": 1, "82": 1, "83": 1, "84": 1, "85": 1, "86": 1, "87": 1, "88": 1, "89": 1, "90": 1,
"9": 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
| Syc | Value | ||||||||||||
| Request | |||||||||||||
| Command | String | GetPTPosition | |||||||||||
| SessionID | String | (Session ID in cookie.) | |||||||||||
Example
| "Request": { |
| "Command": "Get"TPosition", |
| "SessionID": "7425fbb58ee4d15dd4c1f5ace4299a3", |
| } |
Response Key Style
| Response | |||||||||||||||
| Requested | Siting | GetPTPosition | - | - | - | - | - | - | - | - | - | √ | √ | ||
| Result | Siting | {Result of command processing.} | - | - | - | - | - | - | - | √ | - | √ | √ | ||
| Data | |||||||||||||||
| Pan | Integer | 0(Back left limit)- 17540(Front)- 35080(Back right limit) | - | - | - | - | - | - | - | √ | - | √ | √ | ||
| Tilt | Integer | 0(Just above)- 9040(Just beside)- 12080(Diagonally downward) | - | - | - | - | - | - | - | √ | - | √ | √ | ||
Example
| 'Response';{ "Requested": "GetPTPosition", "Result": "Success", "Data": { "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
| Request | ||||||||||||||
| Command | String | JpegEncode | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - |
| SessionID | String | (Session ID in cookie.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - |
| Params | ||||||||||||||
| Operate | String | "Start" / "Stop" | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - |
Example
| { |
| "Request": { |
| "Command": "JocgEncode", |
| "SessionID": "7425fbbcb8see4d15dd4c1f5ace4269a3", |
| "Params": { |
| "Operate": "Start" |
| } |
| } |
Response Key Style
Value
| Response | ||||||||||||||
| Requested | Siting | JpegEncode | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - |
| Result | Siting | (Result of command processing.) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √ | - | - |
Example
| { |
| "Response": { |
| "Requested": "JpegEncode", |
| "Result": "Success" |
| } |
3.5.2. Set JPEG encode size
Setting image resolution of acquiring JPEG data.
| Request Key Size Value | |||
| Request | |||
| Command | Siring | SetJpegEncodeSize | |
| SessionID | Siring | (Session ID in cookie.) | |
| "Params | |||
| Size | Siring | "640x360" / "320x180" | |
| Response | ||
| Requested | Siting | SetUpegEncodeSize |
| Result | Siting | (Result of command processing.) |
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 | HW850 | HW860 | HW860 | HW8200 | HW825x | HW8200 | HW8200 | HW8200 | HW8200 | HW8200 | HW8200 | HW8200 | HW8200 | HW8200 | HW8200 | HW8200 | HW8200 | HW8200 | HW8200 | HW8200 | HW8200 | HW8200 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW880 | HW880 | HW880 | HW880 | HW880 | HW880 | HW880 | HW880 | HW880 | HW880 | HW880 | HW880 | HW880 | HW880 | HW880 | HW880 | HW880 | HW880 | HW880 | HW880 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW870 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW890 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW860 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW850 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW840 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW830 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW820 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW800 | HW800 | HW800 | HW800 | HW800 | HW800 | HW800 | HW800 | HW800 | HW800 | HW800 | HW800 | HW800 | HW800 | HW800 | HW800 | HW800 | HW800 | HW800 | HW800 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW805 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW810 | HW815 | HW810 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW810 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW810 | HW815 | HW810 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW810 | HW815 | HW815 | HW810 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW810 | HW810 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW810 | HW810 | HW815 | HW810 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW810 | HW815 | HW815 | HW815 | HW810 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW810 | HW815 | HW810 | HW815 | HW810 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW810 | HW810 | HW815 | HW815 | HW810 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 | HW815 |
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 Syc | Value | ||||||||||||
| Request | |||||||||||||
| Command | String | GetIFBSettings | - | √ | √ | - | - | - | - | - | - | - | - |
| SessionID | String | (Session ID in cookie.) | - | √ | √ | - | - | - | - | - | - | - | - |
Example
| "Request": { |
| "Command": "GetIFBSettings", |
| "SessionID": "7425fcbv58cc04d150d4c1f5acc4299a3", |
| } |
| Response Key Style Value | |||||||||||||
| Requested | String | GetIFBSettings | - | √ | √ | - | - | - | - | - | + | - | - |
| Result | String | (Result of command processing.) | - | √ | √ | - | - | - | - | - | - | - | - |
| Data | |||||||||||||
| Function | String | Switch to enable IFB function. "Enable" / "Disable" | - | √ | √ | - | - | - | - | - | + | - | - |
| Address | String | Address of IFB server. "xxx.xxx.xxx.xxx" | - | √ | √ | - | - | - | - | - | + | - | - |
| Port | Integer | Port of IFB server. 1 - 65535 | - | √ | √ | - | - | - | - | - | + | - | - |
| Mountpoint | String | Mountpoint on IFB server. Max 62 characters. | - | √ | √ | - | - | - | - | - | + | - | - |
Example
| "Response": [ |
| "Requested": "GenITBSettings", |
| "Result": "Success", |
| "Data": { |
| "Function": "Enable", |
| "Address": "192.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 Size | Value | ||||||||||||
| Request | |||||||||||||
| Command | String | Set!FBSettings | - | √ | √ | - | - | - | - | - | - | - | - |
| SessionID | String | (Session ID in cookie.) | - | √ | √ | - | - | - | - | - | - | - | - |
| Params | |||||||||||||
| Function | String | Switch to enable IFB function. "Enable" / "Disable" | - | √ | √ | - | - | - | - | - | - | - | - |
| Address | String | Address of IFB server. "xxx.xxx.xxx.xxx" | - | √ | √ | - | - | - | - | - | - | - | - |
| Port | Integer | Port of IFB server. 1 - 65535 | - | √ | √ | - | - | - | - | - | - | - | - |
| Mountpoint | String | Mountpoint on IFB server, Max 62 characters. | - | √ | √ | - | - | - | - | - | - | - | - |
Example
| { |
| "Request": { |
| "Command": "SetF6Settings, |
| "SessionID": "7425fbcb58cc4d15dd4c15acc4299a3", |
| "Params": { |
| "Function": "Enable", |
| "Address": "192.188.0.11", |
| "Port": 5000, |
| "Mountpoint": "DB90TX" |
| } |
| } |
| Response Key Style Value | ||||||||||||||
| Response | ||||||||||||||
| Requested | String | SetIFBSettings | - | ✓ | ✓ | - | - | - | - | - | - | + | - | - |
| Result | String | (Result of command processing.) | - | ✓ | ✓ | - | - | - | - | - | + | + | - | - |
Example
| { |
| "Response": { |
| "Required": "Set/FBSettings", |
| "Result": "Success" |
| } |
3.6.3. Set interruptible feedback streaming control
This command is used to start/stop IFB streaming
Request Key Style
| Type | Value | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H 4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H4700 | H470 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| Request | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Command | String | SetIFBCtrl | - | √ | √ | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4100 | H4100 | H4100 | H4100 | H4100 | H4100 | H4100 | H4100 | H4100 | H4100 | H4100 | H4100 | H4100 | H4100 | H4100 | H4100 | H4100 | H 4700 | H 4700 | H 4700 | H 4700 | H 4700 | H 4700 | H 4700 | H 4700 | H 4700 | H 4700 | H 4700 | H 4700 | H 4700 | H 4700 | H 470 | ||
| SessionID | String | (Session ID in cookie.) | - | √ | √ | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Params | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example
| "Request":{ "Command": "SetFBCtrl", "SessionID": "7425fbbcb68ce4d15dd4c1f5ace4299a3", "Params": { "Streaming": "Start" } } |
Response Key Style
| Key Style: Value | ||||||||||||
| Response | ||||||||||||
| Requested | Sling | SetIFBCtrl | - | √ | √ | - | - | - | - | - | - | |
| Result | Sling | {Result of command processing.} | - | √ | √ | - | - | - | - | - | - | |
Example
| "Response": { "Requested": "SetFBCtrl", "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/200/510.
Menu settings on HM660/HM200/HM25x/HM280/PZ100
| System... |
| Tally Lamp |
| Off, Rec, Live St |
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.
Request Key Style
Value
| Request | |||||||||||||||
| Command | String | SetStudioTally | √ | √ | √ | √ | √ | - | √ | √ | √ | - | √ | ||
| SessionID | String | (Session ID in cookie.) | - | √ | √ | √ | √ | √ | - | √ | √ | √ | - | √ | |
| Params | |||||||||||||||
| Indication | String | "Oil"(not Indicate status on LCD)/"Program"(Indicate PGM on LCD)/"Preview"(Indicate PVW on LCD) | - | √ | √ | √ | √ | √ | - | √ | √ | √ | - | √ | |
Example
| "Request": { |
| "Command": "SotStudioTally", |
| "SessionID": "7425fbb68ee4d15dd4c1f5ace4209e3", |
| "Params": { |
| "Indication": "Program" |
| } |
| } |
Response Key Style
Value
| Response | ||||||||||||
| Requested | String | SetStudioTally | - | √ | √ | √ | √ | - | √ | √ | √ | - |
| Result | String | (Result of command processing.) | - | √ | √ | √ | √ | - | √ | √ | √ | - |
Example
| "Response": { "Requested": "SetStudioTally", "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 LampOff, Rec. Live Streaming, Rec/Live Streaming, External |
HM8x0/HC900
| This setting becomes "Studio" when the priority is set to "Web". |
| 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
| Request | |||||||||||||||
| Command | String | SetTallyLampPriority | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | + | - | - |
| SessionID | String | {Session ID in cookie.} | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | + | - | - |
| Params | |||||||||||||||
| Priority | Integer | "Camera"(Camera is given priority of control.)/ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | + | - | - |
| "Web"(Web is given priority of control.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | + | - | - |
Example
{
"Requests": {
"Command": "SetTally1.ampPriority",
"SessionID": "7425f0cb58cc4d15dd4c15acc4299a3",
"Params": {
"Priority": "Camera"
}
}
}
Response Key Style
Value
| Response | |||||||||||||||
| Requested | String | SetTallyLampPriority | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - |
| Result | String | (Result of command processing.) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | - | - | - |
Example
{
"Response"; {
"Requested": "SetTallyLampPriority",
"Result": "Success"
}
}
System Chart
![graph TD A["Studio tally control system"] --> B["Network switch"] B --> C1["GY-HM8x0"] B --> C2["GY-HC900"] B --> C3["KY-PZ100"] B --> C4["KY-PZ400"] B --> C5["GY-HM660"] B --> C6["GY-HM200"] B --> C7["GY-HM25x"] B --> C8["GY-HM280"] B --> C9["GY-HC5x0"] C1 --> D1["LED lighting of each model"] C2 --…](/content/2026/06/1348235/images/e1670d5b9a7dd887ef7536b88c3d024e5ca17abfe754dfc7e4230ace0e620644.jpg)
LCD indication image


![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."] A --> E["SetTallyLampPriority Priority:Web."] A --> F["GetCamStatus* returns s…](/content/2026/06/1348235/images/1ac1a698146664b0b4419bf16e29df5ec469e9c13561c515252506ccb74d41cd.jpg)
* "GetCamStatusMinimum" command can be used to acquire the status as well on KY-PZ100/400/510. * KY-PZ400/510 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 | |||||||||||||
| Request | |||||||||||||
| Command | String | GetCurrentReturnOverIpServerID | - | - | - | - | - | - | - | - | √ | - | - |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | √ | - | - |
| Response Key Style Value | ||||||||||||
| Response | ||||||||||||
| Requested | String | GetCurrentReturnOverIpServerID | - | - | - | - | - | - | - | √ | √ | - |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | √ | √ | - |
| Data | ||||||||||||
| ID | Integer | 0:server1, 1: server2, 2: server3, 3: server4 | - | - | - | - | - | - | - | √ | √ | - |
Example
| "Response": [ |
| "Requested": "GetCurrentReturnOverIoServerID", |
| "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 Size Value | ||||||||||||
| Request | ||||||||||||
| Command | Siting | SetCurrentReturnOverlpServerID | - | - | - | - | - | - | - | √ | √ | - |
| SessionID | Siting | (Session ID in cookie.) | - | - | - | - | - | - | - | √ | √ | - |
| Params | ||||||||||||
| ID | integer | 0:server1, 1: server2, 2: server3, 3: server4 | - | - | - | - | - | - | - | √ | √ | - |
Example
| { |
| "Command": "SetCurrentReturnOvertoServerID", |
| "SessionID": "7425f0cb58ee4d15dd4c1f5ace4299a3", |
| "Params": { |
| "ID": 0 |
| } |
| } |
| Response Key Style | Value | H-0.05 | H-0.06 | H-0.20 | H-0.25 | H-0.28 | L-3.00 | L-7.10 | H-0.30 | H-0.50 | L-4.00 | L-2.00 | P-2.50 | |
| Response | ||||||||||||||
| Requested | Siting | SetCurrentReturnOverlpServerID | — | — | — | — | — | — | — | — | √ | √ | — | — |
| Result | Siting | (Result of command processing.) | — | — | — | — | — | — | — | — | √ | √ | — | — |
Example
| { |
| "Response": { |
| "Requested": "SetCurrentReturnOveripServerID", |
| "Result": "Success" |
| } |
3.8.3. GetReturnOverlpServerSettings
Get Return over IP settings for each server ID.
Request Key Style
Value
| Request | ||||||||||||||
| Command | Siring | GetReturnOverlpServerSettings | - | - | - | - | - | - | - | - | √ | √ | - | - |
| SessionID | Siring | (Session ID in cookie.) | - | - | - | - | - | - | - | - | √ | √ | - | - |
| Params | ||||||||||||||
| ID | Integer | 0:server1, 1: server2, 2: server3, 3: server4 | - | - | - | - | - | - | - | - | √ | √ | - | - |
Example
"Request": {
"Command": "GetReturnOveripServerSettings",
"SessionID": "7425fcbc58ee4d15cd4c1f5ace4299a3",
"Params": {
"ID": 1
}
}
Response Key Style
Value
| Response | |||||||||||||||
| Requested | String | GetReturnOverlpServerSettings | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | |
| Data | |||||||||||||||
| Alias | String | (Another name of server) | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | |
| Type | String | "RTSP/RTP" / "Icecast" / "SRT" | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | |
| RTSP/RTP (Selected by Type) | |||||||||||||||
| Protocol | String | "UDP"/"TCP" | - | - | - | - | - | - | + | - | - | ✓ | ✓ | - | |
| SrcAddress | String | (IP address) | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | |
| SrcPort | Integer | (Port number) | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | |
| StreamId | String | (Stream ID) | - | - | - | - | - | - | + | - | - | ✓ | ✓ | - | |
| Username | String | (User name) | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | |
| Password | String | (Password for RTSP/RTP) | - | - | - | - | - | - | + | - | - | ✓ | ✓ | - | |
| Resolution | integer | 0:1280x720 | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | |
| FrameRate | integer | 1:60p, 2:30p, 4:50p, 5:25p | - | - | - | - | - | - | + | - | - | ✓ | ✓ | - | |
| Zixi (Selected by Type) | |||||||||||||||
| SrcAddress | string | (IP address) | - | - | - | - | - | - | + | - | - | ✓ | ✓ | - | |
| SrcPort | integer | (Port number) | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | |
| StreamId | string | (Stream ID for ZIXI) | - | - | - | - | - | - | + | - | - | ✓ | ✓ | - | |
| Password | string | (Password for ZIXI) | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | |
| Name | string | (Name for ZIXI) | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | |
| Latency | integer | 0:Off, 1:Low, 2: Medium | - | - | - | - | - | - | + | - | - | ✓ | ✓ | - | |
| Resolution | integer | 0:1280x720 | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | |
| FrameRate | integer | 1:60p, 2:30p, 4:50p, 5:25p. | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | |
| Icecast (Selected by Type) | |||||||||||||||
| SrcAddress | String | (IP address) | - | - | - | - | - | - | + | - | - | ✓ | ✓ | - | |
| SrcPort | Integer | (Port number) | - | - | - | - | - | - | - | - | - | ✓ | ✓ | - | |
| Mountpoint | String | (Mountpoint) | - | - | - | - | - | - | + | - | - | ✓ | ✓ | - | |
| SRT | (Selected by Type) | ||||||||||||||
| SrcAddress | string | (IP address) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | |||||||||||||
| Port | integer | (Port number) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | |||||||||||||
| ConnectionMode | integer | 0: Caller 1: Listener, 2: Hendezvous | - | - | - | - | - | - | + | - | - | ✓ | ✓ | - | |
| Latency | integer | 20 - 8000 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | |||||||||||||
| Encryption | integer | 0: Off, 1: ON - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - | |||||||||||||
| Passphrase | string | [Passphrase for SHT] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – –– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – — – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – - – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – —– – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – – — | – | – | – | – | – | – | – | – | – | – | – | – | |
Example
{
'Response':
'Requested": "GetReturnOveripServerSettings",
'Result": "Success",
'Data':
"Alias": "Server1",
"Type": "RTSP",
"Rtsp": {
"Protocol": "UDP",
"SrcAddress": "192.168.0.1",
"SrcPort": 6504
"Streamio": "HC900-1234",
"Username": "Jvckenwood",
"Password": "aoodegnyi"
}
}
}
3.8.3.1. AvailableTypeOfReturnOverIP
Get Available type.
| Request Key Style Value | H4650 | H4660 | H46a0 | H4630 | H4620 | H4620 | H5310 | PZ100 | H2000 | H2500 | PZ400 | PZ200 | PZ510 | ||
| Request | |||||||||||||||
| Command | String | AvailableTypeOfReturnOverIP | - | - | - | - | - | - | - | - | √ | / | - | - | - |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | √ | / | - | - | - |
| Response Key Style | Value | HH650 | HH660 | HH660 | HH200 | HH250 | HH290 | LS300 | V7/001 | HD200 | HD250 | V7401 | V72001 | PZ510 | ||
| Response | ||||||||||||||||
| Requested | String | AvailableTypeOfReturnOverIP | - | - | - | - | - | - | - | - | √ | √ | - | - | - | |
| Result | String | [Result of command processing,] | - | - | - | - | - | - | - | - | √ | √ | - | - | - | |
| Data | ||||||||||||||||
| AvailableType | - | - | - | - | - | - | - | - | √ | √ | - | - | - | |||
| RTSP/RTP | Integer | 0 : unselectable , 1 : selectable | - | - | - | - | - | - | - | - | √ | √ | - | - | - | |
| Icecast | Integer | 0 : unselectable , 1 : selectable | - | - | - | - | - | - | - | - | √ | √ | - | - | - | |
| Zixi | Integer | 0 : unselectable , 1 : selectable | - | - | - | - | - | - | - | - | √ | √ | - | - | - | |
| SRT | Integer | 0 : unselectable , 1 : selectable | - | - | - | - | - | - | - | - | √ | √ | - | - | - | |
Example
{
"Response": {
"Requested": "AvailableTypeOfReturnOverP"
"Result": "Success",
"Data": {
"AvailableType": {
"RTSP/RTP": 1,
"Icecast": 1,
"Zxi": 0
}
}
}
3.8.3.2. AvailableFrameRateOfReturnOverIP
Get available frame rate.
Request Key Style
Value
| Request | |||||||||||||||
| Command | Siring | AvailableFrameRateOfReturnOverIP | - | - | - | - | - | - | - | - | √ | √ | - | - | |
| SessionID | Siring | (Session ID in cookie.) | - | - | - | - | - | - | - | - | √ | √ | - | - | |
| Params | |||||||||||||||
| RecordingFrameRate | Siring | "60p" / "50p" / "60i" / "50i" / "30p" / "25p" | - | - | - | - | - | - | - | - | √ | √ | - | - | |
Example
| "Request":{ |
| "Command": "AvailableFrameRateOffsetReturnOverIP", |
| "SessionID": "7425f0cb68ee4d15dd4c1f5ace4299e3", |
| "Params":{ |
| "RecordingFrameRate": "60p" |
| } |
Response Key Style
Value
| Response | |||||||||||||||
| Requested | Siting | AvailableFrameRateOfReturnOverIP | - | - | - | - | - | - | - | - | √ | √ | - | - | |
| Result | Siting | (Result of command processing.) | - | - | - | - | - | - | - | - | √ | √ | - | - | |
| Data | |||||||||||||||
| RecordingFrameRate | Siting | "60p" / "50p" / "60i" / "50i" / "30p" / "25p" | - | - | - | - | - | - | - | - | √ | √ | - | - | |
| AvailableFrameRate | - | - | - | - | - | - | - | - | √ | √ | - | - | |||
| "60p" | Integer | 0 : unselectable, 1 : selectable | - | - | - | - | - | - | - | - | √ | √ | - | - | |
| "30p" | Integer | 0 : unselectable, 1 : selectable | - | - | - | - | - | - | - | - | √ | √ | - | - | |
| "50p" | Integer | 0 : unselectable, 1 : selectable | - | - | - | - | - | - | - | - | √ | √ | - | - | |
| "25p" | Integer | 0 : unselectable, 1 : selectable | - | - | - | - | - | - | - | - | √ | √ | - | - | |
Example
| "Response": { |
| "Requested": "AvailableFrameRateOfReturnOverN", |
| "Result": "Success", |
| "Data": { |
| "RecordingFrameRate": "60p" |
| "AvailableFrameRate": { |
| "60p": 1, |
| "30p": 1, |
| "50p": 0, |
| "25p": 0 |
| } |
| } |
3.8.4. SetReturnOverlpServerSettingsRTSP
Set Return over IP settings for each server ID. This command is used for RTSP/RTP protocol
| Request Key Size Value | ||
| Command | String | SetReturnOverIpServerSettingsRTSP |
| SessionID | String | (Session ID in cookie.) |
| Params | ||
| ID | Integer | 0:server1, 1: server2, 2: server3, 3: server4 |
| Alias | String | (Another name of server) |
| Protocol | String | "UDP"/"TCP" |
| SrcAddress | String | (IP address) |
| SrcPort | Integer | (Port number) |
| StreamId | String | (Stream ID) |
| Username | String | (User name) |
| Password | String | (Password for RTSP/RTP) |
| FrameRate | Integer | 1.60p, 2.30p, 4.50p, 5.25p |
Example
{
"Request": {
"Command": "SetReturnOverpServerSettingsRTSP",
"SessionID": "74250cb58ee4d150d4c1f5ace4299e3",
"Params": {
"ID": 1,
"Alias": "Server1",
"Protocol": "UDP",
"SrcAddress": "192.168.0.1",
"SrcPort": 6504
"Streamid": "HC900-1234",
"Username": "Jockenwood",
"Password": "abcde",
"FrameRate": 1
}
}
Response Key Style
Value
| Response | ||||||||||||
| Requested | String | SetReturnOverlpServerSettingsRTSP | ||||||||||
| Result | String | (Result of command processing.) | ||||||||||
Example
| "Response": { "Requested": "SetReturnOveripServerSettingsATSP". "Result": "Success"} |
3.8.5. SetReturnOverIpServerSettingsZIXI
Set Return over IP settings for each server ID.
This command is used for Zixi protocol.
| Request Key Size Value | |||||||||||||
| Command | String | SetReturnOverIpServerSettingsZIXI | - | - | - | - | - | - | - | - | √ | √ | - |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | √ | √ | - |
| Params | |||||||||||||
| ID | Integer | 0:server1, 1: server2, 2: server3, 3: server4 | - | - | - | - | - | - | - | - | √ | √ | - |
| Alias | String | (Another name of server) | - | - | - | - | - | - | - | - | √ | √ | - |
| SrcAddress | String | (IP address) | - | - | - | - | - | - | - | - | √ | √ | - |
| SrcPort | Integer | (Port number) | - | - | - | - | - | - | - | - | √ | √ | - |
| StreamId | String | (Stream ID for ZIXI) | - | - | - | - | - | - | - | - | √ | √ | - |
| Password | String | (Password for ZIXI) | - | - | - | - | - | - | - | - | √ | √ | - |
| Name | String | (Name for ZIXI) | - | - | - | - | - | - | - | - | √ | √ | - |
| Latency | Integer | 0:Low, 1:Medium, 2:Minimum(Zxi OFF), 3:High | - | - | - | - | - | - | - | - | √ | √ | - |
| FrameRate | Integer | 1:60p, 2:30p, 4:50p, 5:25p | - | - | - | - | - | - | - | - | √ | √ | - |
Example
{
"Request": {
"Command": "SetReturnOverIpServerSettingsZIXI",
"SessionID": "7425lcbc8see4d15dd4c15face4299a3",
"Params": {
"ID": 1.
"Alias": "Server1",
"SrcAddress": "182.168.0.1",
"SrcPort": 2088,
"StreamId": "VM650-1234",
"Password": "abcde",
"Name": "Uckenwood",
"Latency": 0.
"FrameRate": 1
}
}
}
Response Key Style
Value
| Response | ||||||||||||
| Requested | String | SetReturnOverIpServerSettingsZIXI | - | - | - | - | - | - | - | √ | √ | - |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | √ | √ | - |
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 Syc | Value | IN8550 | IN860 | IN862 | IN825s | IN8280 | IN8300 | IN8320 | IN8340 | IN8360 | IN8390 | ||
| - | - | - | - | - | - | - | √ | √ | - | ||||
| Command | Sling | SetReturnOverlpServerSettingsIcecast | - | - | - | - | - | - | - | √ | √ | - | |
| SessionID | Sling | (Session ID in cookie.) | - | - | - | - | - | - | - | √ | √ | - | |
| Params | |||||||||||||
| ID | Integer | 0:server1, 1: server2, 2: server3, 3: server4 | - | - | - | - | - | - | - | √ | √ | - | |
| Alias | String | {Another name of server} | - | - | - | - | - | - | - | √ | √ | - | |
| SrcAddress | Sling | (IP address) | - | - | - | - | - | - | - | √ | √ | - | |
| SrcPort | Integer | (Port number) | - | - | - | - | - | - | - | √ | √ | - | |
| Mountpoint | Sling | (Mountpoint) | - | - | - | - | - | - | - | √ | √ | - | |
Example
| "Request":{ |
| "Command": "SetReturnOverIpServerSettingsfcocast", |
| "SessionID": "7425fcbc8see4d15dd4c1f5ace4299a3", |
| "Params":{ |
| "ID": 1, |
| "Alias": "Server1", |
| "SrcAddress": "192.168.0.1", |
| "SrcPort": 6504, |
| "Mountpoint": "abcdeig" |
| } |
| } |
| Response Key Style | Value | |||||||||||||
| Response | ||||||||||||||
| Requested | String | SetReturnOverIpServerSettingslococast | - | - | - | - | - | - | - | - | √ | - | - | |
| Result | Siting | [Result of command processing.] | - | - | - | - | - | - | - | - | √ | - | - | |
Example
| "Response": {"Requested": "SetReturn/OverlapServerSettingsforecast", "Result": "Success"} |
3.8.7. SetReturnOverIpCtrl
This command is used to start/stop Return over IP.
| Request Key Style | Value | H4650 | H4660 | H46a0 | H4620 | H4625x | H4630 | H4630 | PZ100 | H4600 | H4500 | PZ400 | PZ200 | PZ510 | ||
| Request | ||||||||||||||||
| Command | Siting | SetReturnOverlpCtrl | - | - | - | - | - | - | - | - | √ | / | - | - | - | |
| SessionID | Siting | (Session ID in cookie.) | - | - | - | - | - | - | - | - | √ | / | - | - | - | |
| Params | ||||||||||||||||
| Operate | Siting | Streaming Control"Start": start Return over IP / "Stop": stop Return over IP | - | - | - | - | - | - | - | - | √ | / | - | - | - | |
| Response Key Style Value | H4650 | H4660 | H4660 | H4620 | H4620 | H4630 | L5320 | P7100 | HC900 | HC900 | P7400 | P7400 | P7200 | P25-0 | ||
| Response | ||||||||||||||||
| Requested | Siting | SetReturnOverlpCtrl | - | - | - | - | - | - | - | - | - | √ | √ | - | - | |
| Result | Siting | {Result of command processing.} | - | - | - | - | - | - | - | - | - | √ | √ | - | - | - |
3.8.8. SetReturnOverIpServerSettingsSRT
Set Return over IP settings for each server ID.
This command is used for SRT protocol.
| Request Key Size Value | |||||||||||||
| Command | String | SetReturnOverIpServerSettingsSRT | - | - | - | - | - | - | - | - | √ | √ | - |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | √ | √ | - |
| Params | |||||||||||||
| ID | Integer | 0:server1, 1: server2, 2: server3, 3: server4 | - | - | - | - | - | - | - | - | √ | √ | - |
| Alias | String | (Another name of server) | - | - | - | - | - | - | - | - | √ | √ | - |
| SrcAddress | String | (IP address) | - | - | - | - | - | - | - | - | √ | √ | - |
| Port | Integer | (Port number) | - | - | - | - | - | - | - | - | √ | √ | - |
| ConnectionMode | Integer | 0: Caller 1: Listener, 2: Rendezvous | - | - | - | - | - | - | - | - | √ | √ | - |
| Latency | Integer | 20 - 8000 | - | - | - | - | - | - | - | - | √ | √ | - |
| Encryption | Integer | 0: OFF, 1: ON | - | - | - | - | - | - | - | - | √ | √ | - |
| Passphrase | String | (Passphrase for SRT) | - | - | - | - | - | - | - | - | √ | √ | - |
| FrameRate | Integer | 1.60p, 2.30p, 4.50p, 5.25p | - | - | - | - | - | - | - | - | √ | √ | - |
Example
{
"Request": {
"Command": "SetReturnOverIoServerSettingsSRT",
"SessionID": "7425fccb58ee-Ad15dd4c1f5acc4299a3",
"Params": {
"ID": 1,
"Alias": "Server1",
"SrcAddress": "162.168.0.1",
"Port": 2088,
"ConnectionMode": 0,
"Latency": 20,
"Encryption": 0,
"Passphrase": "aboveghyklmn"
"FrameRate": 1,
}
}
}
Response Key Style
Value
| Response | ||||||||||||
| Requested | String | SetReturnOverlpServerSettingsSRT | ||||||||||
| Result | String | (Result of command processing.) | ||||||||||
Example
| "Response": { "Requested": "SetReturnOveripServerSettingsSRT". "Result": "Success"} |
3.9 Auto Tracking Command
3.9.1. Set Auto Tracking On/Off
Sets auto tracking on/off.
You can get the current settings with "GetCamStatus" or "GetCamStatusMinimum".
| Request Key Style Value | HM650 | HM660 | HM6w0 | HM200 | HM25x | HM290 | LS300 | FZ 00 | HC900 | HC5w0 | F14w0 | FZZ00 | FZ510 | |||
| Request | ||||||||||||||||
| Command | String | SetTracking | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | |
| SessionID | String | {Session ID in cookie.} | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | |
| Params | ||||||||||||||||
| |Tracking | String | "On" / "Off" | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | |
3.9.2. Set Auto Tracking Mode
Sets auto tracking mode.
You can get the current settings with "GetCamStatus" or "GetCamStatusMinimum".
Request Key Style
Value
| Request | ||||||||||||
| Command | String | SetTrackingMode | - | - | - | - | - | - | - | - | - | ✓ |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | ✓ |
| Params | ||||||||||||
| TrackingMode | String | "Standard" / "Area" / "Stage" / "WideArea" / "FineAdjustment" | - | - | - | - | - | - | - | - | - | ✓ |
Example
| { |
| "Request": { |
| "Command": "SetTrackingMode", |
| "SessionID": "7425fbb68ee4d150d4c1f5ace4299a3", |
| "Params": { |
| "TrackingMode": "Standard" |
| } |
| } |
Response Key Style
Value
| Response | |||||||||||||
| Requested | String | SetTrackingMode | - | - | - | - | - | + | - | - | - | - | - |
| Result | String | (Result of command processing.) | - | - | - | - | - | + | - | - | - | - | - |
Example
| { |
| "Response": { |
| "Requested": "SetTrackingMode", |
| "Result": "Success" |
| } |
| } |
3.9.3. Set Auto Tracking Bounding Box
Sets auto tracking bounding box.
You can get the current settings with "GetCamStatus" or "GetCamStatusMinimum".
Request Key Style
Value
| Request | |||||||||||||
| Command | String | SetTrackingBoundingBox | — | — | — | — | — | — | — | — | — | — | √ |
| SessionID | String | (Session ID in cookie.) | — | — | — | — | — | — | — | — | — | — | √ |
| Params | |||||||||||||
| |TrackingBoundingBox | String | "Auto" / "Off" / "On" | — | — | — | — | — | — | — | — | — | — | √ |
Example
| { |
| "Request": { |
| "Command": "SetTrackingBoundingBox", |
| "SessionID": "7425fbcb58ee4d15dd4c1f5ace4299a3", |
| "Params": { |
| "TrackingBoundingBox": "Auto" |
| } |
| } |
Response Key Style
Value
| Response | |||||||||||||
| Requested | String | SetTrackingBoundingBox | - | - | - | - | - | - | - | - | - | - | - |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - |
Example
| { |
| "Response": { |
| "Requested": "SetTrackingBoundingBox". |
| "Result": "Success" |
| } |
| } |
3.9.4. Get Auto Tracking Settings of Standard Mode
Request all auto tracking settings of Standard mode.
| Request Key Style | Value | H0850 | H0860 | H0860 | H0220 | H0255 | H0280 | L5300 | Z7100 | HC900 | HC960 | P4700 | P2200 | P5700 | |
| Request | |||||||||||||||
| Command | String | GetTrackingStandard | - | - | - | - | - | - | - | - | - | - | - | - | - |
| SessionID | String | {Session ID in cookie.} | - | - | - | - | - | - | - | - | - | - | - | - | - |
Example
| "Request": { |
| "Command": "GetTrackingStandard", |
| "SessionID": "7425fbcb58ee4d15dd4c1f5ace4299a3" |
| } |
| Response Key Style Value | ||||||||||||||
| Requested | String | GetTrackingStandard | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Result | String | {Result of command processing.} | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Data | ||||||||||||||
| AutoZoom | String | "On" / "Off" | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| AutoTilt | String | "On" / "Off" | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| TargetRetentionTime | Integer | 5.8, 10, 12, 15 | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| FigureSize | String | "Full" / "Upper" / "Close" / "Custom" | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| FigureSizeCustom | Integer | 80-290 (This parameter is valid only when 'FigureSize' is 'Custom'.) | - | - | - | - | - | - | + | - | - | - | - | ✓ |
| VerticalPosition | Integer | -5 - 5 | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| HorizontalPosition | String | "Left" / "Center" / "Right" | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| StartPosition | String | "CurrentPosition" / "HomePosition" / "Preset1" | - | - | - | - | - | - | - | - | - | - | - | ✓ |
Example Example ('FigureSize' is 'Custom')
| { |
| "Response": { "Response": { |
| "Required": "GetTrackingStandard", |
| "Result": "Success", "Result": "Success", |
| "Data": { "Data": { |
| "AutoZoom": "On", "AutoZoom": "On", |
| "AutoTill": "On", "AutoTill": "On", |
| "TargetRetentionTime": 10, |
| "FigureSize": "Full", |
| "VerticalPosition": 0, "FigureSizeCustom": 80, |
| "HorizontalPosition": "Center", "VerticalPosition": 0, |
| "StartPosition": "CurrentPosition" |
| } |
| } |
"Requested": "GoITrackingStandard",
"TargetRetentionTime": 10,
"FigureSize": "Custom",
"HorizontalPosition": "Center",
"StartPosition": "CurrentPosition" }
3.9.5. Set Auto Zoom of Standard Mode of Auto Tracking
Set auto zoom of Standard mode of auto tracking.
| Request Key Style Value | ||||||||||||||
| Request | ||||||||||||||
| Command | String | SetTrackingStandardAutoZoom | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Params | ||||||||||||||
| AutoZoom | String | "On" / "Off" | - | - | - | - | - | - | - | - | - | - | - | ✓ |
3.9.6. Set Auto Tilt of Standard Mode of Auto Tracking
Set auto tilt of Standard mode of auto tracking.
| Request Key Style Value | ||||||||||||||
| Request | ||||||||||||||
| Command | String | SetTrackingStandardAutoTilt | - | - | - | - | - | - | - | - | - | - | - | |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | |
| Params | ||||||||||||||
| AutoTilt | String | "On" / "Off" | - | - | - | - | - | - | - | - | - | - | - | |
3.9.7. Set Target Retention Time of Standard Mode of Auto Tracking
Set target retention time of Standard mode of auto tracking.
| Request Key Style Value | HM650 | HM650 | HM640 | HM630 | HM620 | HM610 | HM600 | HM590 | HM580 | HM570 | HM560 | ||
| Request | |||||||||||||
| Command | String | SetTrackingStandardTargetRetentionTime | - | - | - | - | - | - | - | - | - | - | - |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - |
| Params | |||||||||||||
| TargetRetentionTime | Integer | 5, 8, 10, 12, 15 | - | - | - | - | - | - | - | - | - | - | - |
| Example | |||||||||||||
| "Request": {"Command": "SetTrackingStandardTargetRetentionTime", "SessionID": "7425fcbc68ee4d15cd4c15acc4299a3", "Params": {"TargetRetentionTime": 10}} | |||||||||||||
| Response Key Style Value | HM650 | HM650 | HM640 | HM630 | HM620 | HM610 | HM600 | HM590 | HM580 | HM570 | HM560 | ||
| Response | |||||||||||||
| Requested | String | SetTrackingStandardTargetRetentionTime | - | - | - | - | - | - | - | - | - | - | - |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - |
| Example | |||||||||||||
| "Response": {"Requested": "SetTrackingStandardTargetRetentionTime", "Result": "Success"}} | |||||||||||||
3.9.8. Set Figrue Size of Standard Mode of Auto Tracking
Set figure size of Standard mode of auto tracking.
Example Example ('FigureSize' is 'Custom')
| {"Request": {"Request": {"Command": "SetTrackingStandardFigureSize","SessionID": "7425fbcb58ee4d15004c15acc4299a3","Params": {"Params": {"FigureSize": "Full"} "FigureSizeCustom": 80}} } | {"Command": "SetTrackingStandardFigureSize","SessionID": "7425fbcb58ee4d15004c15acc4299a3","FigureSize": "Custom".} |
| Response Key Style | Value | ||||||||||||||
| Response | |||||||||||||||
| Requested | String | SetTrackingStandardFigureSize | |||||||||||||
| Result | String | (Result of command processing.) | |||||||||||||
Example
| "Response": {"Requested":"SetTrackingStandardFigureSize","Result":"Success"} |
3.9.9. Set Vertical Position of Standard Mode of Auto Tracking
Set vertical position of Standard mode of auto tracking.
| Request Key Style Value | HM650 | HM650 | HM640 | HM620 | HM625x | HM630 | LS300 | PZ100 | HC300 | HC390 | PZ400 | PZZ200 | PZ510 | ||
| Request | |||||||||||||||
| Command | String | SetTrackingStandardVerticalPosition | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Params | |||||||||||||||
| VerticalPosition | Integer | -5 - 5 | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example | |||||||||||||||
| "Request": {"Command": "SetTrackingStandardVerticalPosition","SessionID": "7425fcbc68ee4d15cd4c15acc4299a3","Params": "/VerticalPosition": 0;};} | |||||||||||||||
| Response Key Style Value | HM650 | HM650 | HM640 | HM620 | HM625x | HM630 | LS300 | PZ100 | HC300 | HC390 | PZ400 | PZZ200 | PZ510 | ||
| Response | |||||||||||||||
| Requested | String | SetTrackingStandardVerticalPosition | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example | |||||||||||||||
| "Response": {"Requested": "SetTrackingStandardVerticalPosition","Result": "Success"}} | |||||||||||||||
3.9.10. Set Horizontal Position of Standard Mode of Auto Tracking
Set horizontal position of Standard mode of auto tracking.
| Request Key Style Value | HM650 | HM650 | HM640 | HM630 | HM620 | HM610 | HM600 | HM590 | HM580 | HM570 | HM560 | ||
| Request | |||||||||||||
| Command | String | SetTrackingStandardHorizontalPosition | - | - | - | - | - | - | - | - | - | - | - |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - |
| Params | |||||||||||||
| HorizontalPosition | String | "Left" / "Center" / "Right" | - | - | - | - | - | - | - | - | - | - | - |
| Example | |||||||||||||
| "Request": { "Command": "SetTrackingStandardHorizontalPosition", "SessionID": "7425fcbc58cc4d15cd4c15acc4289a3", "Params": { "HorizontalPosition": "Center" } } } | |||||||||||||
| Response Key Style Value | HM650 | HM650 | HM640 | HM630 | HM620 | HM610 | HM600 | HM590 | HM580 | HM570 | HM560 | ||
| Response | |||||||||||||
| Requested | String | SetTrackingStandardHorizontalPosition | - | - | - | - | - | - | - | - | - | - | - |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - |
| Example | |||||||||||||
| "Response": { "Requested": "SetTrackingStandardHorizontalPosition", "Result": "Success" } } | |||||||||||||
3.9.11. Set Tracking Start Position of Standard Mode of Auto Tracking
Set tracking start position of Standard mode of auto tracking.
| Request Key Style Value | ||||||||||||||
| Request | ||||||||||||||
| Command | String | SetTrackingStandardStartPosition | ||||||||||||
| SessionID | String | (Session ID in cookie.) | ||||||||||||
| Params | ||||||||||||||
| StartPosition | String | "CurrentPosition" / "HomePosition" / "Preset1" | ||||||||||||
3.9.12 Get Auto Tracking Settings of Area Mode
Request all auto tracking settings of area mode.
| Request Key Style | Value | H4650 | H4650 | H4660 | H4660 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H 4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H465 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Request | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Command | String | GetTrackingArea | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | √ | √ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | V | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example
| { |
| "Request": { |
| "Command": "GetTrackingArea", |
| "SessionID": "7425fbb58ee4d15dd4c1f5ace4299a3" |
| } |
| Response Key Style | Value | A16 | A17 | A18 | A19 | A20 | A21 | A22 | A23 | A24 | A25 | |
| Response | - | - | - | - | - | - | - | - | - | - | ||
| Requested | String | GetTrackingArea | - | - | - | - | - | - | - | - | - | - |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - |
| Data | ||||||||||||
| TargetRetentionTime | Integer | 5, 8, 10, 12, 15 | ||||||||||
| StartingArea | String | "A1" / "A2" / "A3" / "A4" | - | - | - | - | - | - | - | - | - | - |
Example
| { |
| "Response": { |
| "Requested": "GetTrackingArea", |
| "Result": "Success". |
| "Data": { |
| "TargetRetentionTime": 10, |
| "StartingArea": "A1" |
| } |
| } |
3.9.13 Execute Set/Delete Starting Area of Area Mode of Auto Tracking
Execute set/delete starting area of area mode of auto tracking.
| Request Key Style Value | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H47510 | |||
| Command | String | ExecuteTrackingStartingArea | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | √ | |
| SessionID | String | {Session ID in cookie.} | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | √ | |
| Params | |||||||||||||||||||||
| Command | String | "Set" / "Delete" | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | √ | |
| Area | String | "A1" / "A2" / "A3" / "A4" | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | √ | |
| Response Key Style Value | ||
| Response | ||
| Requested | String | ExecuteTrackingStartingArea |
| Result | String | [Result of command processing.] |
3.9.14. Set Target Retention Time of Area Mode of Auto Tracking
Set target retention time of area mode of auto tracking.
| Request Key Style Value | HM650 | HM650 | HM640 | HM630 | HM620 | HM610 | HM600 | HM590 | HM580 | HM570 | HM560 | ||
| Request | |||||||||||||
| Command | String | SetTrackingAreaTargetRetentionTime | - | - | - | - | - | - | - | - | - | - | - |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - |
| Params | |||||||||||||
| TargetRetentionTime | Integer | 5, 8, 10, 12, 15 | - | - | - | - | - | - | - | - | - | - | - |
| Example | |||||||||||||
| "Request": { "Command": "SetTrackingAreaTargetRetentionTime", "SessionID": "7425fcbc68ee4d15cd4c15acc4299a3", "Params": { "TargetRetentionTime": 10 } } } | |||||||||||||
| Response Key Style Value | HM650 | HM650 | HM640 | HM630 | HM620 | HM610 | HM600 | HM590 | HM580 | HM570 | HM560 | ||
| Response | |||||||||||||
| Requested | String | SetTrackingAreaTargetRetentionTime | - | - | - | - | - | - | - | - | - | - | - |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - |
| Example | |||||||||||||
| "Response": { "Requested": "SetTrackingAreaTargetRetentionTime", "Result": "Success" } } | |||||||||||||
3.9.15. Set Tracking Starting Area of Area Mode of Auto Tracking
Set tracking starting area of area mode of auto tracking.
| Request Key Style Value | HM650 | HM650 | HM640 | HM620 | HM625x | HM630 | LS300 | PZ100 | HC300 | HC390 | PZ400 | PZZ200 | PZ510 | ||
| Request | |||||||||||||||
| Command | String | SetTrackingAreaStartingArea | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Params | |||||||||||||||
| StartingArea | String | "A1" / "A2" / "A3" / "A4" | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example | |||||||||||||||
| "Request": { "Command": "SetTrackingAreaStartingArea", "SessionID": "7425fcbc58ee4d15dd4c15acc4299a3", "Params": { "StartingArea": "A1" } } } | |||||||||||||||
| Response Key Style Value | HM650 | HM650 | HM640 | HM620 | HM625x | HM630 | LS300 | PZ100 | HC300 | HC390 | PZ400 | PZZ200 | PZ510 | ||
| Response | |||||||||||||||
| Requested | String | SetTrackingAreaStartingArea | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example | |||||||||||||||
| "Response": { "Requested": "SetTrackingAreaStartingArea", "Result": "Success" } } } | |||||||||||||||
3.9.16 Get Auto Tracking Settings of Stage Mode
Request all auto tracking settings of stage mode.
| Request Key Style | Value | H4650 | H4650 | H4660 | H4660 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H 4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H465 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Request | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Command | String | GetTrackingStage | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | √ | √ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | V | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example
| { |
| "Request": { |
| "Command": "GetTrackingStage", |
| "SessionID": "7425fbb68ee4d15dd4c1f5ace4209a3" |
| } |
| Response Key Style | Value | HH6 | HH6 | HH6 | HH6 | HH6 | HH6 | HH6 | HH6 | HH6 | HH6 | HH6 | HH6 | HH6 | HH6 | |
| Requested | String | GetTrackingStage | - | - | - | - | - | - | - | - | - | - | - | - | - | |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - | - | - | |
| Data | ||||||||||||||||
| TargetRetentionTime | Integer | 5, 8, 10, 12, 15 | ||||||||||||||
| HorizontalPosition | String | "Left" / "Center" / "Right" | - | - | - | - | - | - | - | - | - | - | - | - | - | |
Example
| { |
| "Response": { |
| "Requested": "GetTrackingStage", |
| "Result": "Success". |
| "Data": { |
| "TargetRetentionTime": 10, |
| "HorizontalPosition": "Center" |
| } |
| } |
3.9.17 Execute Set/Delete Position of Stage Mode of Auto Tracking
Execute set/delete position of stage mode of auto tracking.
| Request Key Style Value | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H47510 | |||
| Request | |||||||||||||||||||||
| Command | String | ExecuteTrackingStagePosition | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | |
| SessionID | String | {Session ID in cookie.} | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | |
| Params | |||||||||||||||||||||
| Command | String | "Set" / "Delete" | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | |
| Position | String | "Left" / "Right" / "Start" | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | |
| Response | Value | HM650 | HM600 | HM600 | HM625 | HM625 | LS200 | PZ100 | HC900 | HC500 | PZ400 | TZ200 | PZ510 | |
| Requested | String | ExecuteTrackingStagePosition | - | - | - | - | - | - | - | - | - | - | - | - |
| Result | String | [Result of command processing.] | - | - | - | - | - | - | - | - | - | - | - | - |
3.9.18. Set Target Retention Time of Stage Mode of Auto Tracking
Set target retention time of stage mode of auto tracking.
| Request Key Style Value | HM650 | HM650 | HM640 | HM620 | HM625x | HM630 | LS300 | PZ100 | HC300 | HC390 | PZ400 | PZZ200 | PZ510 | ||
| Request | |||||||||||||||
| Command | String | SetTrackingStageTargetRetentionTime | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Params | |||||||||||||||
| TargetRetentionTime | Integer | 5, 8, 10, 12, 15 | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example | |||||||||||||||
| "Request": { "Command": "SetTrackingStageTargetRetentionTime", "SessionID": "7425fcbc68ee4d15cd4c15acc4299a3", "Params": { "TargetRetentionTime": 10 } } } | |||||||||||||||
| Response Key Style Value | HM650 | HM650 | HM640 | HM620 | HM625x | HM630 | LS300 | PZ100 | HC300 | HC390 | PZ400 | PZZ200 | PZ510 | ||
| Response | |||||||||||||||
| Requested | String | SetTrackingStageTargetRetentionTime | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example | |||||||||||||||
| "Response": { "Requested": "SetTrackingStageTargetRetentionTime", "Result": "Success" } } | |||||||||||||||
3.9.19. Set Horizontal Position of Stage Mode of Auto Tracking
Set horizontal position of stage mode of auto tracking.
| Request Key Style Value | |||||||||||||||
| Request | |||||||||||||||
| Command | String | SetTrackingStageHorizontalPosition | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Params | |||||||||||||||
| HorizontalPosition | String | "Left" / "Center" / "Right" | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example | |||||||||||||||
| "Request": { "Command": "SetTrackingStageHorizontalPosition", "SessionID": "7425fcbc58cc4d15cd4c15acc4299a3", "Params": { "HorizontalPosition": "Center" } } } | |||||||||||||||
| Response Key Style Value | |||||||||||||||
| Response | |||||||||||||||
| Requested | String | SetTrackingStageHorizontalPosition | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example | |||||||||||||||
| "Response": { "Requested": "SetTrackingStageHorizontalPosition", "Result": "Success" } } } | |||||||||||||||
3.9.20 Get Auto Tracking Settings of Wide Area Mode
Request all auto tracking settings of wide area mode.
| Request Key Style | Value | H0850 | H0860 | H0860 | H0220 | H0255 | H0280 | L5300 | Z7100 | HC900 | HC960 | P4700 | P2200 | P5700 | |
| Request | |||||||||||||||
| Command | String | GetTrackingWideArea | - | - | - | - | - | - | - | - | - | - | - | - | - |
| SessionID | String | {Session ID in cookie.} | - | - | - | - | - | - | - | - | - | - | - | - | - |
Example
| "Request": { |
| "Command": "GetTrackingWideArea", |
| "SessionID": "7425fbcb58ee4d15dd4c1f5ace4299a3" |
| } |
| Response Key Style Value | ||||||||||||||
| Requested | String | GetTrackingWideArea | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Result | String | {Result of command processing.} | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Data | ||||||||||||||
| AutoZoom | String | "On" / "Off" | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| AutoTilt | String | "On" / "Off" | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| TargetRetentionTime | Integer | 5.8, 10, 12, 15 | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| FigureSize | String | "Full" / "Upper" / "Close" / "Custom" | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| FigureSizeCustom | Integer | 80-290 (This parameter is valid only when 'FigureSize' is 'Custom'.) | - | - | - | - | - | - | + | - | - | - | - | ✓ |
| VerticalPosition | Integer | -5 - 5 | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| HorizontalPosition | String | "Left" / "Center" / "Right" | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| StartPosition | String | "CurrentPosition" / "HomePosition" / "W1" / "W2" / "Preset1" | - | - | - | - | - | - | - | - | - | - | - | ✓ |
Example Example ('FigureSize' is 'Custom')
| { |
| "Response": { "Response": { |
| "Requested": "GetTrackingWideArea", "Result": "Success", "Result": "Success", "Data": { "Data": { |
| "AutoZoom": "On", "AutoZoom": "On", "AutoTilt": "On", "AutoTilt": "On", "TargetRetentionTime": 10, "FigureSize": "Full", "VerticalPosition": 0, "FigureSizeCustom": 80, "HorizontalPosition": "Center", "VerticalPosition": 0, "StartPosition": "CurrentPosition" |
| } |
| } |
"Requested": "GoITrackingWideArea",
"TargetRetentionTime": 10,
"FigureSize": "Custom",
"HorizontalPosition": "Center",
"StartPosition": "CurrentPosition" }
3.9.21 Execute Set/Delete Position of Wide Area Mode of Auto Tracking
Execute set/delete position of wide area mode of auto tracking.
| Request Key Style Value | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H4650 | H47510 | |||
| Request | |||||||||||||||||||||
| Command | String | ExecuteTrackingWideAreaPosition | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | |
| SessionID | String | {Session ID in cookie.} | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | |
| Params | |||||||||||||||||||||
| Command | String | "Set" : "Delete" | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | |
| Position | String | "W1" : "W2" | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | |
| Response Key Style Value | ||
| Response | ||
| Requested | String | ExecuteTrackingWideAreaPosition |
| Result | String | [Result of command processing.] |
3.9.22. Set Auto Zoom of Wide Area Mode of Auto Tracking
Set auto zoom of wide area mode of auto tracking.
| Request Key Style Value | |||||||||||||||
| Request | |||||||||||||||
| Command | String | SetTrackingWideAreaAutoZoom | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Params | |||||||||||||||
| AutoZoom | String | "On" / "Off" | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
3.9.23. Set Auto Tilt of Wide Area Mode of Auto Tracking
Set auto tilt of wide area mode of auto tracking.
| Request Key Style Value | |||||||||||||||
| Request | |||||||||||||||
| Command | String | SetTrackingWideAreaAutoTilt | - | - | - | - | - | - | - | - | - | - | - | - | |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | - | |
| Params | |||||||||||||||
| AutoTilt | String | "On" / "Off" | - | - | - | - | - | - | - | - | - | - | - | - | |
3.9.24. Set Target Retention Time of Wide Area Mode of Auto Tracking
Set target retention time of wide area mode of auto tracking.
| Request Key Style Value | HM650 | HM650 | HM640 | HM630 | HM620 | HM610 | HM600 | HM590 | HM580 | HM570 | HM560 | ||
| Request | |||||||||||||
| Command | String | SetTrackingWideAreaTargetRetentionTime | - | - | - | - | - | - | - | - | - | - | - |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - |
| Params | |||||||||||||
| TargetRetentionTime | Integer | 5, 8, 10, 12, 15 | - | - | - | - | - | - | - | - | - | - | - |
3.9.25. Set Figrue Size of Wide Area Mode of Auto Tracking
Set figure size of wide area mode of auto tracking.
Request Key Style
Value
| Request | |||||||||||||
| Command | String | SetTrackingWideAreaFigureSize | - | - | - | - | - | - | - | - | - | - | - |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - |
| Params | |||||||||||||
| FigureSize | String | "Full" / "Upper" / "Close" / "Custom" | - | - | - | - | - | - | - | - | - | - | - |
| FigureSizeCustom | Integer | 80-290 (This parameter is valid only when 'FigureSize' is 'Custom'). | - | - | - | - | - | - | - | - | - | - | - |
Example Example ('FigureSize' is 'Custom')
| {"Request": {"Request": {"Command": "SetTrackingWideAreaFigureSize", "SessionID": "7425fcbc58ee4d15dd4c1f5ace4299a3", "Params": {"Params": {"FigureSize": "Full"} "FigureSizeCustom": 80}} }} | {"Command": "SetTrackingWideAreaFigureSize", "SessionID": "7425fcbc58ee4d15dd4c1f5ace4299a3", "FigureSize": "Custom",}} |
Response Key Style
Value
| Response | ||||||||||||||
| Requested | String | SetTrackingWideAreaFigureSize | - | - | - | - | - | - | - | - | - | - | - | √ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - | √ |
Example
| "Response": { "Requested": "SetTrackingWideAreaFigureSize", "Result": "Success"} |
3.9.26. Set Vertical Position of Wide Area Mode of Auto Tracking
Set vertical position of wide area mode of auto tracking.
| Request Key Style Value | HM650 | HM650 | HM640 | HM620 | HM625x | HM630 | LS300 | PZ100 | HC300 | HC390 | PZ400 | PZZ200 | PZ510 | ||
| Request | |||||||||||||||
| Command | String | SetTrackingWideAreaVerticalPosition | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Params | |||||||||||||||
| VerticalPosition | Integer | -5 - 5 | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example | |||||||||||||||
| "Request": {"Command": "SetTrackingWideAreaVerticalPosition", "SessionID": "7425f8cb68ee4d15cd4c15acc4299a3", "Params": "/VerticalPosition": 0 / } | |||||||||||||||
| Response Key Style Value | HM650 | HM650 | HM640 | HM620 | HM625x | HM630 | LS300 | PZ100 | HC300 | HC390 | PZ400 | PZZ200 | PZ510 | ||
| Response | |||||||||||||||
| Requested | String | SetTrackingWideAreaVerticalPosition | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example | |||||||||||||||
| "Response": {"Requested": "SetTrackingWideAreaVerticalPosition", "Result": "Success" / } | |||||||||||||||
3.9.27. Set Horizontal Position of Wide Area Mode of Auto Tracking
Set horizontal position of wide area mode of auto tracking.
| Request Key Style Value | HM650 | HM650 | HM640 | HM630 | HM620 | HM610 | HM600 | HM590 | HM580 | HM570 | HM560 | ||
| Request | |||||||||||||
| Command | String | SetTrackingWideAreaHorizontalPosition | - | - | - | - | - | - | - | - | - | - | - |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - |
| Params | |||||||||||||
| HorizontalPosition | String | "Left" / "Center" / "Right" | - | - | - | - | - | - | - | - | - | - | - |
| Example | |||||||||||||
| "Request": { "Command": "SetTrackingWideAreaHorizontalPosition", "SessionID": "7425fbbcb58cc4d15cd4c15acc4289a3", "Params": { "HorizontalPosition": "Center" } } } | |||||||||||||
| Response Key Style Value | HM650 | HM650 | HM640 | HM630 | HM620 | HM610 | HM600 | HM590 | HM580 | HM570 | HM560 | ||
| Response | |||||||||||||
| Requested | String | SetTrackingWideAreaHorizontalPosition | - | - | - | - | - | - | - | - | - | - | - |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - |
| Example | |||||||||||||
| "Response": { "Requested": "SetTrackingWideAreaHorizontalPosition", "Result": "Success" } } | |||||||||||||
3.9.28. Set Tracking Start Position of Wide Area Mode of Auto Tracking
Set tracking start position of wide area mode of auto tracking.
| Request Key Style Value | HM650 | HM650 | HM640 | HM630 | HM620 | HM610 | HM600 | HM590 | HM580 | HM570 | HM560 | ||
| Request | |||||||||||||
| Command | String | SetTrackingWideAreaStartPosition | - | - | - | - | - | - | - | - | - | - | - |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - |
| Params | |||||||||||||
| StartPosition | String | "CurrentPosition" / "HomePosition" / "W1" / "W2" / "Preset1" | - | - | - | - | - | - | - | - | - | - | - |
3.9.29 Get Auto Tracking Settings of Fine Adjustment Mode
Request all auto tracking settings of Fine Adjustment mode.
| Request Key Style Value | HM650 | HM660 | HM6x0 | HM25x | HM280 | LS300 | PZ100 | HC900 | PC900 | PZ400 | PZ200 | PZ510 | |||
| Request | |||||||||||||||
| Command | String | GetTrackingFineAdjustment | - | - | - | - | - | - | - | - | - | - | - | - | |
| SessionID | String | {Session ID in cookie.} | - | - | - | - | - | - | - | - | - | - | - | - | |
Example
| { |
| "Request": { |
| "Command": "GetTrackingFineAdjustment", |
| "SessionID": "7425fbb68ee4d15dd4c1f5ace4209a3" |
| } |
| Response Key Style | Value | H16 | H16 | H16 | H16 | H16 | H16 | L53 | F21 | HC9 | HC9 | P74 | F22 | F25 | |
| Response | |||||||||||||||
| Requested | String | GetTrackingFineAdjustment | - | - | - | - | - | - | - | - | - | - | - | - | |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - | - | |
| Data | |||||||||||||||
| AutoZoom | String | "On" / "Off" | - | - | - | - | - | - | - | - | - | - | - | - | |
| AutoTilt | String | "On" / "Off" | - | - | - | - | - | - | - | - | - | - | - | - | |
| DurationTime | Integer | 1-6 | - | - | - | - | - | - | - | - | - | - | - | - | |
| FigureSize | String | "Full" / "Upper" / "Close" / "Custom" | - | - | - | - | - | - | - | - | - | - | - | - | |
| FigureSizeCustom | Integer | 80-290 (This parameter is valid only when 'FigureSize' is 'Custom'). | - | - | - | - | - | - | - | - | - | - | - | - | |
| VerticalPosition | Integer | -5 - 5 | - | - | - | - | - | - | - | - | - | - | - | - | |
| HorizontalPosition | String | "Left" / "Center" / "Right" | - | - | - | - | - | - | - | - | - | - | - | - | |
Example Example ('FigureSize' is 'Custom')
| {"Response": {"Response": {"Requested": "GetTrackingFineAdjustment", "Result": "Success", "Result": "Success", "Data": {"Data": {"AutoZoom": "On", "AutoZoom": "On", "AutoTill": "On", "AutoTill": "On", "DurationTime": 3, "DurationTime": 3, "FigureSize": "Center", "VerticalPosition": 0, "FigureSizeCustom": 80, "HorizontalPosition": "Center"} }} |
3.9.30. Set Auto Zoom of Fine Adjustment Mode of Auto Tracking
Set auto zoom of fine adjustment mode of auto tracking.
| Request Key Style Value | ||||||||||||||
| Request | ||||||||||||||
| Command | String | SetTrackingFineAdjustmentAutoZoom | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Params | ||||||||||||||
| AutoZoom | String | "On" / "Off" | - | - | - | - | - | - | - | - | - | - | - | ✓ |
3.9.31. Set Auto Tilt of Fine Adjustment Mode of Auto Tracking
Set auto tilt of wide area mode of auto tracking.
| Request Key Style Value | HM650 | HM650 | HM640 | HM620 | HM625x | HM630 | LS300 | PZ100 | HC300 | HC390 | PZ400 | FZZ200 | FZ510 | ||
| Request | |||||||||||||||
| Command | String | SetTrackingFineAdjustmentAutoTilt | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Params | |||||||||||||||
| AutoTilt | String | "On" / "Off" | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example | |||||||||||||||
| "Request": { "Command": "SetTrackingFineAdjustmentAutoTilt", "SessionID": "7425f8cb686e4d15cd4c15acc4299a3", "Params": { "AutoTilt": "On" } } } | |||||||||||||||
| Response Key Style Value | HM650 | HM650 | HM640 | HM620 | HM625x | HM630 | LS300 | PZ100 | HC300 | HC390 | PZ400 | FZZ200 | FZ510 | ||
| Response | |||||||||||||||
| Requested | String | SetTrackingFineAdjustmentAutoTilt | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example | |||||||||||||||
| "Response": { "Requested": "SetTrackingFineAdjustmentAutoTilt", "Result": "Success" } } | |||||||||||||||
3.9.32. Set Tracking Duration Time of Fine Adjustment Mode of Auto Tracking
Set tracking duration time of Fine Adjustment mode of auto tracking.
| Request Key Style Value | HM650 | HM650 | HM640 | HM620 | HM625x | HM630 | LS300 | PZ100 | HC300 | HC390 | PZ400 | PZZ200 | PZ510 | ||
| Request | |||||||||||||||
| Command | String | SetTrackingFineAdjustmentDurationTime | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Params | |||||||||||||||
| DurationTime | Integer | 1-6 | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example | |||||||||||||||
| "Request": {"Command": "SetTrackingFineAdjustmentDurationTime","SessionID": "7425fbb68ee4d15cd4c15acc4299a3","Params": {"DurationTime": 3/;};} | |||||||||||||||
| Response Key Style Value | HM650 | HM650 | HM640 | HM620 | HM625x | HM630 | LS300 | PZ100 | HC300 | HC390 | PZ400 | PZZ200 | PZ510 | ||
| Response | |||||||||||||||
| Requested | String | SetTrackingFineAdjustmentDurationTime | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example | |||||||||||||||
| "Response": {"Requested": "SetTrackingFineAdjustmentDurationTime","Result": "Success"}} | |||||||||||||||
3.9.33. Set Fiqrue Size of Fine Adjustment Mode of Auto Tracking
Set figure size of fine adjustment mode of auto tracking.
Example Example ('FigureSize' is 'Custom')
| {"Request": {"Request": {"Command": "SetTrackingFineAdjustmentFigureSize", "SessionID": "7425fbcc58ee4d15004c1f5acc4299a3", "Params": {"Params": {"FigureSize": "Full"} "FigureSizeCustom": 80}} } | {"Command": "SetTrackingFineAdjustmentFigureSize", "SessionID": "7425fbcc58ee4d15004c1f5acc4299a3", "FigureSize": "Custom".} |
| Response Key Style | Value | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4M | H4 | |
| Response | ||||||||||||||||||||||||||||
| Requested | String | SetTrackingFineAdjustmentFigureSize | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | √ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | - | √ |
Example
| "Response": {"Requested":"SetTrackingFineAdjustmentFigureSize","Result":"Success"} |
3.9.34. Set Vertical Position of Fine Adjustment Mode of Auto Tracking
Set vertical position of fine adjustment mode of auto tracking.
| Request Key Style Value | HM650 | HM650 | HM640 | HM620 | HM625x | HM630 | LS300 | PZ100 | HC300 | HC390 | PZ400 | PZZ200 | PZ510 | ||
| Request | |||||||||||||||
| Command | String | SetTrackingFineAdjustmentVerticalPosition | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Params | |||||||||||||||
| VerticalPosition | Integer | -5 - 5 | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example | |||||||||||||||
| "Request": {"Command": "SetTrackingFineAdjustmentVerticalPosition", "SessionID": "7425fcbc68ee4d15cd4c15acc4299a3", "Params": "/VerticalPosition": 0 / } | |||||||||||||||
| Response Key Style Value | HM650 | HM650 | HM640 | HM620 | HM625x | HM630 | LS300 | PZ100 | HC300 | HC390 | PZ400 | PZZ200 | PZ510 | ||
| Response | |||||||||||||||
| Requested | String | SetTrackingFineAdjustmentVerticalPosition | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example | |||||||||||||||
| "Response": {"Requested": "SetTrackingFineAdjustmentVerticalPosition", "Result": "Success" /} | |||||||||||||||
3.9.35. Set Horizontal Position of Fine Adjustment Mode of Auto Tracking
Set horizontal position of fine adjustment mode of auto tracking.
| Request Key Style Value | HM650 | HM650 | HM640 | HM630 | HM620 | HM610 | HM600 | HM590 | HM580 | HM570 | HM560 | ||
| Request | |||||||||||||
| Command | String | SetTrackingFineAdjustmentHorizontalPosition | - | - | - | - | - | - | - | - | - | - | - |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - |
| Params | |||||||||||||
| HorizontalPosition | String | "Left" / "Center" / "Right" | - | - | - | - | - | - | - | - | - | - | - |
| Example | |||||||||||||
| "Request": { "Command": "SetTrackingFineAdjustmentHorizontalPosition", "SessionID": "7425fbbcb58cc4d15cd4c15acc4289a3", "Params": { "HorizontalPosition": "Center", } } } | |||||||||||||
| Response Key Style Value | HM650 | HM650 | HM640 | HM630 | HM620 | HM610 | HM600 | HM590 | HM580 | HM570 | HM560 | ||
| Response | |||||||||||||
| Requested | String | SetTrackingFineAdjustmentHorizontalPosition | - | - | - | - | - | - | - | - | - | - | - |
| Result | String | (Result of command processing.) | - | - | - | - | - | - | - | - | - | - | - |
| Example | |||||||||||||
| "Response": { "Requested": "SetTrackingFineAdjustmentHorizontalPosition", "Result": "Success" } } } | |||||||||||||
3.9.36 Get All Detected Objects
Request all detected objects.
| Request Key Style Value | A4650 | A4660 | A4680 | A4620 | A463x | A4630 | LS300 | PZ100 | HC900 | HC360 | PZ400 | PZ200 | PZ510 | |||
| Command | String | GetTrackingDetectedObjects | - | - | - | - | - | - | - | - | - | - | - | - | - | |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | - | - | |
| Response Key Style Value | |||||||||||||||
| Requested | String | GetTrackingDetectedObjects | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Result | String | [Result of command processing.] | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Data | |||||||||||||||
| ScreenWidth | Integer | Screen width (resolution width) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| ScreenHeight | Integer | Screen height (resolution height) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Objects | Array | The size of the array depends on the number of objects detected. | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| ID | String | Unique ID used to specify in "SetTrackingTarget". The ID must be valid at least until the next "GetTrackingDetectedObjects" request within the same "SessionID". | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| X | Integer | X coordinate of the upper left of the detected object. | - | - | - | - | - | - | + | + | - | - | - | - | ✓ |
| Y | Integer | Y coordinate of the upper left of the detected object. | - | - | - | - | - | - | + | - | - | - | - | - | ✓ |
| Width | Integer | Detected object width. | - | - | - | - | - | - | + | + | - | - | - | - | ✓ |
| Height | Integer | Detected object height. | - | - | - | - | - | - | + | + | - | - | - | - | ✓ |
| TargetObjectID | String | ID of the current tracking target. If there is no tracking target, a zero-length string (""). | - | - | - | - | - | - | + | + | - | - | - | - | ✓ |
Example
{
"Response": {
"Requested": "GetTrackingDetectedObjects",
"Result": "Success",
"Data": {
"ScreenWidth": 1320,
"ScreenHeight": 1080,
"Objects": [
{"D": "abc", "X": 100, "Y": 150, "Width": 200, "Height": 600},
{"D": "def", "X": 700, "Y": 350, "Width": 250, "Height": 700},
{"D": "gh", "X": 1300, "Y": 200, "Width": 400, "Height": 500}
],
"TargetObjectID": "abc"
}
}

3.9.37. Set Tracking Target
Set the tracking target to the specified object ID.
| Request Key Style Value | |||||||||||||||
| Request | |||||||||||||||
| Command | String | SetTrackingTarget | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| SessionID | String | (Session ID in cookie.) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Params | |||||||||||||||
| ID | String | Object ID obtained by "GetTrackingDetectedObjects". | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Example{"Request": {"Command": "SetTrackingTarget","SessionID": "74250cb686e4d15dd4c15ape4299a3","Params": {"ID": "abc"/}} | |||||||||||||||
| Response Key Style Value | |||||||||||||||
| Response | |||||||||||||||
| Requested | String | SetTrackingTarget | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Result | String | (Result of command processing.) *Command parsed result | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| Data | |||||||||||||||
| Result | String | (Command execution result) | - | - | - | - | - | - | - | - | - | - | - | - | ✓ |
| "Succeeded": Successfully set tracking target. | - | - | - | - | - | - | + | + | - | - | - | - | ✓ | ||
| "Lost": Lost the object with the specified ID. | - | - | - | - | - | - | - | - | - | - | - | - | ✓ | ||
| "InvalidID": Specified ID is invalid. | - | - | - | - | - | - | + | - | - | - | - | - | ✓ | ||
| "InvalidOperation": Can't set tracking target in current mode. | - | - | - | - | - | - | + | + | - | - | - | - | ✓ | ||
| Example{"Response": {"Requested": "SetTrackingTarget","Result": "Success","Data": {"Result": "Succeeded"}} | |||||||||||||||