milestonexprotectrestpython.xprcamera

Module: xprcamera.py

Revision History

Date Version Description
2023/07/11 1.0.0.0 Initial Version.

Camera device information.

Threadsafety:

This class is fully thread-safe.

XPRCamera()

Initializes a new instance of the class.

EdgeStorageEnabled: bool

Determines if remote recording is enabled (True) or not (False).

Returns:

The EdgeStorageEnabled property value.

EdgeStoragePlaybackEnabled: bool

Determines if remote recording playback is enabled (True) or not (False).

Returns:

The EdgeStoragePlaybackEnabled property value.

ManualRecordingTimeoutEnabled: bool

Determines if manual recording timeout is enabled (True) or not (False).

Returns:

The ManualRecordingTimeoutEnabled property value.

ManualRecordingTimeoutMinutes: int

Number of minutes to automatically stop all manual recordings started by XProtect Smart Client users if manual recording timeout is enabled.

Returns:

The ManualRecordingTimeoutMinutes property value.

The number of minutes you specify must be sufficiently large enough to accommodate the requirements of the various manual recordings without overloading the system.

PrebufferEnabled: bool

Determines if pre-buffering is enabled (True) or not (False).

Returns:

The PrebufferEnabled property value.

Pre-buffering is the ability to record audio and video before the actual triggering event occurs.

PrebufferInMemory: bool

Determines if pre-buffering is stored in-memory (True) or onto disk storage (False).

Returns:

The PrebufferInMemory property value.

Storage to memory instead of to disk improves system performance, but is only possible for shorter pre-buffer periods (usually 15 seconds or less).

PrebufferSeconds: int

Number of seconds to automatically stop all manual recordings started by XProtect Smart Client users if manual recording timeout is enabled.

Returns:

The PrebufferSeconds property value.

The number of seconds you specify must be sufficiently large to accommodate your requirements in the various recording rules you define.

RecordingFramerate: int

Maximum number of frames per second (FPS) the device supports.

Returns:

The RecordingFramerate property value.

RecordKeyFramesOnly: bool

Determines if only keyframes will be recorded (True) or if ALL frames are recorded (False).

Returns:

The RecordKeyFramesOnly property value.

RecordOnRelatedDevices: bool

Determines if recording on related devices is enabled (True) or not (False).

Returns:

The RecordOnRelatedDevices property value.

RecordingEnabled: bool

Determines if recording is enabled (True) or not (False).

Returns:

The RecordingEnabled property value.

RecordingStorageId: str

The Storage identifier of where recordings are stored for this device.

Returns:

The RecordingStorageId property value.