SDK API diff 7.1.0

Documenting the differences between SDK Release 6.7.0 and 7.1.0.

The 7.1.0 version of the Decoder SDK will now default to automatically caching server cluster information in a file. This behaviour can be disabled via a call to Server::SetClusterInfoCachingEnabled().

SDK 7.1.0 API diff

New classes

New analytics information

AnalyticsActorInfo.h

AnalyticsData.h

AnalyticsTypes.h

New user preferences update

EmailNotificationDetails.h

PhoneNotificationDetails.h

PushNotificationDetails.h

UserNotificationPreferences.h

New frame layout descriptions (Quad view and Picture in picture)

VideoFrameLayout.h

VideoFrameLayoutComponent.h

VideoFrameLayoutTypes.h

New server event listener (CAMS events and system events)

IServerEventListener.h

Updated classes

ArchiveExporterService.h

// Set and get target archive export bandwidth percentage
DB_EDGEVIS_SDK void SetTargetBandwidthPercentage(int bandwidthPercentage);
DB_EDGEVIS_SDK int GetTargetBandwidthPercentage();

ArchivePlaybackSpeed.h

// Updated enum for archive playback speed
typedef enum ArchivePlaybackSpeed;

ArchiveService.h

// Get archive playback speed
DB_EDGEVIS_SDK ArchivePlaybackSpeed GetPlaybackSpeed();

CameraInfo.h

// Is this input a virtual input (Quad, picture in picture)
DB_EDGEVIS_SDK bool IsVirtualInput() const;

// Are analytics enabled on this input
DB_EDGEVIS_SDK bool AnalyticsEnabled() const;

Encoder.h

// Get the feature information for this encoder
DB_EDGEVIS_SDK bool GetFeature(std::wstring featureName, FeatureInfo& feature);
DB_EDGEVIS_SDK int GetFeatureLicenceCount(std::wstring featureName);
DB_EDGEVIS_SDK int MaxSupportedHeight();

// Returns the URL for the configure encoder web page
DB_EDGEVIS_SDK std::wstring GetManagerURL();

// Monitors the bytes sent and received by this encoder
DB_EDGEVIS_SDK long long GetTotalBytesSent();
DB_EDGEVIS_SDK long long GetTotalBytesReceived();
DB_EDGEVIS_SDK void ResetDataUsageStats();

EncoderConfig.h

// Get and set the analytics on this encoder
DB_EDGEVIS_SDK AnalyticsInfo GetAnalyticsInfo() const;
DB_EDGEVIS_SDK bool SetAnalyticsInfo(const AnalyticsInfo& ai);

EncoderProfile.h

// Get frame values
DB_EDGEVIS_SDK std::vector<int> GetAvailableFrameStepValues();
DB_EDGEVIS_SDK std::vector<std::pair<int, int>> GetAvailableFrameSizeValues();

EncoderSettings.h

// Get layout of video frames
DB_EDGEVIS_SDK VideoFrameLayout GetVideoFrameLayout(int input);

FeatureInfo.h

//Get number of licences
int license_count;

// New features
ptz_goto_preset
view_stream
safezone_2d

IServerListener.h

// Server cluster has been updated
virtual void ServerClusterChanged(ServerAddresses serverAddresses) = 0;

MediaStream.h

// Set path smoothing for analytics
DB_EDGEVIS_SDK void SetEnablePathSmoothing(bool enable);
DB_EDGEVIS_SDK bool GetEnablePathSmoothing();

// Viewer timout methods
DB_EDGEVIS_SDK long long GetViewerTimeoutDuration() const;
DB_EDGEVIS_SDK long long GetViewerTimeRemaining() const;
DB_EDGEVIS_SDK void ResetViewerTimeout();

OpResult.h

// New op results
OR_AccountInUse           
OR_IncompatibleVersion      
OR_FileAlreadyExported    
OR_TooManyRules             
OR_TooManyActions            

SensorInfo.h

// RDC sensor node trigger status
DB_EDGEVIS_SDK bool IsTrigger1Enabled() const;
DB_EDGEVIS_SDK bool IsTrigger2Enabled() const;

Server.h

// New call to enable or disable automatic server cluster info caching
DB_EDGEVIS_SDK void SetClusterInfoCachingEnabled(bool enabled);

// New server query calls
DB_EDGEVIS_SDK ServerInfo QueryServerInfo( const ServerAddresses& hostAddresses, bool secure = false );
DB_EDGEVIS_SDK OpResult ValidateCredentials( const ServerAddresses& hostAddresses,const std::wstring& username,const std::wstring& password,const std::wstring& new_password,ServerAddresses& availableAddresses);
DB_EDGEVIS_SDK OpResult GetEncoders(EncodersList &result);

// New user config methods
DB_EDGEVIS_SDK bool SupportsUserConfig();
DB_EDGEVIS_SDK OpResult GetUserConfig(UserNotificationPreferences& user_config);
DB_EDGEVIS_SDK OpResult SetUserConfig(UserNotificationPreferences& user_config);

// Does this server support the new configure web service
DB_EDGEVIS_SDK bool SupportsEncoderManagerURLs() const;

DB_EDGEVIS_SDK std::wstring UserName() const;

DB_EDGEVIS_SDK long long GetServerClockOffset() const;

// Data monitoring methods
DB_EDGEVIS_SDK long long GetTotalBytesSent();
DB_EDGEVIS_SDK long long GetTotalBytesReceived();
DB_EDGEVIS_SDK void ResetDataUsageStats();

Stream.h

// Data monitoring methods
DB_EDGEVIS_SDK long long GetTotalBytesSent();
DB_EDGEVIS_SDK long long GetTotalBytesReceived();
DB_EDGEVIS_SDK void ResetDataUsageStats();

YCbCrFrame.h

// Returns when this stream will timeout
DB_EDGEVIS_SDK long long GetViewerTimeoutTimeStamp() const;

// Returns the archice playback state
DB_EDGEVIS_SDK ArchivePlaybackSpeed GetArchivePlaybackSpeed() const;

// Returns the video frame layout
DB_EDGEVIS_SDK VideoFrameLayout GetVideoFrameLayout() const;