APIs

Introduction

The vmspy API is organized into three main modules:

· live_video: Retrieves live images or streams from a specified channel.

· playback: Retrieves recorded images or streams from a specified time.

· utils: Provides utility functions such as retrieving channel lists, available recording times, and controlling PTZ presets.

Import and Initialize

After installing the library, import vmspy and initialize each module as shown below.

Initialization requires the server address, port, and access credentials (ID and password).

import vmspy  # type: ignore

# Live video
live_video = vmspy.live_video()
if not live_video.init(address, port, access_id, access_pw):
    print(live_video.get_error())

# Playback
playback = vmspy.playback()
if not playback.init(address, port, access_id, access_pw):
    print(playback.get_error())

# Utils
utils = vmspy.utils()
if not utils.init(address, port, access_id, access_pw):
    print(utils.get_error())