JVC VN-H57, 257VP, 137, 237VP, 157WP, VN-H37 Setting Camera ID, Getting Current Scene File Number

Page 21

Format /api/param?camera.id

Example of response camera.id=VN-H37&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".

Example of response camera.id=Camera01&200 OK

SenderCamera01<somename@somecompany.com>

Allowed users admin, operator, user

Setting Camera ID

Format /api/param?camera.id=data

Example /api/param?camera.id=Camera01

Example when setting as blank /api/param?camera.id=%00

Example of response

camera.id&202 Accepted(camera.status=save)

Interpretation Change the camera ID stored in comment segment of JPEG. Maximum size is 40 bytes.

To use following characters, specify by hexadecimal number after %.

space & / < > #

% " { } \ ^ [ ] `

To set as blank, specify as %00(0x25, 0x30, 0x30).

To use space, specify as %20(0x25, 0x32, 0x30). If you want to set "Comment In JPEG" for example, specify

as follows. /api/param?camera.id=Comment%20In%20JPEG

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".

Example of setting /api/param?camera.id=Camera01

SenderCamera01<somename@somecompany.com>

The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot. Allowed users admin, operator

Getting Current Scene File Number

Format /api/param?camera.scene.status

Example of response camera.scene.status=0&200 OK

Interpretation Acquire current scene file number. A number from 0 to 7 is returned. A scene file is a set of preset parameters below.

auto_exposure.reference, color, monitortype, pedestal, gamma, enhance, white_balance, brightness, white_balance, white_balance.r, white_balance.b, senseup_limit, brightness.highgain, true_daynight, blc, auto_exposure.priority, shutter

21

Image 21
Contents VN-H37/137/237/237VP VN-H57/157WP/257/257VP Updates Page Preface JVC API for Alarm FAQ Basic Procedures Streaming ProtocolJVC Protocol Jpeg Streaming Parameter Description API Format StructureRestrictions ResponseFFD9 Jpeg File Format Sent Out by the cameraJVC Protocol H.264 Streaming H.264 Stream Format Send Out by the camera When API is successfully receivedExample of H.264 Stream JVC Protocol MPEG-4 Streaming MPEG-4 Stream Format Send Out by the camera Example of MPEG-4 Stream URI API to Search CameraJpeg H.264Using API that Requires Basic Authentication ProcedureResponse Example System.id=VN-H37192.168.0.2/24&200 Okcrlf Api/param?ParamA.ParamB.ParamC Getting ParameterApi/param?ParamA.ParamB.ParamC&ParamA.ParamD.ParamE ParamA.ParamB.ParamC=Data&200 OKSetting Parameter JVC API for CameraGetting Camera ID Example of setting /api/param?camera.id=Camera01 Setting Camera IDGetting Current Scene File Number As follows. /api/param?camera.id=Comment%20In%20JPEGGetting Preset Data of Scene File Loading/Saving/Initializing Scene FileGetting Current Scene File Name Setting Color Level of a Scene File Setting Auto Exposure Reference of a Scene FileGetting Auto Exposure Reference of a Scene File Getting Color Level of a Scene FileSetting 3DDNR of a Scene File Setting Enhance of a Scene FileGetting Enhance of a Scene File Getting 3DDNR of a Scene FileSetting R-Gain of White Balance of a Scene File Setting White Balance of a Scene FileGetting R-Gain of White Balance of a Scene File Getting B-Gain of White Balance of a Scene FileSetting AGC of a Scene File Setting B-Gain of White Balance of a Scene FileSetting Limit of Sense Up of a Scene File Getting AGC of a Scene FileSetting Shutter Speed of a Scene File Setting ALC priority of Scene FileGetting ALC priority of Scene File Getting Shutter Speed of a Scene FilePage Setting Clvi of a Scene File Setting Back Light Compensation of a Scene FileGetting Back Light Compensation of a Scene File Getting Clvi of a Scene FileGetting Resolution Frame Size Setting Compression FormatJVC API for Encode Getting Compression FormatSetting Resolution Frame Size Getting Rate Control SettingSetting Rate Control Getting Jpeg File Size Setting Setting H.264 or MPEG-4 bitrateSetting Jpeg File Size Getting H.264 or MPEG-4 I-Frame Interval SettingGetting Frame Rate Setting Setting H.264 or MPEG-4 I-Frame IntervalSetting Frame Rate Setting Monitor Out StatusSetting Audio Duplex Mode Getting Audio Duplex ModeSetting Mike Gain JVC API for Audio VN-H57/157WP/257/257VPGetting Mike Power Supply setting JVC API for AlarmSetting Mike Power Supply Getting On/Off of Alarm ActionFormat /api/param?application.eventNumber.action Getting Alarm ActionApi/param?application.event1.action Example of Response Example of Response application.event1.action=&200 OKReturned. Segments are indicated by Setting Alarm Action Setting ExampleFormat /api/param?application.eventNumber.action=Data To add JPEG, specify objectNumber instead of none Setting Alarm Filter Getting Alarm Filter SettingSetting Alarm Filter Time Getting Alarm Filter TimeSetting Alarm Filter Type Getting Alarm Filter TypeSetting Alarm Trigger Getting Alarm TriggerFormat /api/param?application.eventNumber.trigger Format /api/param?application.eventNumber.trigger=dataJVC API for Alarm Environment Setting Example /api/param?application.event1.trigger=v1Setting Example /api/param?application.event6.trigger=i1500 Setting Smtp Server Address Getting Smtp Server Address SettingGetting Smtp Server Port Number Setting Setting Smtp Server Port NumberGetting POP before Smtp Setting Setting Sender Mail AddressSetting POP before Smtp Getting POP Server Address SettingGetting POP Server Port Number Setting Setting POP Server AddressSetting POP Server Port Number Getting POP Server User Name SettingGetting FTP Server Address Setting Setting POP Server PasswordSetting FTP Server Address Example of Response application.pop.user&200 OKSetting FTP Server Path Getting FTP Server Path SettingGetting FTP Server User Name Setting Setting FTP Server User NameSetting File Naming of Periodic FTP Setting FTP Server PasswordApi/param?application.ftp.password=%00 Getting File Naming of Periodic FTPSetting User Define Name of File Naming Getting User Define Name of File NamingGetting Parameters of Pre/Post Recording for FTP Setting Parameters of Pre/Post Recording for FTP JVC API for SD Card RecordGetting SD Card Status Setting SD Card Constant Recording On/Off Setting SD Card to Use/DisableGetting Status of SD Card formatting Formatting SD CardGetting SD Card Capacity Setting Encoder No. for SD Card RecordingGetting SD Card Recording Status Getting Encoder No. for SD Card RecordingGetting Auto Return Mode Setting Auto Return ModeJVC API for Digital PTZ Setting Timeout of Auto Return Getting Timeout of Auto ReturnSetting Auto Return Status Getting Speed of Going to Preset PositionSetting Direction of Pan Operation Setting Speed of Going to Preset PositionGetting Pan Position Moving to Specified Pan PositionGetting Pan Operation Status Setting Speed of Pan OperationGetting Tilt Position Moving to Specified Tilt PositionSetting Speed of Tilt Operation Setting Direction of Tilt OperationGetting Tilt Operation Status Getting Zoom PositionSetting Speed of Zoom Operation Setting Direction of Zoom OperationZoom Operation Getting Zoom Operation StatusGetting Status of Specified Preset Position Getting Current Preset PositionRegister Current Position as Preset Position Initialize Preset PositionJVC API for Auto Patrol Setting Preset Postion Number of Auto Patrol Getting Preset Postion Number of Auto PatrolSetting Duarion of Auto Patrol Getting Duration of Auto PatrolSaving Preset Position Number/Duarion of Auto Patrol Setting Speed of Auto PatrolJVC API for Privacy Masking Getting Speed of Auto PatrolSetting Privacy Masking Color Setting Privacy Masking to On/OffGetting Privacy Masking Color Getting Privacy Masking AreaSetting Motion Detect to On/Off Setting Motion Detect SensitivityGetting Motion Detect Sensitivity Setting Motion Detect Mask JVC API for Tampering DetectGetting Motion Detect Mask Setting Tampering Detect Sensitivity Setting Tampering Detect to On/OffGetting Tampering Detect On/Off Status Getting Tampering Detect SensitivityGetting Dhcp Setting Enabling Network Setting ChangesSetting Dhcp Allowed user adminSetting Subnet Mask Setting IP AddressGetting Default Gateway Getting IP AddressSetting Host Name Setting Default GatewaySetting DNS Server Status to On/Off, or Validate Changes Getting Host NameSetting IPv6 status Setting DNS Server IP AddressGetting DNS Server IP Address Getting IPv6 statusGetting Global Address of IPv6 Setting TOS Value of StreamGetting MAC Address Getting TOS Value of StreamSetting Multicast TTL Setting Unicast TTLGetting Unicast TTL Value Getting Multicast TTL ValueGetting Network Negotiation Setting Setting MTU ValueSetting Network Negotiation JVC API for ProtocolSetting Status of AMX Discovery Protocol Setting Port Number of HttpSetting Status of Psia Protocol Getting Status of AMX Discovery ProtocolSetting Status of Multicast Streaming, or Save Changes Setting Status of Onvif ProtocolJVC API for Multicast Streaming Getting Status of Onvif ProtocolSetting Multicast Port Number Setting Multicast AddressGetting Multicast Address Getting Multicast Port NumberSetting Frame Rate of Jpeg Multicast Getting Status of Audio Multicast StreamingGetting Audio Multicast Address Setting Audio Multicast Address JVC API for Access RestrictionsSetting Audio Multicast Port Number Getting Deny/Allow Setting of Client RestrictionsGetting IP Address Setting of Restricted Client Setting Client Restriction to Deny/AllowSetting IP Address of Restricted Client Format /api/param?network.accesscontrolstreamout.hostNumberSetting NTP Server Address Setting On/Off of Sntp Client, or Validate ChangesJVC API for Time Getting On/Off of Sntp ClientSetting Access Interval to NTP Server Getting Access Interval to NTP ServerGetting Access Interval Unit of NTP Setting Access Interval Unit of SntpGetting Timezone Setting TimeSetting Timezone JVC API for PasswordSetting Password of admin Format /api/param?system.password.adminnum=data2Setting Password of operator JVC API for MaintenanceSetting Password of user Delete AcountJVC API for LED Setting Setting LED blinking mode Getting LED blinking modeJVC API for Getting Status Getting Sending StatusGetting Log Alarm input 1ch makeGetting Model Name Format /api/param?system.logGetting Mode of FTP Server Getting Alarm Input Status VN-H57/157/257JVC API for Others Getting Firmware RevisionsSetting Control Port Number of FTP Server Setting Mode of FTP ServerSetting Port Number of Rtsp Server Getting Control Port Number of FTP ServerExample /api/param?network.rtsp.port=554 Camera Sending Audio to the Camera VN-H57/157WP/257/257VP Response When API is successfully receivedCamera ProceduresPlayback control Getting SD Card data from the Camera via RTSP/RTPExample of message sequence Exporting H.264 data from SD Card to the PC Getting Total Number of Files and File Size1fCRLF Exporting SD Card Data as a File Customizing Built-in Viewer List of Protocols and Port Numbers UsedList of ActiveX Protocol / Port Number UseProperties of ActiveX How to download ActiveX controls102 How to use ActiveX Control by Html Method of ActiveX ControlDirection Number of n Sample code Html Sample105 106 107 Psia FAQ