SDKSampleApp.Enums Namespace Reference

Enumerations
enum	VxResult {   VxResult.UnknownError,   VxResult.Ok,   VxResult.UnsupportedVersion,   VxResult.InvalidHandle,   VxResult.InsufficientSize,   VxResult.InvalidLoginInfo }
	The VxResult enumeration. More...
enum	VxAckState {   VxAckState.Unknown,   VxAckState.AckNeeded,   VxAckState.Acked,   VxAckState.AutoAcked,   VxAckState.NoAckNeeded,   VxAckState.Silenced }
	The VxAckState enumeration. More...
enum	VxDeviceState {   VxDeviceState.Unknown,   VxDeviceState.Offline,   VxDeviceState.Online }
	The VxDeviceState enumeration. More...
enum	VxDeviceType {   VxDeviceType.Camera,   VxDeviceType.Core,   VxDeviceType.CoreMg,   VxDeviceType.Decoder,   VxDeviceType.Encoder,   VxDeviceType.External,   VxDeviceType.Manager,   VxDeviceType.Mg,   VxDeviceType.Monitor,   VxDeviceType.Recorder,   VxDeviceType.Udi,   VxDeviceType.Ui,   VxDeviceType.Unknown,   VxDeviceType.Vcd }
	The VxDeviceType enumeration. More...
enum	VxDataSourceType {   VxDataSourceType.Unknown,   VxDataSourceType.Video,   VxDataSourceType.Audio }
	The VxDataSourceType enumeration. More...
enum	VxStreamProtocol {   VxStreamProtocol.Unknown,   VxStreamProtocol.MjpegPull,   VxStreamProtocol.RtspRtp }
	The VxStreamProtocol enumeration. More...
enum	VxRecordType {   VxRecordType.Unknown,   VxRecordType.Alarm,   VxRecordType.Analytic,   VxRecordType.Event,   VxRecordType.Manual,   VxRecordType.Motion,   VxRecordType.Timed }
	The VxRecordType enumeration. More...
enum	VxRecordFramerate {   VxRecordFramerate.Unknown,   VxRecordFramerate.Low,   VxRecordFramerate.Normal }
	The VxRecordFramerate enumeration. More...
enum	VxRetentionPriority {   VxRetentionPriority.Unknown,   VxRetentionPriority.Low,   VxRetentionPriority.Medium,   VxRetentionPriority.High }
	The VxRetentionPriority enumeration. More...

Enumeration Type Documentation

enum SDKSampleApp.Enums.VxAckState

strong

The VxAckState enumeration.

The acknowledgement state of an event.

Enumerator
Unknown	An error or unknown value was returned.
AckNeeded	Event acknowledgement is needed.
Acked	Event is acknowledged.
AutoAcked	Event is auto-acknowledged.
NoAckNeeded	No event acknowledgement is needed.
Silenced	The event has been silenced.

Definition at line 32 of file Enums.cs.

    {
        Unknown,

        AckNeeded,

        Acked,

        AutoAcked,

        NoAckNeeded,

        Silenced
    }

enum SDKSampleApp.Enums.VxDataSourceType

strong

The VxDataSourceType enumeration.

The particular type of a data source.

Enumerator
Unknown	An error or unknown value was returned.
Video	A video data source.
Audio	An audio data source.

Definition at line 122 of file Enums.cs.

    {
        Unknown,

        Video,

        Audio
    }

enum SDKSampleApp.Enums.VxDeviceState

strong

The VxDeviceState enumeration.

The operational state of a device.

Enumerator
Unknown	An error or unknown value was returned.
Offline	The device is offline.
Online	The device is online.

Definition at line 57 of file Enums.cs.

    {
        Unknown,

        Offline,

        Online
    }

enum SDKSampleApp.Enums.VxDeviceType

strong

The VxDeviceType enumeration.

The particular type of a device.

Enumerator
Camera	A camera device.
Core	A VideoXpert Core device.
CoreMg	A VideoXpert Core/MediaGateway device.
Decoder	A decoder device.
Encoder	An encoder device.
External	An external device.
Manager	A system manager device.
Mg	A VideoXpert MediaGateway device.
Monitor	A monitor device.
Recorder	A network storage device.
Udi	A UDI device.
Ui	A UI device.
Unknown	An error or unknown value was returned.
Vcd	A VCD device.

Definition at line 73 of file Enums.cs.

    {
        Camera,

        Core,

        CoreMg,

        Decoder,

        Encoder,

        External,

        Manager,

        Mg,

        Monitor,

        Recorder,

        Udi,

        Ui,

        Unknown,

        Vcd
    }

enum SDKSampleApp.Enums.VxRecordFramerate

strong

The VxRecordFramerate enumeration.

The video framerate level.

Enumerator
Unknown	An error or unknown value was returned.
Low	Low framerate.
Normal	Normal framerate.

Definition at line 182 of file Enums.cs.

    {
        Unknown,

        Low,

        Normal
    }

enum SDKSampleApp.Enums.VxRecordType

strong

The VxRecordType enumeration.

The type of trigger that caused the recording.

Enumerator
Unknown	An error or unknown value was returned.
Alarm	Hardware or software alarm.
Analytic	Video analytic (non-motion).
Event	General system event.
Manual	Manual user initiation.
Motion	Motion analytic.
Timed	Time-based (continuous); no event.

Definition at line 154 of file Enums.cs.

    {
        Unknown,

        Alarm,

        Analytic,

        Event,

        Manual,

        Motion,

        Timed
    }

enum SDKSampleApp.Enums.VxResult

strong

The VxResult enumeration.

The result of an executed method.

Enumerator
UnknownError	Unknown error occurred.
Ok	No errors occurred.
UnsupportedVersion	Received an unsupported version error from the system.
InvalidHandle	An invalid handle was given.
InsufficientSize	The size value was insufficient.
InvalidLoginInfo	Login info is invalid for the selected system.

Definition at line 7 of file Enums.cs.

    {
        UnknownError,

        Ok,

        UnsupportedVersion,

        InvalidHandle,

        InsufficientSize,

        InvalidLoginInfo
    }

enum SDKSampleApp.Enums.VxRetentionPriority

strong

The VxRetentionPriority enumeration.

Indicates how long the recording device should attempt to retain the clip.

Enumerator
Unknown	An error or unknown value was returned.
Low	Low retention priority.
Medium	Medium retention priority.
High	High retention priority.

Definition at line 198 of file Enums.cs.

    {
        Unknown,

        Low,

        Medium,

        High
    }

enum SDKSampleApp.Enums.VxStreamProtocol

strong

The VxStreamProtocol enumeration.

The stream interface protocol.

Enumerator
Unknown	An error or unknown value was returned.
MjpegPull	An Mjpeg (pull) protocol interface.
RtspRtp	An RTSP/RTP protocol interface.

Definition at line 138 of file Enums.cs.

    {
        Unknown,

        MjpegPull,

        RtspRtp
    }