VideoXpert SDK  2.0
A software development kit for third party vendors to integrate with the VideoXpert platform
VxSdk::VxResult Struct Reference

Values that represent the result of calls to the VideoXpert system. More...

#include <VxPrimitives.h>

Public Types

enum  Value {
  kUnknownError,
  kOK,
  kUnsupportedVersion,
  kInsufficientSize,
  kInvalidLoginInfo,
  kActionUnavailable,
  kInvalidParameters,
  kCommunicationError,
  kInvalidLicense,
  kCameraUnavailable,
  kEdgeOfStream,
  kEndOfStream,
  kNoAvailableStreams,
  kStorageUnavailable,
  kExportDataUnretrievable,
  kExportStorageFull,
  kExportStorageUnauthenticated,
  kExportStorageUnavailable,
  kConflict,
  kInsufficientResources,
  kNotReady,
  kNotReadyUnauthenticated,
  kNotReadyUnauthorized,
  kOperationFailed,
  kResponseTooLarge,
  kActivationConflict,
  kActivationHostNotFound,
  kActivationFailed,
  kIncompatibleLicense,
  kLicenseCountExceeded,
  kLicenseRequired,
  kLicenseReqLdapAdmin,
  kNoLicense,
  kCameraInUse,
  kCameraLocked,
  kNeedOverride,
  kInvalidValue,
  kPortInUse,
  kReadOnlyField,
  kResourceLocked,
  kAuthExpired,
  kPasswordReqMoreDigits,
  kPasswordReqMoreLower,
  kPasswordReqMoreSpecial,
  kPasswordReqMoreUpper,
  kPasswordTooShort,
  kPasswordTooSimilar,
  kPermissionConflict,
  kUnauthenticated,
  kUnauthorized
}
 

Detailed Description

Values that represent the result of calls to the VideoXpert system.

Definition at line 691 of file VxPrimitives.h.

Member Enumeration Documentation

Enumerator
kUnknownError 

An error or unknown value was returned.

kOK 

The action was successful.

kUnsupportedVersion 

The VideoXpert system version is not supported.

kInsufficientSize 

The size value was not sufficient enough to allocate the collection.

kInvalidLoginInfo 

The login credentials were invalid.

kActionUnavailable 

The attempted action is unsupported by the system.

kInvalidParameters 

A parameter was invalid.

kCommunicationError 

There was an error communicating to the device.

kInvalidLicense 

No valid license was found on the VideoXpert system.

kCameraUnavailable 

Camera is unavailable, data cannot be retrieved at this time.

kEdgeOfStream 

No further stream data is currently available (the edge of a currently recording clip has been reached); more data will be available shortly.

kEndOfStream 

No further stream data is available (the end of all recorded data has been reached; no further data is currently be recorded).

kNoAvailableStreams 

The server is unable to initiate any new stream sessions due to having reached its stream count capacity.

kStorageUnavailable 

Storage is unavailable, data cannot be retrieved at this time.

kExportDataUnretrievable 

The data needed to perform the export operation can not be retrieved.

kExportStorageFull 

The export storage location does not have enough free space to store the export.

kExportStorageUnauthenticated 

The export storage location is not accessible due to invalid credentials.

kExportStorageUnavailable 

The export storage location is not accessible; this may be due to an invalid location, network issue, or storage issue.

kConflict 

The requested operation is not possible due to a conflict with the resource. Typically this is due to a violation of a uniqueness property on one of the resource’s fields.

kInsufficientResources 

The server has insufficient resources to satisfy the request.

kNotReady 

The server is not in an appropriate state to be able to service this request. The server requires intervention in order to resolve this.

kNotReadyUnauthenticated 

The server is not in an appropriate state to be able to service this request due to an authentication issue between it and another entity. The server requires intervention in order to resolve this.

kNotReadyUnauthorized 

The server is not in an appropriate state to be able to service this request due to an authorization issue between it and another entity. The server requires intervention in order to resolve this.

kOperationFailed 

The requested operation failed.

kResponseTooLarge 

The server is incapable of handling the client request due to the size of the resulting response.What constitutes ’too large’ is entirely up to the server.

kActivationConflict 

The license that was supplied has an activation conflict with an existing license(e.g.duplicate activation IDs).

kActivationHostNotFound 

The activation failed due to communication error with the FNO licensing server.

kActivationFailed 

The activation failed.

kIncompatibleLicense 

The license that was supplied is not compatible with the device and/or system that it is being applied to.

kLicenseCountExceeded 

A valid license is available but the available count on that license is fully utilized.

kLicenseRequired 

A valid license is required to utilize this method on the resource; no valid license found.

kLicenseReqLdapAdmin 

Unable to apply the license; valid LDAP administrator credentials are required.

kNoLicense 

Unable to commission (or float) a feature because no valid license is available for it.

kCameraInUse 

Camera is in use (or the usage dwell time is active) by same or higher authority user.

kCameraLocked 

Camera is locked by same or higher authority user.

kNeedOverride 

Locked by lower authority user, may override.

kInvalidValue 

An attempt to set an invalid value on a writable field was made. The value may be invalid due to being out of range, unavailable, etc.

kPortInUse 

An attempt to set a new port number failed because the port number is already in use.

kReadOnlyField 

An attempt to edit a read-only field was made.

kResourceLocked 

An attempt to edit a locked resource was made by a user that does not own the IVxResourceLock.

kAuthExpired 

A request was made using expired authentication credentials.

kPasswordReqMoreDigits 

A password with an insufficient number of digits was supplied in an attempt to create a new user password.

kPasswordReqMoreLower 

A password with an insufficient number of lowercase letters was supplied in an attempt to create a new user password.

kPasswordReqMoreSpecial 

A password with an insufficient number of special characters was supplied in an attempt to create a new user password.

kPasswordReqMoreUpper 

A password with an insufficient number of uppercase letters was supplied in an attempt to create a new user password.

kPasswordTooShort 

A password of insufficient length was supplied in an attempt to create a new user password.

kPasswordTooSimilar 

A password too similar to a previous password was supplied in an attempt to create a new user password.

kPermissionConflict 

The requested operation is not possible due to a permission conflict with the resource.Typically this is due to a violation of permission hierarchy (e.g. a nested permission is being assigned without its parent permission already assigned).

kUnauthenticated 

An unauthenticated request was made (i.e. invalid username and/or password).

kUnauthorized 

An unauthorized request was made (i.e. user does not have permission to access the resource).

Definition at line 692 of file VxPrimitives.h.

692  {
696  kOK,
720  kEndOfStream,
737  kConflict,
743  kNotReady,
776  kNoLicense,
778  kCameraInUse,
788  kPortInUse,
794  kAuthExpired,
816  };
A password with an insufficient number of digits was supplied in an attempt to create a new user pass...
Definition: VxPrimitives.h:796
A password with an insufficient number of special characters was supplied in an attempt to create a n...
Definition: VxPrimitives.h:800
The login credentials were invalid.
Definition: VxPrimitives.h:702
A valid license is available but the available count on that license is fully utilized.
Definition: VxPrimitives.h:770
The export storage location does not have enough free space to store the export.
Definition: VxPrimitives.h:728
The data needed to perform the export operation can not be retrieved.
Definition: VxPrimitives.h:726
No further stream data is available (the end of all recorded data has been reached; no further data i...
Definition: VxPrimitives.h:720
The requested operation failed.
Definition: VxPrimitives.h:755
An attempt to edit a locked resource was made by a user that does not own the IVxResourceLock.
Definition: VxPrimitives.h:792
The server is incapable of handling the client request due to the size of the resulting response...
Definition: VxPrimitives.h:760
The action was successful.
Definition: VxPrimitives.h:696
The export storage location is not accessible due to invalid credentials.
Definition: VxPrimitives.h:730
The license that was supplied has an activation conflict with an existing license(e.g.duplicate activation IDs).
Definition: VxPrimitives.h:762
The VideoXpert system version is not supported.
Definition: VxPrimitives.h:698
The requested operation is not possible due to a permission conflict with the resource.Typically this is due to a violation of permission hierarchy (e.g. a nested permission is being assigned without its parent permission already assigned).
Definition: VxPrimitives.h:811
Camera is unavailable, data cannot be retrieved at this time.
Definition: VxPrimitives.h:712
No further stream data is currently available (the edge of a currently recording clip has been reache...
Definition: VxPrimitives.h:716
Locked by lower authority user, may override.
Definition: VxPrimitives.h:782
No valid license was found on the VideoXpert system.
Definition: VxPrimitives.h:710
Storage is unavailable, data cannot be retrieved at this time.
Definition: VxPrimitives.h:724
The server is not in an appropriate state to be able to service this request due to an authorization ...
Definition: VxPrimitives.h:753
A parameter was invalid.
Definition: VxPrimitives.h:706
A password with an insufficient number of uppercase letters was supplied in an attempt to create a ne...
Definition: VxPrimitives.h:802
The export storage location is not accessible; this may be due to an invalid location, network issue, or storage issue.
Definition: VxPrimitives.h:732
An unauthenticated request was made (i.e. invalid username and/or password).
Definition: VxPrimitives.h:813
The attempted action is unsupported by the system.
Definition: VxPrimitives.h:704
The server is not in an appropriate state to be able to service this request. The server requires int...
Definition: VxPrimitives.h:743
A valid license is required to utilize this method on the resource; no valid license found...
Definition: VxPrimitives.h:772
Camera is in use (or the usage dwell time is active) by same or higher authority user.
Definition: VxPrimitives.h:778
An unauthorized request was made (i.e. user does not have permission to access the resource)...
Definition: VxPrimitives.h:815
Camera is locked by same or higher authority user.
Definition: VxPrimitives.h:780
The activation failed due to communication error with the FNO licensing server.
Definition: VxPrimitives.h:764
The server is not in an appropriate state to be able to service this request due to an authentication...
Definition: VxPrimitives.h:748
There was an error communicating to the device.
Definition: VxPrimitives.h:708
A password of insufficient length was supplied in an attempt to create a new user password...
Definition: VxPrimitives.h:804
An attempt to set a new port number failed because the port number is already in use.
Definition: VxPrimitives.h:788
The server is unable to initiate any new stream sessions due to having reached its stream count capac...
Definition: VxPrimitives.h:722
The license that was supplied is not compatible with the device and/or system that it is being applie...
Definition: VxPrimitives.h:768
An error or unknown value was returned.
Definition: VxPrimitives.h:694
A password too similar to a previous password was supplied in an attempt to create a new user passwor...
Definition: VxPrimitives.h:806
Unable to apply the license; valid LDAP administrator credentials are required.
Definition: VxPrimitives.h:774
The requested operation is not possible due to a conflict with the resource. Typically this is due to...
Definition: VxPrimitives.h:737
A password with an insufficient number of lowercase letters was supplied in an attempt to create a ne...
Definition: VxPrimitives.h:798
An attempt to set an invalid value on a writable field was made. The value may be invalid due to bein...
Definition: VxPrimitives.h:786
A request was made using expired authentication credentials.
Definition: VxPrimitives.h:794
An attempt to edit a read-only field was made.
Definition: VxPrimitives.h:790
The server has insufficient resources to satisfy the request.
Definition: VxPrimitives.h:739
The size value was not sufficient enough to allocate the collection.
Definition: VxPrimitives.h:700
Unable to commission (or float) a feature because no valid license is available for it...
Definition: VxPrimitives.h:776

The documentation for this struct was generated from the following file: