VideoOS.Platform.ConfigurationItems.Camera Class Reference
Inheritance diagram for VideoOS.Platform.ConfigurationItems.Camera:
Public Member Functions | |
| Camera (FQID fqid) | |
| Construct the class from a MIP FQID - note that not all configuration items have a corresponding FQID. | |
| Camera (ServerId serverId, ConfigurationItem camera) | |
| Construct the class from serverId of the Management Server that owns the configuration, and the already returned ConfigurationItem. | |
| Camera (ServerId serverId, string path) | |
| Construct the class from serverId of the Management Server that owns the configuration, and the path of the item. | |
| ChangeDeviceRecordingStorageServerTask | ChangeDeviceRecordingStorage () |
| Change storage for device. | |
| ServerTask | ChangeDeviceRecordingStorage (String itemSelection, bool moveData) |
| Change storage for device. | |
| ChangeSecurityPermissionsServerTask | ChangeSecurityPermissions () |
| Edit permissions. | |
| ServerTask | ChangeSecurityPermissions (String userPath) |
| Edit permissions. | |
| ClassCollectionServerTask | GetOtherRecordingServersWithMedia () |
| Get recording servers with media. | |
| ClassCollectionServerTask | GetOtherRecordingStoragesWithMedia () |
| [DEPRECATED] This function is deprecated and should not be used. As an alternative, use the value of the 'RecordingStorage' property to get the configured recording storage for the device. | |
| ServerTask | GetPtzAbsolutePosition () |
| Get absolute position. | |
| ServerTask | JpegGetLive (int width, int height) |
| Get a single JPEG from live stream. | |
| RetrieveEdgeStorageServerTask | RetrieveEdgeStorage () |
| Retrieve recordings from edge storage. | |
| ServerTask | RetrieveEdgeStorage (DateTime startTime, DateTime endTime) |
| Retrieve recordings from edge storage. | |
| ServerTask | RetrieveEdgeStorage (DateTime startTime, DateTime endTime, String identifier, Collection< string > relatedTasks) |
| Retrieve recordings from edge storage. | |
| ServerTask | SendDriverCommand (string command, string parameter, int timeOut) |
| Send driver command to device. | |
| ServerTask | SetPtzAbsolutePosition (double pan, double tilt, double zoom, double speed, bool allowRepeats) |
| Set absolute position. | |
| ServerTask | TruncateStorage () |
| Delete all recordings for device on storage. | |
| TruncateStorageOnOtherRecordingServerServerTask | TruncateStorageOnOtherRecordingServer () |
| Delete all recordings for device on another recording server. | |
| ServerTask | TruncateStorageOnOtherRecordingServer (String itemSelection) |
| Delete all recordings for device on another recording server. | |
 Public Member Functions inherited from VideoOS.Platform.ConfigurationItems.IConfigurationItem | |
| void | ClearChildrenCache () |
| Clear the internal cache of children. Can be used to force a new set of children to be fetched from the server at next access. | |
| ServerTask | ExecuteMethod (string methodId) |
| Execute the provided method. The method id must be one of the defined values in the Methods property. | |
| void | FillChildren (string[] itemTypes) |
| Fill all children and grand-children - as long as the itemtype is contained in itemType parameter. | |
| void | FillChildren (string[] itemTypes, ItemFilter[] itemFilters) |
| Fill all children and grand-children - as long as the itemtype is contained in itemType parameter and filters match. If multiple filters are defined for same itemtype, all must match for the item to be included ('and' operation). If no filter is defined for an ItemType, then all items of that type is filled. | |
| void | Save () |
| Will save all updated values to server. | |
| ValidateResult | ValidateItem () |
| Validate the current content. | |
| Public Member Functions inherited from VideoOS.Platform.ConfigurationItems.IConfigurationChildItem | |
| string | GetProperty (string key) |
| Return a property value as string, if key is not found the return value will be null. | |
| ICollection< string > | GetPropertyKeys () |
| Get a collection of all available property keys. | |
| List< ValueTypeInfo > | GetValueTypeInfoList (string propertyKey) |
| Get defined ValueTypeInfo for a given property. If no ValueTypeInfo is available, an empty list is returned. | |
| void | SetProperty (string key, string content) |
| Sets the value of a property (all is string format here) | |
| override string | ToString () |
| Display the 'DisplayName' is the default ToString() | |
Properties | |
| int | Channel [get] |
| Channel. | |
| ClientSettingsFolder | ClientSettingsFolder [get] |
| Return the single folder item of the given ItemType. | |
| double | CoverageDepth [get, set] |
| Depth. Indicate the viewing depth of the device. | |
| double | CoverageDirection [get, set] |
| Direction. Indicate the viewing direction of the device. | |
| double | CoverageFieldOfView [get, set] |
| Field of view. Indicate the field of view of the device. | |
| DateTime | CreatedDate [get] |
| [RESERVED] Reserved for future use | |
| CustomPropertiesFolder | CustomPropertiesFolder [get] |
| Return the single folder item of the given ItemType. | |
| DeviceDriverSettingsFolder | DeviceDriverSettingsFolder [get] |
| Return the single folder item of the given ItemType. | |
| bool | EdgeStorageEnabled [get, set] |
| Remote recording enabled. | |
| bool | EdgeStoragePlaybackEnabled [get, set] |
| Remote recording playback. | |
| bool | Enabled [get, set] |
| Indicate if this item is active in the VMS system, e.g. enabled. | |
| String | FailoverSetting [get, set] |
| Failover setting. Specify how the device is operating on a failover recording server. . Valid values are available in the FailoverSettingValues property dictionary. | |
| Dictionary< string, string > | FailoverSettingValues [get] |
| A list of valid names/values for the FailoverSetting property. | |
| FisheyeLensFolder | FisheyeLensFolder [get] |
| Return the single folder item of the given ItemType. | |
| string | GisPoint [get, set] |
| Device position. Device position. Position of device in longitude, latitude and potentially altitude. The format is "POINT (LONGITUDE LATITUDE)" and if you want to clear the coordinates, the value to use is "POINT EMPTY". Examples: "POINT (55.656932878513 12.3763545558449)" "POINT EMPTY" Can also include altitude, if so the format is "POINT (LONGITUDE LATITUDE ALTITUDE)" | |
| HardwareDeviceEventFolder | HardwareDeviceEventFolder [get] |
| Return the single folder item of the given ItemType. | |
| int | Icon [get, set] |
| Icon identifier. The relevant device icon to show in Smart Map. Values between 0-9 for cameras, 0-6 for input devices, 0-3 for microphones and 0-3 for outputs. If invalid value is given, Smart Map have a fallback icon. | |
| string | Id [get] |
| ID. | |
| DateTime | LastModified [get] |
| Last modified. | |
| bool | ManualRecordingTimeoutEnabled [get, set] |
| Manual recording timeout enabled. | |
| int | ManualRecordingTimeoutMinutes [get, set] |
| Manual recording timeout in minutes. | |
| MotionDetectionFolder | MotionDetectionFolder [get] |
| Return the single folder item of the given ItemType. | |
| PatrollingProfileFolder | PatrollingProfileFolder [get] |
| Return the single folder item of the given ItemType. | |
| bool | PrebufferEnabled [get, set] |
| Prebuffer enabled. | |
| bool | PrebufferInMemory [get, set] |
| Prebuffer in memory. | |
| int | PrebufferSeconds [get, set] |
| Prebuffer seconds. | |
| PrivacyProtectionFolder | PrivacyProtectionFolder [get] |
| Return the single folder item of the given ItemType. | |
| bool | PtzEnabled [get] |
| PTZ enabled. | |
| PtzPresetFolder | PtzPresetFolder [get] |
| Return the single folder item of the given ItemType. | |
| bool | RecordingEnabled [get, set] |
| Recording enabled. | |
| double | RecordingFramerate [get, set] |
| Recording frame rate. | |
| String | RecordingStorage [get] |
| Path. Contains the path to the related recording storage. | |
| bool | RecordKeyframesOnly [get, set] |
| Record keyframes only. | |
| bool | RecordOnRelatedDevices [get, set] |
| Record on related devices. | |
| string | ShortName [get, set] |
| Short name. Used as name in the user interface where appropriate. | |
| ICollection< StreamChildItem > | StreamDefinitions [get] |
| Returns a collection that defines how each of the active streams are configured. The property collection contains the specific settings for the stream, like 'Codec', 'FPS', 'Resolution' and more for a camera stream. | |
| StreamFolder | StreamFolder [get] |
| Return the single folder item of the given ItemType. | |
| ICollection< StreamUsageChildItem > | StreamUsages [get] |
| Returns a collection that defines how each of the active streams are used, e.g. for live and/or recording. | |
| Properties inherited from VideoOS.Platform.ConfigurationItems.IConfigurationItem | |
| Guid | Guid [get] |
| Returns the id property or part of the path, when available. When no id is available this will be Guid.Empty. This is relevant for some items of ItemCategory.ChildItem where no property with key = "Id" exists and path does not contains a guid. | |
| Collection< string > | Methods [get] |
| The available methods for this class. | |
| Properties inherited from VideoOS.Platform.ConfigurationItems.IConfigurationChildItem | |
| string | Description [get, set] |
| Description. | |
| virtual string | DisplayName [get] |
| Name of this ConfigurationItem in user readable format. Usually the same as property with key = "Name". | |
| string | ItemCategory [get] |
| Return the item category for this item. This can be used to understand how multiple items are fetched and saved together. Only ItemCategory == 'Item' can be saved. | |
| string | Name [get, set] |
| Name. | |
| string | ParentItemPath [get] |
| Get hold of the next real parent path, e.g. skip any 'Folder' type parent. | |
| string | ParentPath [get] |
| The path for the parent of this ConfigurationItem. | |
| string | Path [get] |
| The identification of this item. | |
| ServerId | ServerId [get, set] |
| Contains the ServerId of the Management Server holding this item. | |
Detailed Description
Constructor & Destructor Documentation
◆ Camera() [1/3]
|
inline |
Construct the class from serverId of the Management Server that owns the configuration, and the already returned ConfigurationItem.
- Parameters
-
serverId Identify the Management Server that owns the configuration camera The ConfigurationItem returned from elsewhere
- Exceptions
-
ArgumentMIPException When LoginSettings not found for serverId
◆ Camera() [2/3]
|
inline |
Construct the class from serverId of the Management Server that owns the configuration, and the path of the item.
This construction will contact the server and read the specified item.
- Parameters
-
serverId Identify the Management Server that owns the configuration path The path of a specific item
- Exceptions
-
MIPException Represents a number of possible exceptions. Possible exceptions can be found via the inherited exceptions - like PathNotFoundMIPException
◆ Camera() [3/3]
|
inline |
Construct the class from a MIP FQID - note that not all configuration items have a corresponding FQID.
This construction will contact the server and read the specified item.
- Parameters
-
fqid Identify the MIP item
- Exceptions
-
MIPException Represents a number of possible exceptions. Possible exceptions can be found via the inherited exceptions - like PathNotFoundMIPException
Member Function Documentation
◆ ChangeDeviceRecordingStorage() [1/2]
|
inline |
Change storage for device.
◆ ChangeDeviceRecordingStorage() [2/2]
|
inline |
Change storage for device.
- Parameters
-
itemSelection Select a storage to move to moveData This property is deprecated and will be ignored.
◆ ChangeSecurityPermissions() [1/2]
|
inline |
Edit permissions.
◆ ChangeSecurityPermissions() [2/2]
|
inline |
◆ GetOtherRecordingServersWithMedia()
|
inline |
Get recording servers with media.
◆ GetOtherRecordingStoragesWithMedia()
|
inline |
[DEPRECATED] This function is deprecated and should not be used. As an alternative, use the value of the 'RecordingStorage' property to get the configured recording storage for the device.
◆ GetPtzAbsolutePosition()
|
inline |
Get absolute position.
◆ JpegGetLive()
|
inline |
Get a single JPEG from live stream.
- Parameters
-
width The maximum width of the image height The maximun height of the image
◆ RetrieveEdgeStorage() [1/3]
|
inline |
Retrieve recordings from edge storage.
◆ RetrieveEdgeStorage() [2/3]
|
inline |
Retrieve recordings from edge storage.
- Parameters
-
startTime Start time endTime End time
◆ RetrieveEdgeStorage() [3/3]
|
inline |
Retrieve recordings from edge storage.
- Parameters
-
startTime Start time endTime End time identifier Job identifier. Must be either empty or a valid GUID relatedTasks Related edge retrieval tasks. Identifiers of related edge retrieval tasks. Must be a list of valid GUIDs.
◆ SendDriverCommand()
|
inline |
Send driver command to device.
- Parameters
-
command The command to be send by the driver to the device, as a relative URI parameter The GET query string or POST data. Do not prepend the query string with ? timeOut Timeout in milliseconds. If 0 this is a fire and forget and the call will just return right away without waiting for a response
◆ SetPtzAbsolutePosition()
|
inline |
Set absolute position.
- Parameters
-
pan Pan value (between -1.0 and 1.0) tilt Tilt value (between -1.0 and 1.0) zoom Zoom value (between 0.0 and 1.0) speed Speed to use during movement (between 0.0 and 1.0) allowRepeats If false repeated requests with identical values will be ignored
◆ TruncateStorage()
|
inline |
Delete all recordings for device on storage.
◆ TruncateStorageOnOtherRecordingServer() [1/2]
|
inline |
Delete all recordings for device on another recording server.
◆ TruncateStorageOnOtherRecordingServer() [2/2]
|
inline |
Delete all recordings for device on another recording server.
- Parameters
-
itemSelection Select recording server
Property Documentation
◆ Channel
|
get |
Channel.
◆ ClientSettingsFolder
|
get |
Return the single folder item of the given ItemType.
◆ CoverageDepth
|
getset |
Depth. Indicate the viewing depth of the device.
◆ CoverageDirection
|
getset |
Direction. Indicate the viewing direction of the device.
◆ CoverageFieldOfView
|
getset |
Field of view. Indicate the field of view of the device.
◆ CreatedDate
|
get |
[RESERVED] Reserved for future use
◆ CustomPropertiesFolder
|
get |
Return the single folder item of the given ItemType.
◆ DeviceDriverSettingsFolder
|
get |
Return the single folder item of the given ItemType.
◆ EdgeStorageEnabled
|
getset |
Remote recording enabled.
◆ EdgeStoragePlaybackEnabled
|
getset |
Remote recording playback.
◆ Enabled
|
getset |
Indicate if this item is active in the VMS system, e.g. enabled.
◆ FailoverSetting
|
getset |
Failover setting. Specify how the device is operating on a failover recording server. . Valid values are available in the FailoverSettingValues property dictionary.
◆ FailoverSettingValues
|
get |
A list of valid names/values for the FailoverSetting property.
◆ FisheyeLensFolder
|
get |
Return the single folder item of the given ItemType.
◆ GisPoint
|
getset |
Device position. Device position. Position of device in longitude, latitude and potentially altitude.
The format is "POINT (LONGITUDE LATITUDE)" and if you want to clear the coordinates, the value to use is "POINT EMPTY".
Examples: "POINT (55.656932878513 12.3763545558449)" "POINT EMPTY"
Can also include altitude, if so the format is "POINT (LONGITUDE LATITUDE ALTITUDE)"
◆ HardwareDeviceEventFolder
|
get |
Return the single folder item of the given ItemType.
◆ Icon
|
getset |
Icon identifier. The relevant device icon to show in Smart Map. Values between 0-9 for cameras, 0-6 for input devices, 0-3 for microphones and 0-3 for outputs. If invalid value is given, Smart Map have a fallback icon.
◆ Id
|
get |
ID.
◆ LastModified
|
get |
Last modified.
◆ ManualRecordingTimeoutEnabled
|
getset |
Manual recording timeout enabled.
◆ ManualRecordingTimeoutMinutes
|
getset |
Manual recording timeout in minutes.
◆ MotionDetectionFolder
|
get |
Return the single folder item of the given ItemType.
◆ PatrollingProfileFolder
|
get |
Return the single folder item of the given ItemType.
◆ PrebufferEnabled
|
getset |
Prebuffer enabled.
◆ PrebufferInMemory
|
getset |
Prebuffer in memory.
◆ PrebufferSeconds
|
getset |
Prebuffer seconds.
◆ PrivacyProtectionFolder
|
get |
Return the single folder item of the given ItemType.
◆ PtzEnabled
|
get |
PTZ enabled.
◆ PtzPresetFolder
|
get |
Return the single folder item of the given ItemType.
◆ RecordingEnabled
|
getset |
Recording enabled.
◆ RecordingFramerate
|
getset |
Recording frame rate.
◆ RecordingStorage
|
get |
Path. Contains the path to the related recording storage.
◆ RecordKeyframesOnly
|
getset |
Record keyframes only.
◆ RecordOnRelatedDevices
|
getset |
Record on related devices.
◆ ShortName
|
getset |
Short name. Used as name in the user interface where appropriate.
◆ StreamDefinitions
|
get |
Returns a collection that defines how each of the active streams are configured. The property collection contains the specific settings for the stream, like 'Codec', 'FPS', 'Resolution' and more for a camera stream.
Please note that this should only be used for reading the settings. If you need to update them, you should go through the DeviceDriverSettingsFolder.
Replaces code like:
var streamDefinitions = camera.DeviceDriverSettingsFolder.DeviceDriverSettings.First().StreamChildItems; With
var streamDefinitions = myCamera.StreamDefinitions
◆ StreamFolder
|
get |
Return the single folder item of the given ItemType.
◆ StreamUsages
|
get |
Returns a collection that defines how each of the active streams are used, e.g. for live and/or recording.
Replaces code like:
var streamUsages = myCamera.StreamFolder.Streams?.FirstOrDefault()?.StreamUsageChildItems;
With
var streamUsages = myCamera.StreamUsages