JVC VN-H257VP Manual

JVC VN-H257VP Manual

Ip camera api guide

Advertisement

IP Camera API GUIDE
VN-H37/137/237/237VP
VN-H57/157WP/257/257VP
This document provides information of protocol and API of JVC new IP cameras,
VN-H series.
Specifications subject to change without notice.
2012.06.29. (V4.00)
© 2012 JVC KENWOOD Corporation
1

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the VN-H257VP and is the answer not in the manual?

Questions and answers

Summarization of Contents

Streaming Protocol
JVC Protocol: JPEG Streaming
API procedures and format for JPEG streaming.
JVC Protocol: H.264 Streaming
API procedures and format for H.264 streaming.
JVC Protocol: MPEG-4 Streaming
API procedures and format for MPEG-4 streaming.
RTSP/RTP
URI and settings for RTSP/RTP streaming.
API to Search Camera
Search Camera in LAN
Procedure for searching cameras in the LAN via API.
Using API that Requires Basic Authentication
Procedure
Steps for using APIs requiring basic authentication.
Getting Parameter
How to get camera parameters using GET API.
Setting Parameter
How to set camera parameters using GET API.
JVC API for Camera
Getting Camera ID
API to acquire the camera's unique identifier.
Setting Camera ID
API to change the camera's unique identifier.
Getting Current Scene File Number
API to acquire the current scene file number.
Getting Preset Data of Scene File
API to retrieve preset data for a specified scene file.
Loading/Saving/Initializing Scene File
APIs for loading, saving, or initializing camera scene file settings.
Getting Current Scene File Name
API to acquire the name of the current scene file.
Getting Auto Exposure Reference of a Scene File
API to get auto exposure reference for a scene file.
Setting Auto Exposure Reference of a Scene File
API to set auto exposure reference for a scene file.
Getting Color Level of a Scene File
API to get the color level setting of a scene file.
Setting Color Level of a Scene File
API to set the color level setting of a scene file.
Getting Enhance of a Scene File
API to get the image enhancement setting of a scene file.
Setting Enhance of a Scene File
API to set the image enhancement setting of a scene file.
Getting 3DDNR of a Scene File
API to get the 3DDNR setting of a scene file.
Setting 3DDNR of a Scene File
API to set the 3DDNR setting of a scene file.
Getting White Balance of a Scene File
API to get the white balance setting of a scene file.
Setting White Balance of a Scene File
API to set the white balance setting of a scene file.
Getting R-Gain of White Balance of a Scene File
API to get the R-Gain of white balance for a scene file.
Setting R-Gain of White Balance of a Scene File
API to set the R-Gain of white balance for a scene file.
Getting B-Gain of White Balance of a Scene File
API to get the B-Gain of white balance for a scene file.
Setting B-Gain of White Balance of a Scene File
API to set the B-Gain of white balance for a scene file.
Getting AGC of a Scene File
API to get the AGC setting of a scene file.
Setting AGC of a Scene File
API to set the AGC setting of a scene file.
Getting Limit of Sense Up of a Scene File
API to get the limit of sense up setting for a scene file.
Setting Limit of Sense Up of a Scene File
API to set the limit of sense up setting for a scene file.
Getting ALC priority of Scene File
API to get the ALC priority setting of a scene file.
Setting ALC priority of Scene File
API to set the ALC priority setting of a scene file.
Getting Shutter Speed of a Scene File
API to get the shutter speed setting of a scene file.
Setting Shutter Speed of a Scene File
API to set the shutter speed setting of a scene file.
Getting Day and Night Setting of a Scene File (for VN-H37 and VN-H237VP)
API to get the Day and Night setting for specific models.
Setting Day and Night Setting of a Scene File (for VN-H37 and VN-H237VP)
API to set the Day and Night setting for specific models.
Getting Easy Day and Night Setting of a Scene File (for VN-H137 and VN-H237)
API to get Easy Day and Night setting for specific models.
Setting Easy Day and Night Setting of a Scene File (for VN-H137 and VN-H237)
API to set Easy Day and Night setting for specific models.
Getting Back Light Compensation of a Scene File
API to get the Back Light Compensation setting of a scene file.
Setting Back Light Compensation of a Scene File
API to set the Back Light Compensation setting of a scene file.
Getting CLVI of a Scene File
API to get the CLVI setting of a scene file.
Setting CLVI of a Scene File
API to set the CLVI setting of a scene file.
JVC API for Encode
Getting Compression Format
API to acquire the compression format of an encode channel.
Setting Compression Format
API to change the compression format of an encode channel.
Getting Resolution (Frame Size)
API to acquire the resolution (frame size) of an encode channel.
Setting Resolution (Frame Size)
API to change the resolution (frame size) of an encode channel.
Getting Rate Control Setting
API to acquire the rate control setting.
Setting Rate Control
API to change the rate control setting.
Getting H.264 or MPEG-4 bitrate
API to acquire the bitrate setting for H.264 or MPEG-4.
Setting H.264 or MPEG-4 bitrate
API to change the bitrate setting for H.264 or MPEG-4.
Getting JPEG File Size Setting
API to acquire the file size setting for JPEG.
Setting JPEG File Size
API to change the file size setting for JPEG.
Getting H.264 or MPEG-4 I-Frame Interval Setting
API to acquire the I-Frame interval for H.264 or MPEG-4 encoding.
Setting H.264 or MPEG-4 I-Frame Interval
API to change the I-Frame interval for H.264 or MPEG-4 encoding.
Getting Frame Rate Setting
API to acquire the frame rate of encoding.
Setting Frame Rate
API to change the frame rate of encoding.
Getting Monitor Out Status
API to acquire the status of the monitor output.
Setting Monitor Out Status
API to change the status of the monitor output.
JVC API for Audio (VN-H57/157WP/257/257VP)
Getting Audio Duplex Mode
API to acquire the audio duplex mode setting.
Setting Audio Duplex Mode
API to change the audio duplex mode setting.
Getting Mike Gain
API to acquire the microphone gain setting.
Setting Mike Gain
API to change the microphone gain setting.
Getting Mike Power Supply setting
API to acquire the microphone power supply setting.
Setting Mike Power Supply
API to change the microphone power supply setting.
JVC API for Alarm
Getting On/Off of Alarm Action
API to get the on/off status of a specified alarm action.
Setting On/Off of Alarm Action, or Enabling Changes to Alarm Action
API to set the alarm action on/off or enable changes.
Getting Alarm Action
API to acquire the alarm action of a specified alarm number.
Setting Alarm Action
API to set the alarm action for a specified alarm number.
Getting Alarm Filter Setting
API to acquire the filter setting for an alarm action.
Setting Alarm Filter
API to set the filter setting for an alarm action.
Getting Alarm Filter Time
API to acquire the filter time for an alarm action.
Setting Alarm Filter Time
API to set the filter time for an alarm action.
Getting Alarm Filter Type
API to acquire the filter type for an alarm action.
Setting Alarm Filter Type
API to set the filter type for an alarm action.
Getting Alarm Trigger
API to acquire the trigger for an alarm action.
Setting Alarm Trigger
API to set the trigger for an alarm action.
JVC API for Alarm Environment
Getting SMTP Server Address Setting
API to acquire the SMTP server address.
Setting SMTP Server Address
API to change the SMTP server address.
Getting SMTP Server Port Number Setting
API to acquire the SMTP server port number.
Setting SMTP Server Port Number
API to change the SMTP server port number.
Getting Sender Mail Address Setting
API to acquire the sender mail address setting.
Setting Sender Mail Address
API to change the sender mail address setting.
Getting "POP before SMTP" Setting
API to acquire the 'POP before SMTP' setting.
Setting "POP before SMTP"
API to change the 'POP before SMTP' setting.
Getting POP Server Address Setting
API to acquire the POP server address.
Setting POP Server Address
API to change the POP server address.
Getting POP Server Port Number Setting
API to acquire the POP server port number.
Setting POP Server Port Number
API to change the POP server port number.
Getting POP Server User Name Setting
API to acquire the POP server user name.
Setting POP Server User Name
API to change the POP server user name.
Setting POP Server Password
API to change the POP server password.
Getting FTP Server Address Setting
API to acquire the FTP server address for alarm transmission.
Setting FTP Server Address
API to change the FTP server address for alarm transmission.
Getting FTP Server Path Setting
API to acquire the FTP server directory setting for alarm transmission.
Setting FTP Server Path
API to change the FTP server directory setting for alarm transmission.
Getting FTP Server User Name Setting
API to acquire the FTP server user name for alarm transmission.
Setting FTP Server User Name
API to change the FTP server user name for alarm transmission.
Setting FTP Server Password
API to change the FTP server password for alarm transmission.
Getting File Naming of Periodic FTP
API to acquire the file naming convention for periodic FTP.
Setting File Naming of Periodic FTP
API to change the file naming convention for periodic FTP.
Getting User Define Name of File Naming
API to acquire user-defined file naming for periodic FTP.
Setting User Define Name of File Naming
API to set user-defined file naming for periodic FTP.
Getting Parameters of Pre/Post Recording for FTP
APIs to get parameters for Pre/Post Recording for FTP.
Setting Parameters of Pre/Post Recording for FTP
APIs to set parameters for Pre/Post Recording for FTP.
JVC API for SD Card Record
Getting SD Card Status
API to acquire the status of the SD card.
Setting SD Card to Use/Disable
API to change the Use/Disable status of the SD card.
Getting Status of SD Card formatting
API to acquire the status of SD card formatting.
Formatting SD Card
API to initiate SD card formatting.
Getting SD Card Constant Recording On/Off Status
API to acquire the status of SD Card Constant Recording.
Setting SD Card Constant Recording On/Off
API to change the status of SD Card Constant Recording.
Getting SD Card Capacity
API to acquire the capacity of the SD card.
Getting SD Card Recording Status
API to acquire the status of SD card recording.
Getting Encoder No. for SD Card Recording
API to acquire the encoder number for SD card recording.
Setting Encoder No. for SD Card Recording
API to change the encoder number for SD card recording.
JVC API for Digital PTZ
(1) Settings for PTZ Control
Section for configuring PTZ control settings.
Getting Auto Return Mode
API to acquire the Auto Return mode setting.
Setting Auto Return Mode
API to change the Auto Return mode setting.
Getting Timeout of Auto Return
API to acquire the timeout setting for Auto Return.
Setting Timeout of Auto Return
API to change the timeout setting for Auto Return.
Getting Auto Return Status
API to acquire the status of Auto Return.
Setting Auto Return Status
API to change the status of Auto Return.
Getting Speed of Going to Preset Position
API to acquire the speed for going to a preset position.
Setting Speed of Going to Preset Position
API to set the speed for going to a preset position.
(2) PTZ Control
Section for controlling PTZ operations.
Getting Pan Position
API to acquire the current pan position.
Moving to Specified Pan Position
API to move the camera to a specified pan position.
Pan Operation
API to start or stop pan operation.
Setting Direction of Pan Operation
API to set the direction of pan operation.
Setting Speed of Pan Operation
API to set the speed of pan operation.
Getting Pan Operation Status
API to acquire the current pan operation status.
Getting Tilt Position
API to acquire the current tilt position.
Moving to Specified Tilt Position
API to move the camera to a specified tilt position.
Tilt Operation
API to start or stop tilt operation.
Setting Direction of Tilt Operation
API to set the direction of tilt operation.
Setting Speed of Tilt Operation
API to set the speed of tilt operation.
Getting Tilt Operation Status
API to acquire the current tilt operation status.
Getting Zoom Position
API to acquire the current zoom multiple.
Moving to Specified Zoom Position
API to move to a specified zoom multiple.
Zoom Operation
API to start or stop zoom operation.
Setting Direction of Zoom Operation
API to set the direction of zoom operation.
Setting Speed of Zoom Operation
API to set the speed of zoom operation.
Getting Zoom Operation Status
API to acquire the current zoom operation status.
Moving Specified Position to Center
API to move the camera to a specified center position.
(3) Preset Position
Section for managing preset positions.
Getting Current Preset Position
API to acquire the current preset position.
Getting Status of Specified Preset Position
API to acquire the status of a specified preset position.
Register Current Position as Preset Position
API to save the current position as a preset position.
Initialize Preset Position
API to initialize a specified preset position.
Moving to Preset Position
API to move to a specified preset position.
Getting Title of Preset Position
API to acquire the title of a specified preset position.
Setting Title to Preset Position
API to set the title for a specified preset position.
JVC API for Auto Patrol
Start/Stop of Auto Patrol
API to start or stop the auto patrol mode.
Getting Status of Auto Patrol
API to acquire the current status of auto patrol.
Getting Preset Postion Number of Auto Patrol
API to acquire the preset position number for auto patrol.
Setting Preset Postion Number of Auto Patrol
API to set the preset position number for auto patrol.
Getting Duration of Auto Patrol
API to acquire the duration of auto patrol for a specified number.
Setting Duarion of Auto Patrol
API to set the duration of auto patrol for a specified number.
Getting Speed of Auto Patrol
API to acquire the speed of auto patrol for a specified number.
Setting Speed of Auto Patrol
API to set the speed of auto patrol for a specified number.
Saving Preset Position Number/Duarion of Auto Patrol
API to save preset position number and duration of auto patrol.
JVC API for Privacy Masking
Getting Privacy Masking On/Off Status
API to acquire the on/off status of privacy masking.
Setting Privacy Masking to On/Off
API to change the on/off status of privacy masking.
Getting Privacy Masking Color
API to acquire the color of privacy masking.
Setting Privacy Masking Color
API to change the color of privacy masking.
Getting Privacy Masking Area
API to acquire the area of privacy masking.
Setting Privacy Masking Area
API to change the area of privacy masking.
JVC API for Motion Detect
Getting Motion Detect On/Off Status
API to acquire the on/off status of motion detection.
Setting Motion Detect to On/Off
API to change the on/off status of motion detection.
Getting Motion Detect Sensitivity
API to acquire the motion detection sensitivity.
Setting Motion Detect Sensitivity
API to change the motion detection sensitivity.
Getting Motion Detect Mask
API to acquire the motion detection mask.
Setting Motion Detect Mask
API to change the motion detection mask.
JVC API for Tampering Detect
Getting Tampering Detect On/Off Status
API to acquire the on/off status of tampering detection.
Setting Tampering Detect to On/Off
API to change the on/off status of tampering detection.
Getting Tampering Detect Sensitivity
API to acquire the tampering detection sensitivity.
Setting Tampering Detect Sensitivity
API to change the tampering detection sensitivity.
Getting Tampering Detect time
API to acquire the tampering detection time.
Setting Tampering Detect Sensitivity
API to change the tampering detection time.
JVC API for Network Basics
Enabling Network Setting Changes
API to enable network parameter changes, requiring camera reboot.
Getting DHCP Setting
API to acquire the current DHCP setting.
Setting DHCP
API to change the DHCP setting, requiring camera reboot.
Getting IP Address
API to acquire the current IP address.
Setting IP Address
API to change the IP address, requiring camera reboot.
Getting Subnet Mask
API to acquire the current subnet mask.
Setting Subnet Mask
API to change the subnet mask, requiring camera reboot.
Getting Default Gateway
API to acquire the default gateway for IPv4 or IPv6.
Setting Default Gateway
API to change the default gateway.
Getting Host Name
API to acquire the current host name.
Setting Host Name
API to change the host name.
Getting DNS Server On/Off Status
API to acquire the on/off status of the DNS server.
Setting DNS Server Status to On/Off, or Validate Changes
API to change DNS server status or validate changes.
Getting DNS Server IP Address
API to acquire the IP address of the DNS server.
Setting DNS Server IP Address
API to change the IP address of the DNS server.
Getting IPv6 status
API to acquire the IPv6 status.
Setting IPv6 status
API to change the IPv6 status.
Getting Link Local Address of IPv6
API to acquire the link local address of IPv6.
Getting Global Address of IPv6
API to acquire the global address of IPv6.
Getting MAC Address
API to acquire the MAC address.
Getting TOS Value of Stream
API to acquire the TOS value.
Setting TOS Value of Stream
API to change the TOS value.
Getting Unicast TTL Value
API to acquire the TTL value for unicast.
Setting Unicast TTL
API to change the TTL value for unicast.
Getting Multicast TTL Value
API to acquire the TTL value for multicast.
Setting Multicast TTL
API to change the TTL value for multicast.
Getting MTU Value
API to acquire the MTU value.
Setting MTU Value
API to change the MTU value.
Getting Network Negotiation Setting
API to acquire the network negotiation setting.
Setting Network Negotiation
API to change the network negotiation setting.
JVC API for Protocol
Getting Port Number of HTTP
API to acquire the port number of the HTTP server.
Setting Port Number of HTTP
API to change the port number of the HTTP server.
Getting Status of AMX Discovery Protocol
API to acquire the status of AMX Discovery Protocol.
Setting Status of AMX Discovery Protocol
API to change the status of AMX Discovery Protocol.
Getting Status of PSIA Protocol
API to acquire the status of PSIA Protocol.
Setting Status of PSIA Protocol
API to change the status of PSIA Protocol.
Getting Status of ONVIF Protocol
API to acquire the status of ONVIF Protocol.
Setting Status of ONVIF Protocol
API to change the status of ONVIF Protocol.
JVC API for Multicast Streaming
Getting Status of Multicast Streaming
API to acquire the status of multicast streaming.
Setting Status of Multicast Streaming, or Save Changes
API to start/stop multicast streaming or save changes.
Getting Multicast Address
API to acquire the multicast address.
Setting Multicast Address
API to change the multicast address.
Getting Multicast Port Number
API to acquire the multicast port number.
Setting Multicast Port Number
API to change the multicast port number.
Getting Frame Rate of JPEG Multicast
API to acquire the JPEG multicast frame rate.
Setting Frame Rate of JPEG Multicast
API to change the JPEG multicast frame rate.
Getting Status of Audio Multicast Streaming
API to acquire the status of audio multicast streaming.
Setting Status of Audio Multicast Streaming, or Save Changes
API to start/stop audio multicast streaming or save changes.
Getting Audio Multicast Address
API to acquire the audio multicast address.
Setting Audio Multicast Address
API to change the audio multicast address.
Getting Audio Multicast Port Number
API to acquire the audio multicast port number.
Setting Audio Multicast Port Number
API to change the audio multicast port number.
JVC API for Access Restrictions
Getting Deny/Allow Setting of Client Restrictions
API to acquire the deny/allow setting for client restrictions.
Setting Client Restriction to Deny/Allow
API to change the deny/allow setting of client restrictions.
Getting IP Address Setting of Restricted Client
API to acquire the IP address setting of a restricted client.
Setting IP Address of Restricted Client
API to change the IP address setting of a restricted client.
JVC API for Time
Getting On/Off of SNTP Client
API to acquire the on/off status of the SNTP client.
Setting On/Off of SNTP Client, or Validate Changes
API to change SNTP client status or validate changes.
Getting NTP Server Address
API to acquire the IP address of the NTP server.
Setting NTP Server Address
API to change the IP address of the NTP server.
Getting Access Interval to NTP Server
API to acquire the interval for accessing the NTP server.
Setting Access Interval to NTP Server
API to change the interval for accessing the NTP server.
Getting Access Interval Unit of NTP
API to acquire the unit of interval for accessing the NTP server.
Setting Access Interval Unit of SNTP
API to change the unit of interval for accessing the NTP server.
Getting Time
API to acquire the current time from the camera's built-in clock.
Setting Time
API to change the time of the camera's built-in clock.
Getting Timezone
API to acquire the camera's timezone.
Setting Timezone
API to change the camera's timezone.
JVC API for Password
Setting Password of admin
API to change the admin password.
Setting Password of operator
API to change the operator password.
Setting Password of user
API to change the user password.
Delete Acount
API to delete specified user accounts.
JVC API for Maintenance
Restart the Camera
API to restart the camera.
Initialization
API to restore camera settings to factory defaults.
JVC API for LED Setting
Getting LED mode
API to acquire the LED setting.
Setting LED mode
API to change the LED setting.
Getting LED blinking mode
API to acquire the LED blinking setting.
Setting LED blinking mode
API to change the LED blinking setting.
JVC API for Getting Status
Getting Sending Status
API to get the total transmission bit rate and status.
Getting Log
API to acquire the camera log information.
Getting Model Name
API to acquire the camera model name.
Getting Firmware Revisions
API to acquire the firmware revisions.
Getting Software ID
API to return the software ID.
JVC API for Others
Getting Alarm Input Status (VN-H57/157/257)
API to acquire the current alarm input status.
Getting Mode of FTP Server
API to acquire the mode of the FTP server used by alarm action.
Setting Mode of FTP Server
API to change the mode of the FTP server used by alarm action.
Getting Control Port Number of FTP Server
API to acquire the control port number of the FTP server.
Setting Control Port Number of FTP Server
API to change the control port number of the FTP server.
Getting Port Number of RTSP Server
API to acquire the port number for the RTSP server.
Setting Port Number of RTSP Server
API to change the port number of the RTSP server.
Getting Audio from the Camera via HTTP (VN-H57/157WP/257/257VP)
29.1. Basic Procedures
Steps for establishing TCP connection and sending API for audio via HTTP.
29.2. API Format Structure
Defines the structure of API requests for audio transmission via HTTP.
29.3. Response
Details the camera's response to audio API requests.
29.4. Restrictions
Covers access restriction and bitrate limitations for audio streams.
Sending Audio to the Camera (VN-H57/157WP/257/257VP)
30.1. Procedures
Steps for sending audio from a client to the camera.
30.2. Restrictions
Details restrictions on the number of clients and timing of data sending.
Getting SD Card data from the Camera via RTSP/RTP
31.1. URI
Provides the URI for RTSP to access SD card data.
31.2. Playback control
Describes messages for controlling playback of SD card data.
31.3. Example of message sequence
Illustrates an example message sequence for RTSP communication.
Exporting H.264 data from SD Card to the PC
Getting Total Number of Files and File Size
API to get the total number of files and their sizes from the SD card.
Exporting SD Card Data as a File
API to export SD card data as a file.
Customizing Built-in Viewer
34.1. List of ActiveX
Lists available ActiveX controls for the built-in viewer.
34.2. Properties of ActiveX
Details the properties of the JPEG/H.264 Viewer ActiveX control.
PTZ Control Client
Details properties for the PTZ Control Client ActiveX.
Audio Monitor/Audio Sending Client [VN-H57/VN-H157WP/VN-H257/VN-H257VP only]
Details properties for Audio Monitor and Audio Sending Client ActiveX.
34.3. Method of ActiveX Control
Describes methods for controlling ActiveX components.
34.4. How to use ActiveX Control by HTML
Explains how to integrate ActiveX controls into HTML.
34.5. HTML Sample
Provides sample HTML code for using ActiveX controls.
FAQ
(1) Low Frame rate due to long delay of network
Explains causes and countermeasures for low frame rate due to network delay.

Table of Contents