Skip to main content

LibHikvision

PyPI Version

Python library to parse Hikvision datadirs that Hikvision IP cameras and DVRs store the videos. Using this class you can view details about recordings stored in a datadir and extract video and thumbnails.

Working Example

#!/usr/bin/python3

from libhikvision import libHikvision
from datetime import datetime
from datetime import timedelta

cameradir = '/var/tmp/hikvision/' # Can be a directory path or direct path to an index file (.bin)
hik = libHikvision(cameradir, 'video')

# Get information about the server
print(hik.getNASInfo())

# Extract the segments within a specific range of dates (and optionally filter by channel for DVRs)
# segments = hik.getSegments(
#    from_time=datetime(2023, 5, 5, 8, 0, 0),
#    to_time=datetime(2023, 5, 20, 23, 59, 00),
#    channel=8,
#)

# Extract last 3 Hours
segments = hik.getSegments(
    from_time=(datetime.now() - timedelta(hours=3)),
    to_time=(datetime.now()),
)

# Extract the Videos and Images from segments found above
for num, segment in enumerate(segments, start=0):
    print('{0:4}) {1[cust_filePath]:55} {1[cust_duration]:5} {1[startOffset]:10} {1[endOffset]:10}   {1[cust_startTime]} - {1[cust_endTime]}'.format(
        num,
        segment
    ))
    oDate = datetime.strptime("{0[cust_startTime]}".format(segment), '%Y-%m-%d %H:%M:%S')
    sDateFormated=oDate.strftime('%Y%m%d-%H%M%S')
    print(hik.extractSegmentMP4(num, cachePath='/var/tmp/', filename='/var/tmp/video-{0}.mp4'.format(sDateFormated)))
    print(hik.extractSegmentJPG(num, cachePath='/var/tmp/', filename='/var/tmp/video-{0}.jpg'.format(sDateFormated)))

You should also check the documentation of each method for extra options.

CLI Usage

libHikvision provides a command-line interface to inspect archives and extract videos/thumbnails directly from the terminal.

# List all segments in a directory or direct .bin file
libhikvision /path/to/cameradir
libhikvision /path/to/cameradir/INDEX00.bin

# Filter by channel and time range
libhikvision /path/to/cameradir -c 8 --from "2026-07-16 18:00:00" --to "2026-07-16 22:00:00"

# Print storage and header information (supports --json for scripting)
libhikvision /path/to/cameradir --info --header --json

# Extract specific segments to MP4 / JPG
libhikvision /path/to/cameradir -c 8 --extract-mp4 0,1,2 -o ./output/
libhikvision /path/to/cameradir -c 8 --extract-mp4 all -o ./output/
libhikvision /path/to/cameradir -c 8 --extract-jpg 0 -o ./output/

Credits

Based on Dave Hope's PHP code available at https://github.com/davehope/libHikvision

Metadata

Release files for libhikvision 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for libhikvision 0.4.0
File Size Uploaded
libhikvision-0.4.0.tar.gz 14.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for libhikvision 0.4.0
File Interpreter ABI Platform
libhikvision-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 28.4 kB

Release files / libhikvision-0.4.0.tar.gz

Download URL libhikvision-0.4.0.tar.gz
Size 14.3 kB
Tags Source
SHA-256 checksum
How to use checksums
df419df2f4b210bfb21571ca460db1961108ae31df7f3ac3f0877e1f943e00e5
BLAKE2b-256 checksum
How to use checksums
c77ce75beb8c21ceb9da475118bb5d059a82ece892db1c8ad949a691a41b2415
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / libhikvision-0.4.0-py3-none-any.whl

Download URL libhikvision-0.4.0-py3-none-any.whl
Size 14.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5a98f94e52948998e58799733626025493ac7caec642d0da2c32e62fbf06cf56
BLAKE2b-256 checksum
How to use checksums
4f22b2624114451fcc29949d5cf79a84776cb64be4fe90908c9efdda781900a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 release files

0.3.10

2 release files

0.3.9

2 release files

0.3.8

2 release files

0.3.7

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3

2 release files

0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page