Hik.Api Gets the time. The ip channel. Sets the time. The date time. The ip channel. Gets the device configuration. Gets the network configuration. Gets the HDD status. The ip channel. Finds the files asynchronous. The period start. The period end. Finds the files asynchronous. The period start. The period end. The ip channel. Hikvision SDK Wrapper Gets the user identifier. The user identifier. Gets the default ip channel. The default ip channel. Occurs when [disconnected]. Gets the video service. The video service. Gets the photo service. The photo service. Gets the playback service. The playback service. Gets the config service. The config service. Logouts the user. Initializes this instance. The log level. The log directory. if set to true [automatic delete logs]. The wait time milliseconds. The try times. The reconnect interval. if set to true [enable reconnect]. Logins the specified ip address. The ip address. The port. Name of the user. The password. Cleanups this instance. Downloads the file. Name of the remote file. The size. The destination path. Downloads the file. The photo. The destination path. Starts the play back. The channel. The playback window handler. Stops the play back. The playback identifier. Starts the recording. The playback identifier. The file path. The channel. Stops the recording. The playback identifier. Converts to remotefile. Starts the download file. The source file. The destination path. Stops the download file. The file handle. Gets the download position. The file handle. Device Config Gets the analog channel. The analog channel. Gets the ip channel. The ip channel. Gets the zero channel. The zero channel. Gets the network port. The network port. Gets the alarm in port. The alarm in port. Gets the alarm out port. The alarm out port. Gets the serial. The serial. Gets the version. The version. Gets the name of the type. The name of the type. Gets the name. The name. Hard drive information Initializes a new instance of the class. Gets a value indicating whether this instance is error status. true if this instance is error status; otherwise, false. Gets or sets the capacity. The capacity. Gets or sets the free space. The free space. Gets or sets the hd status. The hd status. Gets or sets the hd attribute. The hd attribute. Gets or sets the type of the hd. The type of the hd. Gets or sets the recycling. The recycling. Gets or sets the picture capacity. The picture capacity. Gets or sets the free picture space. The free picture space. Converts to string. A that represents this instance. Remote file from camera Initializes a new instance of the class. Gets or sets the name. The name. Gets or sets the date. The date. Gets or sets the duration. The duration. Gets or sets the size. The size. IpChannel Initializes a new instance of the class. The i chan no. if set to true [by online]. The name. Gets the channel number. The channel number. Gets a value indicating whether this instance is online. true if this instance is online; otherwise, false. Gets the name. The name. Network config Gets the ip address. The ip address. Gets the gate way. The gate way. Gets the sub mask. The sub mask. Gets the DNS. The DNS. Gets the host ip. The host ip. Gets the name of the pp po e. The name of the pp po e. Gets the pp po e password. The pp po e password. Gets the alarm host ip port. The alarm host ip port. Gets the HTTP port. The HTTP port. Gets the DVR port. The DVR port. Gets a value indicating whether this is DHCP. true if DHCP; otherwise, false. Gets a value indicating whether [pp po e]. true if [pp po e]; otherwise, false. Hik Remote File Extensions Converts to user friendly string. For video files The file. Converts to user friendly file name. For photo files. The file. Gets Relative path in format YYYY-MM\\DD\\HH The file. Converts to user friendly file name. For video files. The file. Implementation of IHikApi When connection is lost Initializes a new instance of the class. Gets the video service. The video service. Gets the photo service. The photo service. Gets the playback service. The playback service. Config service Gets a value indicating whether this is connected. true if connected; otherwise, false. Gets the user identifier. The user identifier. Gets the Host identifier. The Host identifier. Gets the default ip channel. The default ip channel. Gets the ip channels. The ip channels. Initialize the SDK and call other SDK functions. [in] Log level. 0- close log(default), 1- output ERROR log only, 2- output ERROR and DEBUG log, 3- output all log, including ERROR, DEBUG and INFO log [in] Log file saving path, if set to NULL, the default path for Windows is "C:\\SdkLog\\", and the default path for Linux is ""/home/sdklog/" [bool] Whether to delete the files which exceed the number limit. Default: TRUE Timeout,unit: ms, value range: [300,75000], the actual max timeout time is different with different system connecting timeout Connecting attempt times (reserved) Reconnecting interval, unit: milliseconds, default value:30 seconds Enable or disable reconnect function, 0-disable, 1-enable(default) TRUE means success, FALSE means failure. This API is used to initialize SDK. Please call this API before calling any other API This API is used to login user to the device. device IP address device port number Login username password. User session It supports 32 different user names for DS7116, DS81xx, DS90xx and DS91xx series devices, and 128 users login at the same time.Other devices support 16 different user names and 128 users login at the same time. SDK supports 512 * login.UserID is incremented one by one, from 0 to 511 and then return to 0. Logout and NET_DVR_Cleanup will not initialize the UserID to 0. If client offline abnormally, the device will keep the UserID 5 minutes, and the UserID will invalid after the valid time. Release SDK resources, last call before the end TRUE means success, FALSE means failure This API is used to release SDK resource. Please calling it before closing the program. This API is used to logout certain user. TRUE means success, FALSE means failure It is suggested to call this API to logout. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Initialize the SDK and call other SDK functions. TRUE means success, FALSE means failure. This API is used to initialize SDK. Please call this API before calling any other API Enable log file writing interface The level of the log (default is 0): 0- means to close the log, 1- means only output ERROR error log, 2- output ERROR error information and DEBUG debugging information, 3- output ERROR All information such as error information, DEBUG debugging information and INFO general information The path of the log file, the default value of windows is "C:\\SdkLog\\"; the default value of linux is "/home/sdklog/" Whether to delete the excess number of files, the default value is TRUE.. When it is TRUE, it means the overwrite mode. When the number of log files exceeds the SDK limit, the excess files will be automatically deleted. The SDK limit is 10 by default Return TRUE on success, FALSE on failure. Please call NET_DVR_GetLastError to get the error code. This API is used to login user to the device. device IP address device port number Login username password. device information. -1 indicates failure, other values indicate the returned user ID value It supports 32 different user names for DS7116, DS81xx, DS90xx and DS91xx series devices, and 128 users login at the same time.Other devices support 16 different user names and 128 users login at the same time. SDK supports 512 * login.UserID is incremented one by one, from 0 to 511 and then return to 0. Logout and NET_DVR_Cleanup will not initialize the UserID to 0. If client offline abnormally, the device will keep the UserID 5 minutes, and the UserID will invalid after the valid time. This API is used to logout certain user. User ID, the return value of NET_DVR_Login_V30 TRUE means success, FALSE means failure It is suggested to call this API to logout. Release SDK resources, last call before the end TRUE means success, FALSE means failure This API is used to release SDK resource. Please calling it before closing the program. Set the network connection timeout and the number of connection attempts Timeout,unit: ms, value range: [300,75000], the actual max timeout time is different with different system connecting timeout Connecting attempt times (reserved) Return TRUE on success, FALSE on failure. Please call NET_DVR_GetLastError to get the error code. Default timeout of SDK to establish a connection is 3 seconds. Interface will not return FASLE when the set timeout value is greater or less than the limit, it will take the nearest upper and lower limit value as the actual timeout. Set the reconnection function. Reconnecting interval, unit: milliseconds, default value:30 seconds Enable or disable reconnect function, 0-disable, 1-enable(default) Return TRUE on success, FALSE on failure. Please call NET_DVR_GetLastError to get the error code. This API can set the reconnect function for preview, transparent channel and alar on guard state.If the user does not call this API, the SDK will initial the reconnect function for preview, transparent channel and alarm on guard state by default, and the reconnect interval is 5 seconds. Hik Exception Gets the error message. The error message. Initializes a new instance of the class. The method. The error. Converts to string. A that represents this instance. Initializes a new instance of the class. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. HikSDK Cleanups this instance. Initializes this instance. The log level. The log directory. if set to true [automatic delete logs]. The wait time milliseconds. The try times. The reconnect interval. if set to true [enable reconnect]. Logins the specified ip address. The ip address. The port. Name of the user. The password. Config service Initializes a new instance of the class. The session. Get device current time Default value 1 Set device current time The date time. Default value -1 Get device configuration information. Get device network information. Network information Get SD Card info, capacity, free space, status etc. Default value -1 HdInfo Get device configuration information. Return value of login interface such as NET_DVR_Login_V40 [in] Channel number, different commands correspond to different values, if this parameter is invalid, set it to 0xFFFFFFFF, see "Remarks" for details. Channel number, different commands correspond to different values, if this parameter is invalid, set it to 0xFFFFFFFF, see "Remarks" for details. [out] Buffer pointer for receiving data [in] The buffer length of received data (in bytes), which cannot be 0 [out] The actual received data length pointer, which cannot be NULL Set the configuration information of the device. Return value of login interface such as NET_DVR_Login_V40 Device configuration command, see "Remarks" for details Channel number, different commands correspond to different values, if this parameter is invalid, set it to 0xFFFFFFFF, see "Remarks" for details Buffer pointer for input data. The buffer length of the input data (in bytes) Different acquisition functions correspond to different structures and command numbers Base class to download files session Initializes a new instance of the class. The session. Finds the files asynchronous. The period start. The period end. Get files list for specific channel The period start. The period end. The ip channel. Starts the find. The period start. The period end. The channel. Stops the find. The find identifier. Success Finds the next. The find identifier. The source. Success Gets the find results. The find identifier. Photo service Initializes a new instance of the class. The session. Download File remote file name Remote file size Save path Download file Hik remote file Save path Stops the find. The find identifier. Success Starts the find. The period start. The period end. The channel. Find identifier This API is used to get picture one by one. [in] Handle of file searching, the return value of NET_DVR_FindPicture Pointer for saving picture information Return -1 if it is failed, and the other values stand for current status or other information. Please call NET_DVR_GetLastError to get the error code. Before calling this function, please call NET_DVR_FindPicture to get current handle firstly. The interface only supports to get one picture. We should call the interface repetitively to get all pictures. Get picture information one by one in search result. [in] Handle of finding picture, the return value of NET_DVR_FindPicture [out] Save compass for picture information. Return -1 for failure, other values indicate the current getting status. When -1 is returned, callNET_DVR_GetLastError to get the error code. Before calling this API to get the searched picture information, call NET_DVR_FindPicture to get the current searching handle. This API is used to get one searched picture information. To get all the searched pictures information, you should call this API in loop. This API is used to close finding picture and release resource. [in] Handle of finding picture, the return value of NET_DVR_FindPicture Returns TRUE on success, FALSE on failure. Please call NET_DVR_GetLastError to get the error code. This API is used to get picture data and save it in specified memory space. User ID, the return value of NET_DVR_Login_V40 Return temporary file Returns TRUE for success, and FALSE for failure. When FALSE is returned, call NET_DVR_GetLastError to get the error code. Nets the DVR get picture. User ID, the returned value of API NET_DVR_Login_V40 in] Name of picture to download [in] Saving path (including file name) for downloaded pictures Return TRUE for success, and return FALSE for failure. If API returns FALSE, call NET_DVR_GetLastError to get error code. The picture format is JPEG, and the postfix of file name is ".jpg". Playback Service Initializes a new instance of the class. The session. Start live preview without callback, all receiver live data will be handled by PictureBox Handle channel. System.Windows.Forms.PictureBox Handle Stop real-time preview The playback identifier. TRUE means success, FALSE means failure Start recording live stream to filePath in .mp4 format playback identifier. file path. channel. Stop recording live stream to filePath The playback identifier. Make the main stream create a key frame(I frame) The return value of NET_DVR_Login_V30 Channel number. Return TRUE on success, FALSE on failure. Please call NET_DVR_GetLastError to get the error code. The interface is used to reset I frame, please call NET_DVR_MakeKeyFrame or NET_DVR_MakeKeyFrameSub to reset I frame for the main stream or sub stream according to the set preview parameter NET_DVR_CLIENTINFO. Capture data and save to assigned file The return value of NET_DVR_RealPlay_V30 Pointer of file path Return TRUE on success, FALSE on failure. Please call NET_DVR_GetLastError to get the error code Stop save real data. The return value of NET_DVR_RealPlay_V30 Return TRUE on success, FALSE on failure. Please call NET_DVR_GetLastError to get the error code. Real-time preview. The return value of NET_DVR_Login() or NET_DVR_Login_V30() Preview parameters code stream data callback function User data 1 means failure, other values are used as handle parameters of functions such as NET_DVR_StopRealPlay preview callback The current preview handle data type pointer to the buffer where the data is stored. buffer size. user data Stop real-time preview real-time preview handle TRUE means success, FALSE means failure Video service Initializes a new instance of the class. The session. Start download File Hik remote file name Save path Download handler Stop Download File Download handler Get the progress of the current download video file Download handler Get the found file information one by one The find identifier. The source. -1 means failure, and other values are used as parameters of functions such as NET_DVR_FindClose. Starts the find. The period start. The period end. The channel. Download handler Close the file search and release resources. The find identifier. TRUE means success, FALSE means failure. This API is used to close file search and release the resource. File search handle, return value of NET_DVR_FindFile_V40, NET_DVR_FindFileByEvent or NET_DVR_FindFile_V30 TRUE means success, FALSE means failure. Get the found file information one by one File search handle, return value of NET_DVR_FindFile_V40 or NET_DVR_FindFile_V30 The pointer to save the file information -1 indicates failure, and other values indicate the current acquisition status and other information. Before calling this function, please call NET_DVR_FindFile_V30 to get current handle firstly. The interface only supports to get one file. We should call the interface repetitively to get all files. We can get other information, like card number and whether the file is locked, by calling this API as well. Find device video files according to file type and time. The return value of login interface such as NET_DVR_Login_V40 The file information structure to be found -1 means failure, and other values are used as parameters of functions such as NET_DVR_FindClose. This interface specifies the information of the video file to be found. After the call is successful, you can call the NET_DVR_FindNextFile_V40 interface to obtain the file information. Download video file by file name The return value of NET_DVR_Login or NET_DVR_Login_V30 The name of the video file to be downloaded, the length of the file name must be less than 100 bytes. The file path saved to the PC after downloading, must be an absolute path (including the file name). Return -1 if it is failed, and other values could be used as the parameter of functions NET_DVR_StopGetFile. Please call NET_DVR_GetLastError to get the error code. Before calling this interface to download file, we can call the interface of searching record file to get file name. The interface have assigned the file to be downloaded currently. After calling it successfully, it needs to call starting play control command NET_DVR_PLAYSTART of NET_DVR_PlayBackControl_V40 to download file. This API is used to control playback status. play handle, return value of NET_DVR_PlayBackByName, NET_DVR_PlayBackReverseByName or NET_DVR_PlayBackByTime_V40, NET_DVR_PlayBackReverseByTime_V40. Control video playback status command Pointer to the input parameter Input parameter length. Not used, reserved. Pointer to the output parameter The length of the output parameter TRUE means success, FALSE means failure. Get the progress of the current download video file Download handle, return value of NET_DVR_GetFileByName, NET_DVR_GetFileByTime_V40 or NET_DVR_GetFileByTime -1 means failure; 0~100 means the progress of the download; 100 means the end of the download; the normal range is 0-100, if it returns 200, it means that there is a network exception. This interface is used to obtain the download progress when downloading video files by file name. This API is used to stop downloading record files. Download handle, return value of NET_DVR_GetFileByName, NET_DVR_GetFileByTime_V40 or NET_DVR_GetFileByTime. TRUE means success, FALSE means failure.