SkmXmlApi

Classes | Enumerations
SkmXmlApi Namespace Reference

Web API to VideoNEXT product. More...

## Classes
class | APICommand
| The abstract class for all Skm Api commands. All command objects should derive from this class More...
interface | ApiResponse
class | AuthorizationCommand
| Communicates with the Skm Api to get Urls for thumbnails and Rtsp streams More...
class | Camera
| Skm Camera represents an Skm camera object More...
class | CredentialCommand
| Retrieves available resources via the Skm's Credential Manager Api. Resources include cameras, audio devices, slave nodes, etc. Each resource includes user permissions and permission roles that are associated. More...
class | DownloadProgressEventArgs
| Media clip download progress event arguments. More...
class | DownloadTask
| Media clip download task descriptor. More...
class | Event
class | EventLog
class | GetObjectListResponse
class | IdentityAttributes
| Available global settings. More...
class | IdentityAttributesCommand
| A command for retrieving global settings. More...
class | MediaClipCommand
class | ObjectAttributes
| Available attributes of an object. More...
class | ObjectListItem
class | PanTiltZoomController
| Controls the Pan/Tilt/Zoom functions of a PTZ enabled camera More...
class | Resources
| A strongly-typed resource class, for looking up localized strings, etc.
class | SkmApiException
| General Skm exception More...
class | SkmAuthenticationException
| Exception occurs when authentication fails with the Skm server More...
class | SkmBase
| The base object for all Skm commands that use the Skm session More...
class | SkmObject
| An Skm resource object base class, such as a Camera or Audio or Ptz. All Skm resouce objects should inherit from this abstract class More...
class | SkmObjectList
| Generic collection to hold any SkmObject and subclasses of SkmObject More...
class | SkmPermissionList
| Collection of permissions associated to an SkmObject More...
class | SkmSession
| The SkmSession provides authentication keeps reference to the session on the Skm server. More...
class | SkmUser
| SkmUser object provides information for a Skm user More...
class | VersionInformationCommand
| Gets version information associated to the Skm server More...
class | WhoAmICommand
| A command to get current user ID. More...

## Enumerations
enum | EventLogAggregate { Events, Hours, Days, Months, Years }
enum | DownloadStatus { DownloadStatus.InProgress, DownloadStatus.Done, DownloadStatus.Error }
| Media clip download status. More...
enum | PanTiltStepDirection { Up, UpLeft, UpRight, Left, Right, DownLeft, DownRight, Down }
| Direction for PTZ to move at it's smallest increment. More...
enum | ZoomDirection { ZoomIn, ZoomOut }
| Direction for camera to zoom More...
enum | SkmPermissionType { SkmPermissionType.Live = 1, SkmPermissionType.Archive, SkmPermissionType.Control, SkmPermissionType.Ptz, SkmPermissionType.Setup }
| User permissions of an SkmObject More...
enum | SkmObjectType { SkmObjectType.None = 0, SkmObjectType.Camera, SkmObjectType.Audio, SkmObjectType.Node, SkmObjectType.Event }
| Defines a type of resource object More...

## Detailed Description

Web API to VideoNEXT product.

## Enumeration Type Documentation

## ◆ DownloadStatus

enum SkmXmlApi.DownloadStatus
| strong

Media clip download status.

Enumerator
InProgress | In progress
Done | Done
Error | Error

## ◆ PanTiltStepDirection

enum SkmXmlApi.PanTiltStepDirection
| strong

Direction for PTZ to move at it's smallest increment.

## ◆ SkmObjectType

enum SkmXmlApi.SkmObjectType
| strong

Defines a type of resource object

Enumerator
None | No SkmObject type
Camera | A camera or visual device
Audio | An audio type device
Node | A Skm server node
Event | Event

## ◆ SkmPermissionType

enum SkmXmlApi.SkmPermissionType
| strong

User permissions of an SkmObject

Enumerator
Live | The user can have access to data that is live.
Archive | The user can have access to data that has been recorded.
Control | Control the device
Ptz | The user has Ptz access to a device supporting Ptz abilities.
Setup | The user has the ability to change configuration of this device.

## ◆ ZoomDirection

enum SkmXmlApi.ZoomDirection
| strong

Direction for camera to zoom