xicheji/refs/hik/Hik.Api.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Hik.Api</name>
    </assembly>
    <members>
        <member name="T:Hik.Api.Abstraction.IConfigService">
            <summary>
            
            </summary>
        </member>
        <member name="M:Hik.Api.Abstraction.IConfigService.GetTime(System.Int32)">
            <summary>
            Gets the time.
            </summary>
            <param name="ipChannel">The ip channel.</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Abstraction.IConfigService.SetTime(System.DateTime,System.Int32)">
            <summary>
            Sets the time.
            </summary>
            <param name="dateTime">The date time.</param>
            <param name="ipChannel">The ip channel.</param>
        </member>
        <member name="M:Hik.Api.Abstraction.IConfigService.GetDeviceConfig">
            <summary>
            Gets the device configuration.
            </summary>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Abstraction.IConfigService.GetNetworkConfig">
            <summary>
            Gets the network configuration.
            </summary>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Abstraction.IConfigService.GetHddStatus(System.Int32)">
            <summary>
            Gets the HDD status.
            </summary>
            <param name="ipChannel">The ip channel.</param>
            <returns></returns>
        </member>
        <member name="T:Hik.Api.Abstraction.IFileService">
            <summary>
            
            </summary>
        </member>
        <member name="M:Hik.Api.Abstraction.IFileService.FindFilesAsync(System.DateTime,System.DateTime)">
            <summary>
            Finds the files asynchronous.
            </summary>
            <param name="periodStart">The period start.</param>
            <param name="periodEnd">The period end.</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Abstraction.IFileService.FindFilesAsync(System.DateTime,System.DateTime,System.Int32)">
            <summary>
            Finds the files asynchronous.
            </summary>
            <param name="periodStart">The period start.</param>
            <param name="periodEnd">The period end.</param>
            <param name="ipChannel">The ip channel.</param>
            <returns></returns>
        </member>
        <member name="T:Hik.Api.Abstraction.IHikApi">
            <summary>
            Hikvision SDK Wrapper
            </summary>
        </member>
        <member name="P:Hik.Api.Abstraction.IHikApi.UserId">
            <summary>
            Gets the user identifier.
            </summary>
            <value>
            The user identifier.
            </value>
        </member>
        <member name="P:Hik.Api.Abstraction.IHikApi.DefaultIpChannel">
            <summary>
            Gets the default ip channel.
            </summary>
            <value>
            The default ip channel.
            </value>
        </member>
        <member name="E:Hik.Api.Abstraction.IHikApi.Disconnected">
            <summary>
            Occurs when [disconnected].
            </summary>
        </member>
        <member name="P:Hik.Api.Abstraction.IHikApi.VideoService">
            <summary>
            Gets the video service.
            </summary>
            <value>
            The video service.
            </value>
        </member>
        <member name="P:Hik.Api.Abstraction.IHikApi.PhotoService">
            <summary>
            Gets the photo service.
            </summary>
            <value>
            The photo service.
            </value>
        </member>
        <member name="P:Hik.Api.Abstraction.IHikApi.PlaybackService">
            <summary>
            Gets the playback service.
            </summary>
            <value>
            The playback service.
            </value>
        </member>
        <member name="P:Hik.Api.Abstraction.IHikApi.ConfigService">
            <summary>
            Gets the config service.
            </summary>
            <value>
            The config service.
            </value>
        </member>
        <member name="M:Hik.Api.Abstraction.IHikApi.Logout">
            <summary>Logouts the user.</summary>
        </member>
        <member name="T:Hik.Api.Abstraction.IHikSDK">
            <summary>
            
            </summary>
        </member>
        <member name="M:Hik.Api.Abstraction.IHikSDK.Initialize(System.Int32,System.String,System.Boolean,System.UInt32,System.UInt32,System.UInt32,System.Boolean)">
            <summary>
            Initializes this instance.
            </summary>
            <param name="logLevel">The log level.</param>
            <param name="logDirectory">The log directory.</param>
            <param name="autoDeleteLogs">if set to <c>true</c> [automatic delete logs].</param>
            <param name="waitTimeMilliseconds">The wait time milliseconds.</param>
            <param name="tryTimes">The try times.</param>
            <param name="reconnectInterval">The reconnect interval.</param>
            <param name="enableReconnect">if set to <c>true</c> [enable reconnect].</param>
        </member>
        <member name="M:Hik.Api.Abstraction.IHikSDK.Login(System.String,System.Int32,System.String,System.String)">
            <summary>
            Logins the specified ip address.
            </summary>
            <param name="ipAddress">The ip address.</param>
            <param name="port">The port.</param>
            <param name="userName">Name of the user.</param>
            <param name="password">The password.</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Abstraction.IHikSDK.Cleanup">
            <summary>
            Cleanups this instance.
            </summary>
        </member>
        <member name="T:Hik.Api.Abstraction.IPhotoService">
            <summary>
            
            </summary>
            <seealso cref="T:Hik.Api.Abstraction.IFileService" />
        </member>
        <member name="M:Hik.Api.Abstraction.IPhotoService.DownloadFile(System.String,System.Int64,System.String)">
            <summary>
            Downloads the file.
            </summary>
            <param name="remoteFileName">Name of the remote file.</param>
            <param name="size">The size.</param>
            <param name="destinationPath">The destination path.</param>
        </member>
        <member name="M:Hik.Api.Abstraction.IPhotoService.DownloadFile(Hik.Api.Data.HikRemoteFile,System.String)">
            <summary>
            Downloads the file.
            </summary>
            <param name="photo">The photo.</param>
            <param name="destinationPath">The destination path.</param>
        </member>
        <member name="T:Hik.Api.Abstraction.IPlaybackService">
            <summary>
            
            </summary>
        </member>
        <member name="M:Hik.Api.Abstraction.IPlaybackService.StartPlayBack(System.Int32,System.Nullable{System.IntPtr})">
            <summary>
            Starts the play back.
            </summary>
            <param name="channel">The channel.</param>
            <param name="playbackWindowHandler">The playback window handler.</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Abstraction.IPlaybackService.StopPlayBack(System.Int32)">
            <summary>
            Stops the play back.
            </summary>
            <param name="playbackId">The playback identifier.</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Abstraction.IPlaybackService.StartRecording(System.Int32,System.String,System.Int32)">
            <summary>
            Starts the recording.
            </summary>
            <param name="playbackId">The playback identifier.</param>
            <param name="filePath">The file path.</param>
            <param name="channel">The channel.</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Abstraction.IPlaybackService.StopRecording(System.Int32)">
            <summary>
            Stops the recording.
            </summary>
            <param name="playbackId">The playback identifier.</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Abstraction.ISourceFile.ToRemoteFile">
            <summary>
            Converts to remotefile.
            </summary>
            <returns></returns>
        </member>
        <member name="T:Hik.Api.Abstraction.IVideoService">
            <summary>
            
            </summary>
            <seealso cref="T:Hik.Api.Abstraction.IFileService" />
        </member>
        <member name="M:Hik.Api.Abstraction.IVideoService.StartDownloadFile(System.String,System.String)">
            <summary>
            Starts the download file.
            </summary>
            <param name="sourceFile">The source file.</param>
            <param name="destinationPath">The destination path.</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Abstraction.IVideoService.StopDownloadFile(System.Int32)">
            <summary>
            Stops the download file.
            </summary>
            <param name="fileHandle">The file handle.</param>
        </member>
        <member name="M:Hik.Api.Abstraction.IVideoService.GetDownloadPosition(System.Int32)">
            <summary>
            Gets the download position.
            </summary>
            <param name="fileHandle">The file handle.</param>
            <returns></returns>
        </member>
        <member name="T:Hik.Api.Data.DeviceConfig">
            <summary>
            Device Config
            </summary>
        </member>
        <member name="P:Hik.Api.Data.DeviceConfig.AnalogChannel">
            <summary>
            Gets the analog channel.
            </summary>
            <value>
            The analog channel.
            </value>
        </member>
        <member name="P:Hik.Api.Data.DeviceConfig.IPChannel">
            <summary>
            Gets the ip channel.
            </summary>
            <value>
            The ip channel.
            </value>
        </member>
        <member name="P:Hik.Api.Data.DeviceConfig.ZeroChannel">
            <summary>
            Gets the zero channel.
            </summary>
            <value>
            The zero channel.
            </value>
        </member>
        <member name="P:Hik.Api.Data.DeviceConfig.NetworkPort">
            <summary>
            Gets the network port.
            </summary>
            <value>
            The network port.
            </value>
        </member>
        <member name="P:Hik.Api.Data.DeviceConfig.AlarmInPort">
            <summary>
            Gets the alarm in port.
            </summary>
            <value>
            The alarm in port.
            </value>
        </member>
        <member name="P:Hik.Api.Data.DeviceConfig.AlarmOutPort">
            <summary>
            Gets the alarm out port.
            </summary>
            <value>
            The alarm out port.
            </value>
        </member>
        <member name="P:Hik.Api.Data.DeviceConfig.Serial">
            <summary>
            Gets the serial.
            </summary>
            <value>
            The serial.
            </value>
        </member>
        <member name="P:Hik.Api.Data.DeviceConfig.Version">
            <summary>
            Gets the version.
            </summary>
            <value>
            The version.
            </value>
        </member>
        <member name="P:Hik.Api.Data.DeviceConfig.TypeName">
            <summary>
            Gets the name of the type.
            </summary>
            <value>
            The name of the type.
            </value>
        </member>
        <member name="P:Hik.Api.Data.DeviceConfig.Name">
            <summary>
            Gets the name.
            </summary>
            <value>
            The name.
            </value>
        </member>
        <member name="T:Hik.Api.Data.HdInfo">
            <summary>
             Hard drive information
            </summary>
        </member>
        <member name="M:Hik.Api.Data.HdInfo.#ctor">
            <summary>Initializes a new instance of the <see cref="T:Hik.Api.Data.HdInfo" /> class.</summary>
        </member>
        <member name="P:Hik.Api.Data.HdInfo.IsErrorStatus">
            <summary>Gets a value indicating whether this instance is error status.</summary>
            <value>
              <c>true</c> if this instance is error status; otherwise, <c>false</c>.</value>
        </member>
        <member name="P:Hik.Api.Data.HdInfo.Capacity">
            <summary>Gets or sets the capacity.</summary>
            <value>The capacity.</value>
        </member>
        <member name="P:Hik.Api.Data.HdInfo.FreeSpace">
            <summary>Gets or sets the free space.</summary>
            <value>The free space.</value>
        </member>
        <member name="P:Hik.Api.Data.HdInfo.HdStatus">
            <summary>Gets or sets the hd status.</summary>
            <value>The hd status.</value>
        </member>
        <member name="P:Hik.Api.Data.HdInfo.HDAttr">
            <summary>Gets or sets the hd attribute.</summary>
            <value>The hd attribute.</value>
        </member>
        <member name="P:Hik.Api.Data.HdInfo.HDType">
            <summary>Gets or sets the type of the hd.</summary>
            <value>The type of the hd.</value>
        </member>
        <member name="P:Hik.Api.Data.HdInfo.Recycling">
            <summary>Gets or sets the recycling.</summary>
            <value>The recycling.</value>
        </member>
        <member name="P:Hik.Api.Data.HdInfo.PictureCapacity">
            <summary>Gets or sets the picture capacity.</summary>
            <value>The picture capacity.</value>
        </member>
        <member name="P:Hik.Api.Data.HdInfo.FreePictureSpace">
            <summary>Gets or sets the free picture space.</summary>
            <value>The free picture space.</value>
        </member>
        <member name="M:Hik.Api.Data.HdInfo.ToString">
            <summary>Converts to string.</summary>
            <returns>A <see cref="T:System.String" /> that represents this instance.</returns>
        </member>
        <member name="T:Hik.Api.Data.HikRemoteFile">
            <summary>
             Remote file from camera
            </summary>
        </member>
        <member name="M:Hik.Api.Data.HikRemoteFile.#ctor">
            <summary>Initializes a new instance of the <see cref="T:Hik.Api.Data.HikRemoteFile" /> class.</summary>
        </member>
        <member name="P:Hik.Api.Data.HikRemoteFile.Name">
            <summary>
            Gets or sets the name.
            </summary>
            <value>
            The name.
            </value>
        </member>
        <member name="P:Hik.Api.Data.HikRemoteFile.Date">
            <summary>
            Gets or sets the date.
            </summary>
            <value>
            The date.
            </value>
        </member>
        <member name="P:Hik.Api.Data.HikRemoteFile.Duration">
            <summary>
            Gets or sets the duration.
            </summary>
            <value>
            The duration.
            </value>
        </member>
        <member name="P:Hik.Api.Data.HikRemoteFile.Size">
            <summary>
            Gets or sets the size.
            </summary>
            <value>
            The size.
            </value>
        </member>
        <member name="T:Hik.Api.Data.IpChannel">
            <summary>
            IpChannel
            </summary>
        </member>
        <member name="M:Hik.Api.Data.IpChannel.#ctor(System.Int32,System.Boolean,System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:Hik.Api.Data.IpChannel"/> class.
            </summary>
            <param name="iChanNo">The i chan no.</param>
            <param name="byOnline">if set to <c>true</c> [by online].</param>
            <param name="name">The name.</param>
        </member>
        <member name="P:Hik.Api.Data.IpChannel.ChannelNumber">
            <summary>
            Gets the channel number.
            </summary>
            <value>
            The channel number.
            </value>
        </member>
        <member name="P:Hik.Api.Data.IpChannel.IsOnline">
            <summary>
            Gets a value indicating whether this instance is online.
            </summary>
            <value>
              <c>true</c> if this instance is online; otherwise, <c>false</c>.
            </value>
        </member>
        <member name="P:Hik.Api.Data.IpChannel.Name">
            <summary>
            Gets the name.
            </summary>
            <value>
            The name.
            </value>
        </member>
        <member name="T:Hik.Api.Data.NetworkConfig">
            <summary>
            Network config
            </summary>
        </member>
        <member name="P:Hik.Api.Data.NetworkConfig.IPAddress">
            <summary>
            Gets the ip address.
            </summary>
            <value>
            The ip address.
            </value>
        </member>
        <member name="P:Hik.Api.Data.NetworkConfig.GateWay">
            <summary>
            Gets the gate way.
            </summary>
            <value>
            The gate way.
            </value>
        </member>
        <member name="P:Hik.Api.Data.NetworkConfig.SubMask">
            <summary>
            Gets the sub mask.
            </summary>
            <value>
            The sub mask.
            </value>
        </member>
        <member name="P:Hik.Api.Data.NetworkConfig.Dns">
            <summary>
            Gets the DNS.
            </summary>
            <value>
            The DNS.
            </value>
        </member>
        <member name="P:Hik.Api.Data.NetworkConfig.HostIP">
            <summary>
            Gets the host ip.
            </summary>
            <value>
            The host ip.
            </value>
        </member>
        <member name="P:Hik.Api.Data.NetworkConfig.PPPoEName">
            <summary>
            Gets the name of the pp po e.
            </summary>
            <value>
            The name of the pp po e.
            </value>
        </member>
        <member name="P:Hik.Api.Data.NetworkConfig.PPPoEPassword">
            <summary>
            Gets the pp po e password.
            </summary>
            <value>
            The pp po e password.
            </value>
        </member>
        <member name="P:Hik.Api.Data.NetworkConfig.AlarmHostIpPort">
            <summary>
            Gets the alarm host ip port.
            </summary>
            <value>
            The alarm host ip port.
            </value>
        </member>
        <member name="P:Hik.Api.Data.NetworkConfig.HttpPort">
            <summary>
            Gets the HTTP port.
            </summary>
            <value>
            The HTTP port.
            </value>
        </member>
        <member name="P:Hik.Api.Data.NetworkConfig.DVRPort">
            <summary>
            Gets the DVR port.
            </summary>
            <value>
            The DVR port.
            </value>
        </member>
        <member name="P:Hik.Api.Data.NetworkConfig.DHCP">
            <summary>
            Gets a value indicating whether this <see cref="T:Hik.Api.Data.NetworkConfig"/> is DHCP.
            </summary>
            <value>
              <c>true</c> if DHCP; otherwise, <c>false</c>.
            </value>
        </member>
        <member name="P:Hik.Api.Data.NetworkConfig.PPPoE">
            <summary>
            Gets a value indicating whether [pp po e].
            </summary>
            <value>
              <c>true</c> if [pp po e]; otherwise, <c>false</c>.
            </value>
        </member>
        <member name="T:Hik.Api.Helpers.HikRemoteFileExtensions">
            <summary>
            Hik Remote File Extensions
            </summary>
        </member>
        <member name="M:Hik.Api.Helpers.HikRemoteFileExtensions.ToVideoUserFriendlyString(Hik.Api.Data.HikRemoteFile)">
            <summary>
            Converts to user friendly string. For video files
            </summary>
            <param name="file">The file.</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Helpers.HikRemoteFileExtensions.ToPhotoFileNameString(Hik.Api.Data.HikRemoteFile)">
            <summary>
            Converts to user friendly file name. For photo files.
            </summary>
            <param name="file">The file.</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Helpers.HikRemoteFileExtensions.ToDirectoryNameString(Hik.Api.Data.HikRemoteFile)">
            <summary>
            Gets Relative path in format YYYY-MM\\DD\\HH
            </summary>
            <param name="file">The file.</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Helpers.HikRemoteFileExtensions.ToVideoFileNameString(Hik.Api.Data.HikRemoteFile)">
            <summary>
            Converts to user friendly file name. For video files.
            </summary>
            <param name="file">The file.</param>
            <returns></returns>
        </member>
        <member name="T:Hik.Api.HikApi">
            <summary>
            Implementation of IHikApi
            </summary>
        </member>
        <member name="E:Hik.Api.HikApi.Disconnected">
            <summary>
            When connection is lost
            </summary>
        </member>
        <member name="M:Hik.Api.HikApi.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:Hik.Api.HikApi"/> class.
            </summary>
        </member>
        <member name="P:Hik.Api.HikApi.VideoService">
            <summary>Gets the video service.</summary>
            <value>The video service.</value>
        </member>
        <member name="P:Hik.Api.HikApi.PhotoService">
            <summary>Gets the photo service.</summary>
            <value>The photo service.</value>
        </member>
        <member name="P:Hik.Api.HikApi.PlaybackService">
            <summary>Gets the playback service.</summary>
            <value>The playback service.</value>
        </member>
        <member name="P:Hik.Api.HikApi.ConfigService">
            <summary>
            Config service
            </summary>
        </member>
        <member name="P:Hik.Api.HikApi.Connected">
            <summary>
            Gets a value indicating whether this <see cref="T:Hik.Api.HikApi" /> is connected.
            </summary>
            <value>
              <c>true</c> if connected; otherwise, <c>false</c>.
            </value>
        </member>
        <member name="P:Hik.Api.HikApi.UserId">
            <summary>
            Gets the user identifier.
            </summary>
            <value>
            The user identifier.
            </value>
        </member>
        <member name="P:Hik.Api.HikApi.Host">
            <summary>
            Gets the Host identifier.
            </summary>
            <value>
            The Host identifier.
            </value>
        </member>
        <member name="P:Hik.Api.HikApi.DefaultIpChannel">
            <summary>Gets the default ip channel.</summary>
            <value>The default ip channel.</value>
        </member>
        <member name="P:Hik.Api.HikApi.IpChannels">
            <summary>Gets the ip channels.</summary>
            <value>The ip channels.</value>
        </member>
        <member name="M:Hik.Api.HikApi.Initialize(System.Int32,System.String,System.Boolean,System.UInt32,System.UInt32,System.UInt32,System.Boolean)">
            <summary>
            Initialize the SDK and call other SDK functions.
            </summary>
            <param name="logLevel">[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</param>
            <param name="logDirectory">[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/" </param>
            <param name="autoDeleteLogs">[bool] Whether to delete the files which exceed the number limit. Default: TRUE</param>
            <param name="waitTimeMilliseconds">Timeout,unit: ms, value range: [300,75000], the actual max timeout time is different with different system connecting timeout</param>
            <param name="tryTimes">Connecting attempt times (reserved)</param>
            <param name="reconnectInterval">Reconnecting interval, unit: milliseconds, default value:30 seconds</param>
            <param name="enableReconnect">Enable or disable reconnect function, 0-disable, 1-enable(default)</param>
            <returns>TRUE means success, FALSE means failure. </returns>
            <remarks>This API is used to initialize SDK. Please call this API before calling any other API</remarks>
        </member>
        <member name="M:Hik.Api.HikApi.Login(System.String,System.Int32,System.String,System.String)">
            <summary>
            This API is used to login user to the device.
            </summary>
            <param name="ipAddress">device IP address</param>
            <param name="port">device port number</param>
            <param name="userName">Login username</param>
            <param name="password">password.</param>
            <returns>User session</returns>
            <remarks>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.</remarks>
        </member>
        <member name="M:Hik.Api.HikApi.Cleanup">
            <summary>
            Release SDK resources, last call before the end
            </summary>
            <returns>TRUE means success, FALSE means failure</returns>
            <remarks>This API is used to release SDK resource. Please calling it before closing the program.</remarks>
        </member>
        <member name="M:Hik.Api.HikApi.Logout">
            <summary>
            This API is used to logout certain user.
            </summary>
            <returns>
            TRUE means success, FALSE means failure
            </returns>
            <remarks>
            It is suggested to call this API to logout.
            </remarks>
        </member>
        <member name="M:Hik.Api.HikApi.Dispose">
            <summary>
             Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
            </summary>
        </member>
        <member name="M:Hik.Api.HikApi.NET_DVR_Init">
            <summary>
            Initialize the SDK and call other SDK functions.
            </summary>
            <returns>TRUE means success, FALSE means failure. </returns>
            <remarks>This API is used to initialize SDK. Please call this API before calling any other API</remarks>
        </member>
        <member name="M:Hik.Api.HikApi.NET_DVR_SetLogToFile(System.Int32,System.String,System.Boolean)">
            <summary>
            Enable log file writing interface
            </summary>
            <param name="bLogEnable">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</param>
            <param name="strLogDir">The path of the log file, the default value of windows is "C:\\SdkLog\\"; the default value of linux is "/home/sdklog/"</param>
            <param name="bAutoDel">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</param>
            <returns>Return TRUE on success, FALSE on failure. Please call NET_DVR_GetLastError to get the error code.</returns>
        </member>
        <member name="M:Hik.Api.HikApi.NET_DVR_Login_V30(System.String,System.Int32,System.String,System.String,Hik.Api.Struct.NET_DVR_DEVICEINFO_V30@)">
            <summary>
            This API is used to login user to the device.
            </summary>
            <param name="sDVRIP">device IP address</param>
            <param name="wDVRPort">device port number</param>
            <param name="sUserName">Login username</param>
            <param name="sPassword">password.</param>
            <param name="lpDeviceInfo">device information.</param>
            <returns>-1 indicates failure, other values indicate the returned user ID value</returns>
            <remarks>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.</remarks>
        </member>
        <member name="M:Hik.Api.HikApi.NET_DVR_Logout(System.Int32)">
            <summary>
            This API is used to logout certain user.
            </summary>
            <param name="iUserID">User ID, the return value of NET_DVR_Login_V30</param>
            <returns>TRUE means success, FALSE means failure</returns>
            <remarks>It is suggested to call this API to logout.</remarks>
        </member>
        <member name="M:Hik.Api.HikApi.NET_DVR_Cleanup">
            <summary>
            Release SDK resources, last call before the end
            </summary>
            <returns>TRUE means success, FALSE means failure</returns>
            <remarks>This API is used to release SDK resource. Please calling it before closing the program.</remarks>
        </member>
        <member name="M:Hik.Api.HikApi.NET_DVR_SetConnectTime(System.UInt32,System.UInt32)">
            <summary>
            Set the network connection timeout and the number of connection attempts
            </summary>
            <param name="dwWaitTime">Timeout,unit: ms, value range: [300,75000], the actual max timeout time is different with different system connecting timeout</param>
            <param name="dwTryTimes">Connecting attempt times (reserved)</param>
            <returns>Return TRUE on success, FALSE on failure. Please call NET_DVR_GetLastError to get the error code.</returns>
            <remarks>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.</remarks>
        </member>
        <member name="M:Hik.Api.HikApi.NET_DVR_SetReconnect(System.UInt32,System.Int32)">
            <summary>
            Set the reconnection function.
            </summary>
            <param name="dwInterval">Reconnecting interval, unit: milliseconds, default value:30 seconds</param>
            <param name="bEnableRecon">Enable or disable reconnect function, 0-disable, 1-enable(default)</param>
            <returns>Return TRUE on success, FALSE on failure. Please call NET_DVR_GetLastError to get the error code.</returns>
            <remarks>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.</remarks>
        </member>
        <member name="T:Hik.Api.HikException">
            <summary>
            Hik Exception
            </summary>
            <seealso cref="T:System.Exception" />
        </member>
        <member name="P:Hik.Api.HikException.ErrorMessage">
            <summary>
            Gets the error message.
            </summary>
            <value>
            The error message.
            </value>
        </member>
        <member name="M:Hik.Api.HikException.#ctor(System.String,System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:Hik.Api.HikException"/> class.
            </summary>
            <param name="method">The method.</param>
            <param name="error">The error.</param>
        </member>
        <member name="M:Hik.Api.HikException.ToString">
            <summary>
            Converts to string.
            </summary>
            <returns>
            A <see cref="T:System.String" /> that represents this instance.
            </returns>
        </member>
        <member name="M:Hik.Api.HikException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
            <summary>
            Initializes a new instance of the <see cref="T:Hik.Api.HikException"/> class.
            </summary>
            <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
            <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
        </member>
        <member name="T:Hik.Api.HikSDK">
            <summary>
            HikSDK
            </summary>
            <seealso cref="T:Hik.Api.Abstraction.IHikSDK" />
        </member>
        <member name="M:Hik.Api.HikSDK.Cleanup">
            <summary>
            Cleanups this instance.
            </summary>
        </member>
        <member name="M:Hik.Api.HikSDK.Initialize(System.Int32,System.String,System.Boolean,System.UInt32,System.UInt32,System.UInt32,System.Boolean)">
            <summary>
            Initializes this instance.
            </summary>
            <param name="logLevel">The log level.</param>
            <param name="logDirectory">The log directory.</param>
            <param name="autoDeleteLogs">if set to <c>true</c> [automatic delete logs].</param>
            <param name="waitTimeMilliseconds">The wait time milliseconds.</param>
            <param name="tryTimes">The try times.</param>
            <param name="reconnectInterval">The reconnect interval.</param>
            <param name="enableReconnect">if set to <c>true</c> [enable reconnect].</param>
        </member>
        <member name="M:Hik.Api.HikSDK.Login(System.String,System.Int32,System.String,System.String)">
            <summary>
            Logins the specified ip address.
            </summary>
            <param name="ipAddress">The ip address.</param>
            <param name="port">The port.</param>
            <param name="userName">Name of the user.</param>
            <param name="password">The password.</param>
            <returns></returns>
        </member>
        <member name="T:Hik.Api.Services.ConfigService">
            <summary>
            Config service
            </summary>
        </member>
        <member name="M:Hik.Api.Services.ConfigService.#ctor(Hik.Api.Abstraction.IHikApi)">
            <summary>
            Initializes a new instance of the <see cref="T:Hik.Api.Services.ConfigService"/> class.
            </summary>
            <param name="session">The session.</param>
        </member>
        <member name="M:Hik.Api.Services.ConfigService.GetTime(System.Int32)">
            <summary>
            Get device current time
            </summary>
            <param name="ipChannel">Default value 1</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Services.ConfigService.SetTime(System.DateTime,System.Int32)">
            <summary>
            Set device current time
            </summary>
            <param name="dateTime">The date time.</param>
            <param name="ipChannel">Default value -1</param>
        </member>
        <member name="M:Hik.Api.Services.ConfigService.GetDeviceConfig">
            <summary>
            Get device configuration information.
            </summary>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Services.ConfigService.GetNetworkConfig">
            <summary>
            Get device network information.
            </summary>
            <returns>
            Network information
            </returns>
        </member>
        <member name="M:Hik.Api.Services.ConfigService.GetHddStatus(System.Int32)">
            <summary>
            Get SD Card info, capacity, free space, status etc.
            </summary>
            <param name="ipChannel">Default value -1</param>
            <returns>HdInfo</returns>
        </member>
        <member name="M:Hik.Api.Services.ConfigService.NET_DVR_GetDVRConfig(System.Int32,System.UInt32,System.Int32,System.IntPtr,System.UInt32,System.UInt32@)">
            <summary>
            Get device configuration information.
            </summary>
            <param name="lUserID">Return value of login interface such as NET_DVR_Login_V40</param>
            <param name="dwCommand">[in] Channel number, different commands correspond to different values, if this parameter is invalid, set it to 0xFFFFFFFF, see "Remarks" for details.</param>
            <param name="lChannel"> Channel number, different commands correspond to different values, if this parameter is invalid, set it to 0xFFFFFFFF, see "Remarks" for details.</param>
            <param name="lpOutBuffer">[out] Buffer pointer for receiving data</param>
            <param name="dwOutBufferSize">[in] The buffer length of received data (in bytes), which cannot be 0</param>
            <param name="lpBytesReturned">[out] The actual received data length pointer, which cannot be NULL</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Services.ConfigService.NET_DVR_SetDVRConfig(System.Int32,System.UInt32,System.Int32,System.IntPtr,System.UInt32)">
            <summary>
            Set the configuration information of the device.
            </summary>
            <param name="lUserID">Return value of login interface such as NET_DVR_Login_V40</param>
            <param name="dwCommand">Device configuration command, see "Remarks" for details</param>
            <param name="lChannel">Channel number, different commands correspond to different values, if this parameter is invalid, set it to 0xFFFFFFFF, see "Remarks" for details</param>
            <param name="lpInBuffer">Buffer pointer for input data.</param>
            <param name="dwInBufferSize">The buffer length of the input data (in bytes)</param>
            <returns></returns>
            <remarks>Different acquisition functions correspond to different structures and command numbers</remarks>
        </member>
        <member name="T:Hik.Api.Services.FileService">
            <summary>
            Base class to download files
            </summary>
        </member>
        <member name="F:Hik.Api.Services.FileService.session">
            <summary>
            session
            </summary>
        </member>
        <member name="M:Hik.Api.Services.FileService.#ctor(Hik.Api.Abstraction.IHikApi)">
            <summary>
            Initializes a new instance of the <see cref="T:Hik.Api.Services.FileService"/> class.
            </summary>
            <param name="session">The session.</param>
        </member>
        <member name="M:Hik.Api.Services.FileService.FindFilesAsync(System.DateTime,System.DateTime)">
            <summary>
            Finds the files asynchronous.
            </summary>
            <param name="periodStart">The period start.</param>
            <param name="periodEnd">The period end.</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Services.FileService.FindFilesAsync(System.DateTime,System.DateTime,System.Int32)">
            <summary>
            Get files list for specific channel
            </summary>
            <param name="periodStart">The period start.</param>
            <param name="periodEnd">The period end.</param>
            <param name="ipChannel">The ip channel.</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Services.FileService.StartFind(System.DateTime,System.DateTime,System.Int32)">
            <summary>
            Starts the find.
            </summary>
            <param name="periodStart">The period start.</param>
            <param name="periodEnd">The period end.</param>
            <param name="channel">The channel.</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Services.FileService.StopFind(System.Int32)">
            <summary>
            Stops the find.
            </summary>
            <param name="findId">The find identifier.</param>
            <returns>Success</returns>
        </member>
        <member name="M:Hik.Api.Services.FileService.FindNext(System.Int32,Hik.Api.Abstraction.ISourceFile@)">
            <summary>
            Finds the next.
            </summary>
            <param name="findId">The find identifier.</param>
            <param name="source">The source.</param>
            <returns>Success</returns>
        </member>
        <member name="M:Hik.Api.Services.FileService.GetFindResults(System.Int32)">
            <summary>
            Gets the find results.
            </summary>
            <param name="findId">The find identifier.</param>
            <returns></returns>
        </member>
        <member name="T:Hik.Api.Services.PhotoService">
            <summary>
            Photo service
            </summary>
        </member>
        <member name="M:Hik.Api.Services.PhotoService.#ctor(Hik.Api.Abstraction.IHikApi)">
            <summary>
            Initializes a new instance of the <see cref="T:Hik.Api.Services.PhotoService"/> class.
            </summary>
            <param name="session">The session.</param>
        </member>
        <member name="M:Hik.Api.Services.PhotoService.DownloadFile(System.String,System.Int64,System.String)">
            <summary>
            Download File
            </summary>
            <param name="remoteFileName">remote file name</param>
            <param name="size">Remote file size</param>
            <param name="destinationPath">Save path</param>
        </member>
        <member name="M:Hik.Api.Services.PhotoService.DownloadFile(Hik.Api.Data.HikRemoteFile,System.String)">
            <summary>
            Download file
            </summary>
            <param name="photo">Hik remote file</param>
            <param name="destinationPath">Save path</param>
        </member>
        <member name="M:Hik.Api.Services.PhotoService.StopFind(System.Int32)">
            <summary>Stops the find.</summary>
            <param name="findId">The find identifier.</param>
            <returns>Success</returns>
        </member>
        <member name="M:Hik.Api.Services.PhotoService.StartFind(System.DateTime,System.DateTime,System.Int32)">
            <summary>Starts the find.</summary>
            <param name="periodStart">The period start.</param>
            <param name="periodEnd">The period end.</param>
            <param name="channel">The channel.</param>
            <returns>Find identifier</returns>
        </member>
        <member name="M:Hik.Api.Services.PhotoService.NET_DVR_FindPicture(System.Int32,Hik.Api.Struct.Photo.NET_DVR_FIND_PICTURE_PARAM@)">
            <summary>
            This API is used to get picture one by one.
            </summary>
            <param name="lUserID">[in] Handle of file searching, the return value of NET_DVR_FindPicture </param>
            <param name="pFindParam">Pointer for saving picture information </param>
            <returns>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.</returns>
            <remarks>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.</remarks>
        </member>
        <member name="M:Hik.Api.Services.PhotoService.NET_DVR_FindNextPicture_V50(System.Int32,Hik.Api.Struct.Photo.NET_DVR_FIND_PICTURE_V50@)">
            <summary>
            Get picture information one by one in search result.
            </summary>
            <param name="lFindHandle">[in] Handle of finding picture, the return value of NET_DVR_FindPicture </param>
            <param name="lpFindData">[out] Save compass for picture information. </param>
            <returns>Return -1 for failure, other values indicate the current getting status. When -1 is returned, callNET_DVR_GetLastError to get the error code.</returns>
            <remarks>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.</remarks>
        </member>
        <member name="M:Hik.Api.Services.PhotoService.NET_DVR_CloseFindPicture(System.Int32)">
            <summary>
            This API is used to close finding picture and release resource.
            </summary>
            <param name="lpFindHandle">[in] Handle of finding picture, the return value of NET_DVR_FindPicture </param>
            <returns>Returns TRUE on success, FALSE on failure. Please call NET_DVR_GetLastError to get the error code.</returns>
        </member>
        <member name="M:Hik.Api.Services.PhotoService.NET_DVR_GetPicture_V50(System.Int32,Hik.Api.Struct.Photo.NET_DVR_PIC_PARAM@)">
            <summary>
            This API is used to get picture data and save it in specified memory space.
            </summary>
            <param name="lUserID">User ID, the return value of NET_DVR_Login_V40 </param>
            <param name="lpPicParam">Return temporary file</param>
            <returns>Returns TRUE for success, and FALSE for failure. When FALSE is returned, call NET_DVR_GetLastError to get the error code.</returns>
        </member>
        <member name="M:Hik.Api.Services.PhotoService.NET_DVR_GetPicture(System.Int32,System.String,System.String)">
            <summary>
            Nets the DVR get picture.
            </summary>
            <param name="lUserID">User ID, the returned value of API NET_DVR_Login_V40 </param>
            <param name="sDVRFileName">in] Name of picture to download</param>
            <param name="sSavedFileName">[in] Saving path (including file name) for downloaded pictures</param>
            <returns>Return TRUE for success, and return FALSE for failure. If API returns FALSE, call NET_DVR_GetLastError to get error code.</returns>
            <remarks>The picture format is JPEG, and the postfix of file name is ".jpg".</remarks>
        </member>
        <member name="T:Hik.Api.Services.PlaybackService">
            <summary>
            Playback Service
            </summary>
        </member>
        <member name="M:Hik.Api.Services.PlaybackService.#ctor(Hik.Api.Abstraction.IHikApi)">
            <summary>
            Initializes a new instance of the <see cref="T:Hik.Api.Services.PlaybackService"/> class.
            </summary>
            <param name="session">The session.</param>
        </member>
        <member name="M:Hik.Api.Services.PlaybackService.StartPlayBack(System.Int32,System.Nullable{System.IntPtr})">
            <summary>
            Start live preview without callback, all receiver live data will be handled by PictureBox Handle
            </summary>
            <param name="channel">channel.</param>
            <param name="playbackWindowHandler">System.Windows.Forms.PictureBox Handle</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Services.PlaybackService.StopPlayBack(System.Int32)">
            <summary>
            Stop real-time preview
            </summary>
            <param name="playbackId">The playback identifier.</param>
            <returns>
            TRUE means success, FALSE means failure
            </returns>
        </member>
        <member name="M:Hik.Api.Services.PlaybackService.StartRecording(System.Int32,System.String,System.Int32)">
            <summary>
            Start recording live stream to filePath in .mp4 format
            </summary>
            <param name="playbackId">playback identifier.</param>
            <param name="filePath">file path.</param>
            <param name="channel">channel.</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Services.PlaybackService.StopRecording(System.Int32)">
            <summary>
            Stop recording live stream to filePath
            </summary>
            <param name="playbackId">The playback identifier.</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Services.PlaybackService.NET_DVR_MakeKeyFrame(System.Int32,System.Int32)">
            <summary>
            Make the main stream create a key frame(I frame)
            </summary>
            <param name="lUserID">The return value of NET_DVR_Login_V30</param>
            <param name="lChannel">Channel number.</param>
            <returns>Return TRUE on success, FALSE on failure. Please call NET_DVR_GetLastError to get the error code.</returns>
            <remarks>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.</remarks>
        </member>
        <member name="M:Hik.Api.Services.PlaybackService.NET_DVR_SaveRealData(System.Int32,System.String)">
            <summary>
            Capture data and save to assigned file
            </summary>
            <param name="lRealHandle">The return value of NET_DVR_RealPlay_V30</param>
            <param name="sFileName">Pointer of file path</param>
            <returns>Return TRUE on success, FALSE on failure. Please call NET_DVR_GetLastError to get the error code</returns>
        </member>
        <member name="M:Hik.Api.Services.PlaybackService.NET_DVR_StopSaveRealData(System.Int32)">
            <summary>
            Stop save real data.
            </summary>
            <param name="lRealHandle">The return value of NET_DVR_RealPlay_V30</param>
            <returns>Return TRUE on success, FALSE on failure. Please call NET_DVR_GetLastError to get the error code.</returns>
        </member>
        <member name="M:Hik.Api.Services.PlaybackService.NET_DVR_RealPlay_V40(System.Int32,Hik.Api.Struct.Video.NET_DVR_PREVIEWINFO@,Hik.Api.Services.PlaybackService.REALDATACALLBACK,System.IntPtr)">
            <summary>
            Real-time preview.
            </summary>
            <param name="iUserID">The return value of NET_DVR_Login() or NET_DVR_Login_V30()</param>
            <param name="lpPreviewInfo">Preview parameters</param>
            <param name="fRealDataCallBack_V30">code stream data callback function</param>
            <param name="pUser">User data</param>
            <returns>1 means failure, other values are used as handle parameters of functions such as NET_DVR_StopRealPlay</returns>
        </member>
        <member name="T:Hik.Api.Services.PlaybackService.REALDATACALLBACK">
            <summary>
            preview callback
            </summary>
            <param name="lRealHandle">The current preview handle</param>
            <param name="dwDataType"> data type</param>
            <param name="pBuffer">pointer to the buffer where the data is stored.</param>
            <param name="dwBufSize">buffer size.</param>
            <param name="pUser">user data</param>
        </member>
        <member name="M:Hik.Api.Services.PlaybackService.NET_DVR_StopRealPlay(System.Int32)">
            <summary>
            Stop real-time preview
            </summary>
            <param name="iRealHandle">real-time preview handle</param>
            <returns>TRUE means success, FALSE means failure</returns>
        </member>
        <member name="T:Hik.Api.Services.VideoService">
            <summary>
            Video service
            </summary>
        </member>
        <member name="M:Hik.Api.Services.VideoService.#ctor(Hik.Api.Abstraction.IHikApi)">
            <summary>
            Initializes a new instance of the <see cref="T:Hik.Api.Services.VideoService"/> class.
            </summary>
            <param name="session">The session.</param>
        </member>
        <member name="M:Hik.Api.Services.VideoService.StartDownloadFile(System.String,System.String)">
            <summary>
            Start download File
            </summary>
            <param name="sourceFile">Hik remote file name</param>
            <param name="destinationPath">Save path</param>
            <returns>Download handler</returns>
        </member>
        <member name="M:Hik.Api.Services.VideoService.StopDownloadFile(System.Int32)">
            <summary>
            Stop Download File
            </summary>
            <param name="fileHandle">Download handler</param>
        </member>
        <member name="M:Hik.Api.Services.VideoService.GetDownloadPosition(System.Int32)">
            <summary>
            Get the progress of the current download video file
            </summary>
            <param name="fileHandle">Download handler</param>
            <returns></returns>
        </member>
        <member name="M:Hik.Api.Services.VideoService.FindNext(System.Int32,Hik.Api.Abstraction.ISourceFile@)">
             <summary>
            Get the found file information one by one
             </summary>
             <param name="findId">The find identifier.</param>
             <param name="source">The source.</param>
             <returns>-1 means failure, and other values are used as parameters of functions such as NET_DVR_FindClose. </returns>
        </member>
        <member name="M:Hik.Api.Services.VideoService.StartFind(System.DateTime,System.DateTime,System.Int32)">
            <summary>Starts the find.</summary>
            <param name="periodStart">The period start.</param>
            <param name="periodEnd">The period end.</param>
            <param name="channel">The channel.</param>
            <returns>Download handler </returns>
        </member>
        <member name="M:Hik.Api.Services.VideoService.StopFind(System.Int32)">
            <summary>Close the file search and release resources.</summary>
            <param name="findId">The find identifier.</param>
            <returns>TRUE means success, FALSE means failure.</returns>
        </member>
        <member name="M:Hik.Api.Services.VideoService.NET_DVR_FindClose_V30(System.Int32)">
            <summary>
            This API is used to close file search and release the resource.
            </summary>
            <param name="lFindHandle">File search handle, return value of NET_DVR_FindFile_V40, NET_DVR_FindFileByEvent or NET_DVR_FindFile_V30</param>
            <returns>TRUE means success, FALSE means failure.</returns>
        </member>
        <member name="M:Hik.Api.Services.VideoService.NET_DVR_FindNextFile_V30(System.Int32,Hik.Api.Struct.Video.NET_DVR_FINDDATA_V30@)">
            <summary>
            Get the found file information one by one
            </summary>
            <param name="lFindHandle">File search handle, return value of NET_DVR_FindFile_V40 or NET_DVR_FindFile_V30</param>
            <param name="lpFindData">The pointer to save the file information</param>
            <returns>-1 indicates failure, and other values indicate the current acquisition status and other information. </returns>
            <remarks>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.</remarks>
        </member>
        <member name="M:Hik.Api.Services.VideoService.NET_DVR_FindFile_V40(System.Int32,Hik.Api.Struct.Video.NET_DVR_FILECOND_V40@)">
            <summary>
            Find device video files according to file type and time.
            </summary>
            <param name="lUserID">The return value of login interface such as NET_DVR_Login_V40</param>
            <param name="pFindCond">The file information structure to be found</param>
            <returns>-1 means failure, and other values are used as parameters of functions such as NET_DVR_FindClose. </returns>
            <remarks>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. </remarks>
        </member>
        <member name="M:Hik.Api.Services.VideoService.NET_DVR_GetFileByName(System.Int32,System.String,System.String)">
            <summary>
            Download video file by file name
            </summary>
            <param name="lUserID">The return value of NET_DVR_Login or NET_DVR_Login_V30</param>
            <param name="sDVRFileName">The name of the video file to be downloaded, the length of the file name must be less than 100 bytes. </param>
            <param name="sSavedFileName">The file path saved to the PC after downloading, must be an absolute path (including the file name). </param>
            <returns>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. </returns>
            <remarks>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. </remarks>
        </member>
        <member name="M:Hik.Api.Services.VideoService.NET_DVR_PlayBackControl_V40(System.Int32,System.UInt32,System.IntPtr,System.UInt32,System.IntPtr,System.UInt32@)">
            <summary>
            This API is used to control playback status.
            </summary>
            <param name="lPlayHandle">play handle, return value of NET_DVR_PlayBackByName, NET_DVR_PlayBackReverseByName or NET_DVR_PlayBackByTime_V40, NET_DVR_PlayBackReverseByTime_V40. </param>
            <param name="dwControlCode">Control video playback status command</param>
            <param name="lpInBuffer">Pointer to the input parameter</param>
            <param name="dwInValue">Input parameter length. Not used, reserved. </param>
            <param name="lpOutBuffer">Pointer to the output parameter</param>
            <param name="lPOutValue">The length of the output parameter</param>
            <returns>TRUE means success, FALSE means failure.</returns>
        </member>
        <member name="M:Hik.Api.Services.VideoService.NET_DVR_GetDownloadPos(System.Int32)">
            <summary>
            Get the progress of the current download video file
            </summary>
            <param name="lFileHandle">Download handle, return value of NET_DVR_GetFileByName, NET_DVR_GetFileByTime_V40 or NET_DVR_GetFileByTime </param>
            <returns>-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. </returns>
            <remarks>This interface is used to obtain the download progress when downloading video files by file name. </remarks>
        </member>
        <member name="M:Hik.Api.Services.VideoService.NET_DVR_StopGetFile(System.Int32)">
            <summary>
            This API is used to stop downloading record files.
            </summary>
            <param name="lFileHandle">Download handle, return value of NET_DVR_GetFileByName, NET_DVR_GetFileByTime_V40 or NET_DVR_GetFileByTime. </param>
            <returns>TRUE means success, FALSE means failure.</returns>
        </member>
    </members>
</doc>