JVC VN-V686U manual Camera Saving Changes of Camera Settings, Api/param?ParamA.ParamB.ParamC=Data

Page 17

(2) Setting parameter

Specify API in GET line according to the format below when setting a parameter for VN-V686.

/api/param?ParamA.ParamB.ParamC=Data

Parameter values are indicated using =. Do not insert space before and after =.

The upper limit of this character string is 1024 bytes.

Response will be in the following format.

ParamA.ParamB.ParamC&200 OK

An error code will be returned when setting is not properly performed. Example:

ParamA.ParamB.ParamC&401 Unauthorized

6.2. Camera

These APIs are related to camera settings. Same functions are shown on the Camera page of the WEB setting page and PTZ Controller of built-in viewer. Refer to the instruction manual for details on the Camera page and PTZ Controller.

Saving Changes of Camera Settings

Format /api/param?canera.status=data

Example /api/param?canera.status=save

Example of response canera.status&200 OK

Interpretation Save or cancel changes to camera settings. Specify save or restore. By status=save, changes to camera settings are saved. If not saved, the changes are restored by power off of VN-V686. By status=restore, changes to camera settings are restored.

Allowed users admin, operator

Getting Camera ID stored in JPEG from VN-V686

Format /api/param?camera.id

Example of response camera.id=VN-V686&200 OK

Response example when setting field is left blank camera.id=&200 OK

Interpretation Acquire Camera ID comment. This comment is stored in comment segment of JPEG. The Camera ID is used as sender's display name of alarm mail. If you want to set sender's mail address, see "Setting Sender

Mail Address for VN-V686".

Example of response camera.id=Camera01&200 OK

17

Image 17
Contents VN-V686U Updates Custom Application Software Development Guide Content Getting Jpeg from VN-V686 via Http Basic ProceduresAPI Format Structure Parameter Description Response When API is successfully receivedJpeg File Format Sent Out by VN-V686 RestrictionsGetting MPEG-4 from VN-V686 via Http VN-V686 returns Http response Example encode=mpeg4 MPEG-4 Stream Format Sent Out by VN-V686 20070319161455123UTC Search VN-V686 in LAN ProcedureUsing API that Requires Basic Authentication Api/param?ParamA.ParamB.ParamC GeneralParamA.ParamB.ParamC=Data&200 OK ParamA.ParamB.ParamC&401 UnauthorizedGetting Camera ID stored in Jpeg from VN-V686 Camera Saving Changes of Camera SettingsApi/param?ParamA.ParamB.ParamC=Data ParamA.ParamB.ParamC&200 OKSetting Monitor Type for VN-V686 Setting Camera ID in Jpeg from VN-V686Example of setting /api/param?camera.id=Camera01 Getting Monitor Type from VN-V686Setting Gamma for VN-V686 Setting Black level for VN-V686Getting Black level from VN-V686 Getting Gamma from VN-V686Setting Enhance Band for VN-V686 Setting Active Gamma Level for VN-V686Getting Active Gamma Level from VN-V686 Getting Enhance Band from VN-V686Setting Color Level for VN-V686 Setting Enhance for VN-V686Getting Color Level from VN-V686 Getting Stabilizer from VN-V686Setting Stabilizer Level for VN-V686 Setting Stabilizer for VN-V686Getting Stabilizer Level from VN-V686 Getting DNR from VN-V686Setting AGC for VN-V686 Setting DNR for VN-V686Setting Limit of Sense Up for VN-V686 Getting AGC from VN-V686Setting Shutter Speed for VN-V686 Setting ALC priority for VN-V686Getting ALC priority from VN-V686 Getting Shutter Speed from VN-V686Setting B&W Mode for VN-V686 Getting B&W Mode from VN-V686Getting Auto Focus mode for B&W switching from VN-V686 Setting Auto Focus mode for B&W switching for VN-V686Saving Image Settings for Auto Pan and Auto Trace Getting Light setting for focus in B&W mode from VN-V686Setting Light for focus in B&W mode for VN-V686 Setting Iris Direction for VN-V686 Setting Iris for VN-V686Getting Iris from VN-V686 Operating Iris for VN-V686Setting R-Gain of White Balance for VN-V686 Setting White Balance for VN-V686Getting White Balance from VN-V686 Getting R-Gain of White Balance from VN-V686Setting Back Light Compensation for VN-V686 Setting B-Gain of White Balance for VN-V686Getting B-Gain of White Balance from VN-V686 Getting Back Light Compensation from VN-V686Getting Jpeg Frame Size from VN-V686 Encoding Saving Changes of Encode Settings for VN-V686Setting Jpeg Frame Size for VN-V686 Setting Jpeg Rate Control for VN-V686 Getting Jpeg Rate Control Setting from VN-V686Getting Jpeg File Size Setting from VN-V686 Setting Jpeg File Size Setting for VN-V686Getting MPEG-4 Frame Size from VN-V686 Setting MPEG-4 Frame Size for VN-V686Getting MPEG-4 bitrate Setting from VN-V686 Getting MPEG-4 Rate Control Setting from VN-V686 Setting MPEG-4 bitrate Setting for VN-V686Setting MPEG-4 Rate Control for VN-V686 Getting MPEG-4 Frame Rate Setting from VN-V686Setting MPEG-4 I-Frame Interval Setting for VN-V686 Getting MPEG-4 I-Frame Interval Setting from VN-V686Getting MPEG-4 Priority Setting from VN-V686 Setting MPEG-4 Priority Setting for VN-V686Getting Alarm Action from VN-V686 Alarm Setting Getting On/Off of Alarm Action from VN-V68600 OK Example of Response application.event1.action=&200 OKSsage Setting Alarm Action for VN-V686Format /api/param?application.eventNumber.action=Data Alarm%20ON Api/param?application.event1.filtersunday.status=on Getting Alarm Filter Setting from VN-V686Setting Alarm Filter for VN-V686 Getting Alarm Filter Type from VN-V686 Getting Alarm Filter Time from VN-V686Setting Alarm Filter Time for VN-V686 Getting Alarm Trigger from VN-V686 Setting Alarm Filter Type for VN-V686Api/param?application.event1.filtersunday.type=unmask Format /api/param?application.eventNumber.triggerExample of Response application.event1.trigger=v1&200 OK Setting Alarm Trigger for VN-V686Format /api/param?application.eventNumber.trigger=data Api/param?application.event1.trigger=m1Getting Smtp Server Port Number Setting from VN-V686 Setting Smtp Server Address for VN-V686Setting Example /api/param?application.event1.trigger=v1 Setting Example /api/param?application.event6.trigger=i1500Getting Sender Mail Address Setting from VN-V686 Setting Smtp Server Port Number for VN-V686Setting Sender Mail Address for VN-V686 Getting POP before Smtp Setting from VN-V686Getting POP Server Address Setting from VN-V686 Setting POP before Smtp for VN-V686Setting POP Server Address for VN-V686 Getting POP Server Port Number Setting from VN-V686Setting POP Server Password for VN-V686 Getting POP Server User Name Setting from VN-V686Setting POP Server User Name for VN-V686 Setting FTP Server Address for VN-V686 Getting FTP Server Address Setting from VN-V686Getting FTP Server Path Setting from VN-V686 Setting FTP Server Path for VN-V686Setting FTP Server User Name for VN-V686 Getting FTP Server User Name Setting from VN-V686Setting FTP Server Password for VN-V686 Getting File Naming of Periodic FTP from VN-V686Getting User Define Name of File Naming from VN-V686 Setting File Naming of Periodic FTP for VN-V686Setting User Define Name of File Naming for VN-V686 Getting Parameters of Pre/Post Recording from VN-V686 Setting Parameters of Pre/Post Recording for VN-V686Setting Alarm Output Time for VN-V686 Getting Alarm Output Time Setting from VN-V686Getting Alarm Output Status from VN-V686 Changing Alarm Output of VN-V686Setting Auto Return Mode for VN-V686 Getting Auto Return Mode from VN-V686Getting Timeout of Auto Return from VN-V686 Setting Timeout of Auto Return for VN-V686Setting Detection Level of Auto Tracking for VN-V686 Setting Auto Return Status for VN-V686Start/Stop of Auto Tracking for VN-V686 Getting Detection Level of Auto Tracking from VN-V686Setting Upper Limit of EZoom for VN-V686 Setting Restart Time of Auto Tracking for VN-V686Getting Restart Time of Auto Tracking from VN-V686 Getting Upper Limit of EZoom from VN-V686Setting Left Side of Pan Limit for VN-V686 Setting On/Off of Pan Limit for VN-V686Setting Right Side of Pan Limit for VN-V686 Getting Left Side of Pan Limit from VN-V686Getting Speed of Going to Preset Position from VN-V686 Setting Tilt Limit for VN-V686Setting Speed of Going to Preset Position for VN-V686 Moving to Left/Right Side of Pan Limit for VN-V686Getting Pan Position from VN-V686 Getting Auto Flip Setting from VN-V686Setting Auto Flip for VN-V686 Setting Speed of Pan Operation for VN-V686 Setting Direction of Pan Operation for VN-V686Moving to Specified Pan Position for VN-V686 Pan Operation for VN-V686Getting Status of Variable Pan/Tilt Speed from VN-V686 Setting Status of Variable Pan/Tilt Speed for VN-V686Getting Tilt Position from VN-V686 Moving to Specified Tilt Position for VN-V686Setting Speed of Tilt Operation for VN-V686 Setting Direction of Tilt Operation for VN-V686Getting Tilt Operation Status from VN-V686 Getting Zoom Position from VN-V686Setting Speed of Zoom Operation for VN-V686 Setting Direction of Zoom Operation for VN-V686Zoom Operation for VN-V686 Getting Zoom Operation Status from VN-V686Setting Speed of Focus Operation for VN-V686 Setting Direction of Focus Operation for VN-V686Moving to Specified Focus Position for VN-V686 Focus Operation for VN-V686Getting Status of Specified Preset Position from VN-V686 Getting Current Preset Position from VN-V686Register Current Position as Preset Position for VN-V686 Initialize Preset Position for VN-V686Getting Title of Preset Position from VN-V686 Moving to Preset Position for VN-V686Setting Title to Preset Position for VN-V686 Getting Status of Auto Pan from VN-V686Setting Speed of Auto Pan for VN-V686 Setting Direction of Auto Pan for VN-V686Getting Direction of Auto Pan from VN-V686 Getting Speed of Auto Pan from VN-V686Start/Stop of Auto Trace for VN-V686 Getting Status of Auto Trace from VN-V686Start/Stop of Auto Trace Recording for VN-V686 Api/param?camera.motion.autotrace.record.status=startGetting Status of Auto Patrol from VN-V686 Getting Status of Auto Trace Recording from VN-V686Auto Patrol Start/Stop of Auto Patrol for VN-V686 Setting Preset Postion Number of Auto Patrol for VN-V686 Getting Preset Postion Number of Auto Patrol from VN-V686Setting Duarion of Auto Patrol for VN-V686 Getting Duration of Auto Patrol from VN-V686Getting Status of a Privacy Masking Area from VN-V686 Setting Whole Status of Privacy Masking for VN-V686Setting Privacy Masking Brightness for VN-V686 Setting Status of a Privacy Masking Area for VN-V686Getting Privacy Masking Brightness from VN-V686 Start/Save Editing of Privacy Masking for VN-V686Setting Motion Detect to On/Off for VN-V686 Setting Width of Privacy Masking Area for VN-V686Setting Height of Privacy Masking Area for VN-V686 Setting Motion Detect Mask for VN-V686 Setting Motion Detect Sensitivity for VN-V686Getting Motion Detect Sensitivity from VN-V686 Getting Motion Detect Mask from VN-V686Setting Dhcp for VN-V686 Network Basics Enabling Network Setting ChangesGetting Dhcp Setting from VN-V686 Setting Subnet Mask for VN-V686 Setting IP Address for VN-V686Getting Default Gateway from VN-V686 Getting IP Address from VN-V686Setting Host Name for VN-V686 Setting Default Gateway for VN-V686Getting Host Name from VN-V686 Getting DNS Server On/Off Status from VN-V686Getting DNS Server IP Address from VN-V686 Setting DNS Server IP Address for VN-V686Getting MAC Address from VN-V686 Network Details Getting TOS Value of Jpeg from VN-V686Setting TOS Value of MPEG-4 for VN-V686 Setting TOS Value of Jpeg for VN-V686Setting Unicast TTL for VN-V686 Getting TOS Value of MPEG-4 from VN-V686Setting MTU Value for VN-V686 Setting Multicast TTL for VN-V686Getting Multicast TTL Value from VN-V686 Getting MTU Value VN-V686Setting Network Negotiation for VN-V686 Getting Network Negotiation Setting from VN-V686Setting Port Number of Http for VN-V686 Protocol Getting Port Number of Http from VN-V686Getting Jpeg Multicast Address from VN-V686 Setting Jpeg Multicast Address for VN-V686Setting Frame Rate of Jpeg Multicast for VN-V686 Setting Jpeg Multicast Port Number for VN-V686Getting Jpeg Multicast Port Number from VN-V686 Getting Frame Rate of Jpeg Multicast from VN-V686Getting MPEG-4 Multicast Port Number from VN-V686 Setting MPEG-4 Multicast Address for VN-V686Getting MPEG-4 Multicast Address from VN-V686 Format /api/param?network.accesscontrolstreamout.hostNumber Setting MPEG-4 Multicast Port Number for VN-V686Setting Client Restriction to Deny/Allow for VN-V686 Network.accesscontrolstreamout.host1=10.0.0.0/24&200 OK Setting IP Address of Restricted Client for VN-V686Example /api/param?network.accesscontrolstreamout.host1=%00 Time Getting On/Off of Sntp Client from VN-V686Getting Access Interval to NTP Server from VN-V686 Setting NTP Server Address for VN-V686Setting Access Interval to NTP Server for VN-V686 Getting NTP Server Address from VN-V686Setting Access Interval Unit of Sntp for VN-V686 Getting Access Interval Unit of NTP from VN-V686Setting Time for VN-V686 Getting Time from VN-V686GMT-9 Format /api/param?system.password.data1=data2 Setting Timezone for VN-V686Password Setting Password for VN-V686 Firmware Update Maintenance InitializationGetting Status of Auto Cleaning from VN-V686 Setting Auto Cleaning for VN-V686Format /api/param?system.session Setting Time of Auto Cleaning for VN-V686Getting Status Getting Sending Status Getting Log Getting Settings Getting Model NameGetting Firmware Revisions of Streaming Manager Format /api/param?system.logGetting Firmware Revisions of PTZ Controller Getting Alarm Input Status from VN-V686Getting Firmware Revisions of Image Processor Getting Firmware Revisions of LensSetting Mode of FTP Server for VN-V686 Getting Mode of FTP Server from VN-V686Setting Control Port Number of FTP Server for VN-V686 Getting Control Port Number of FTP Server from VN-V686List of Protocols and Port Numbers Used with VN-V686 Methods of ActiveX Html Sample Seamless Switching Getting Multicast Script FAQ