milestonexprotectrestpython.xprrecordingserver

Module: xprrecordingserver.py

Revision History

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

@export
class XPRRecordingServer:

Recording Server information.

Threadsafety:

This class is fully thread-safe.

More information about recording server configuration can be found on the vendor documentation page.

XPRRecordingServer()

Initializes a new instance of the class.

ActiveWebServerUri: str

Public address of the recording server's web server over the internet.

Returns:

The ActiveWebServerUri property value.

DateModified: datetime.datetime

Date and time (in UTC format) that the recording server entry was last modified.

Returns:

The DateModified property value.

Description: str

A description of the recording server.

Returns:

The Description property value.

DisplayName: str

User-friendly display name used in various user-interface displays.

Returns:

The DisplayName property value.

Enabled: str

The Enabled status of the recording server - True if Enabled; otherwise False.

Returns:

The Enabled property value.

HostName: str

The recording server's host name.

Returns:

The HostName property value.

Id: str

The globally unique identifier of the recording server.

Returns:

The Id property value.

MulticastServerAddress: str

The multicast server address of the recording server.

Returns:

The MulticastServerAddress property value.

Name: str

Name of the recording server.

Returns:

The Name property value.

PortNumber: int

Port number to be used for handling web server requests, for example for handling PTZ camera control commands and for browse and live requests from XProtect Smart Client.
Default is port 7563.

Returns:

The PortNumber property value.

PublicAccessEnabled: str

Indicates if the recording server is publicly accessible (True) or private (False).

Returns:

The PublicAccessEnabled property value.

PublicWebserverHostName: bool

Recording server's public web server address.

Returns:

The PublicWebserverHostName property value.

PublicWebserverPort: int

Recording server's public web server port number.

Returns:

The PublicWebserverPort property value.

ShutdownOnStorageFailure: bool

Indicates if the recording server will be shut down automatically if a storage failure occurs (True) or not (False).

Returns:

The ShutdownOnStorageFailure property value.

SiteId: str

Globally unique identifier of the Site that defines this recording server.

Returns:

The SiteId property value.

SynchronizationTime: int

The SynchronizationTime property value.

Returns:

The SynchronizationTime property value.

TimeZoneName: str

Time zone that the recording server is located in.

Returns:

The TimeZoneName property value.

WebServerUri: str

Local address of the recording server's web server. You use the local address, for example, for handling PTZ camera control commands, and for handling browsing and live requests from XProtect Smart Client.

The address includes the port number that is used for web server communication (typically port 7563).

Returns:

The WebServerUri property value.