milestonexprotectwspython.xpwrecorder

Module: xpwrecorder.py

Revision History

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

@export
class XPWRecorder:

Recording Server information.

Threadsafety:

This class is fully thread-safe.

XPWRecorder()

Initializes a new instance of the class.

Gets the Cameras property value.

Returns:

A collection of XPCamerInfo objects that contain camera device definitions.

DefaultRecordingTimeSeconds: int

Gets the DefaultRecordingTimeSeconds property value.

Returns:

The default amount of time (in seconds) of a recording.

Description: str

Gets the Description property value.

Returns:

A description of what the recording server provides.

Gets the Hardware property value.

Returns:

A collection of XPWHardware objects that are managed by the Recording server.

HostName: str

Gets the HostName property value.

Returns:

The computer name that hosts the recording server.

Gets the Inputs property value.

Returns:

A collection of XPWInput objects that contain Input device definitions.

LastModified: datetime.datetime

Gets the LastModified property value.

Returns:

The date and time the recording server was last modified, in UTC format.

Name: str

Gets the Name property value.

Returns:

A user-friendly name of the recording server.

Gets the MetadataDevices property value.

Returns:

A collection of XPWMetadataDevice objects that contain Metadata device definitions.

Gets the Microphones property value.

Returns:

A collection of XPWMicrophone objects that contain microphone device definitions.

Gets the Outputs property value.

Returns:

A collection of XPWOutput objects that contain Input device definitions.

RecorderId: str

Gets the RecorderId property value.

Returns:

The globally unique identifier of the recoring server.

ServiceId: str

Gets the ServiceId property value.

Returns:

The globally unique identifier of the recoring server service task.

Gets the Speakers property value.

Returns:

A collection of XPWSpeaker objects that contain speaker device definitions.

TimeZoneName: str

Gets the TimeZoneName property value.

Returns:

The time-zone name the recording server is running in.

WebServerUri: str

Gets the WebServerUri property value.

Returns:

The URI used to access web-services hosted by the recording server.

XmlEncoding: str

Gets the XmlEncoding property value.

Returns:

The supported XML encoding value (e.g. "utf-8", etc).