Detailed Description

The EdgeVis Decoder SDK allows access to an EdgeVis Server.

SDK structure

The EdgeVis Decoder SDK is split up into various objects, the Server, Encoder and Media Streams.

Server Object

The Server object provides a connection to an Edgevis Server, this includes authentication and access to Encoder objects. The Server object has a listener IServerListener for state callbacks. You must create and connected to a server first.

Encoder Object

The Encoder object provides access to an Encoder. This gives access to the media stream for Video, Audio and GPS Data. The Encoder object allows for configuration and access to the Encoder settings.

Streams

Media Stream Component

The Media Stream Component is used to retrieve the stream from the Encoder. The media stream can include video, audio, and GPS Data.

PTZ Stream Component

The PTZ Stream Component is used to control PTZ (Pan, Zoom & Tilt) cameras attached to remote Encoders.

Pass Thru Stream Component

The Pass Thru Stream Component is used to send and receive free form data to an external device attached to a remote Encoder. This data is sent and received over the devices serial port

Full Resolution Service

The Full Resolution Service allows video frames cached local on the Encoder to be accessed to allow closer inspection of details within the image.

Other Components

Archive Service

The Archive Service allows recorded media to be played back from an archive device that is connected to an Encoder. It also allows files on the archive device to be exported at their original recorded quality.

CAMS Notifications

The Central Alarm Management System (CAMS) facilitates interactions with notifications stored at the Server. Notifications are generated as a consequence of server-side rule matching and have a state associated with them. The state may be changed by client and all other listening clients will receive the state change notification.

Accessing Encoder Settings

This component provides access to Encoder configuration settings, connection profile settings and camera information.

Threads

Care should be taken with the threading within the EdgeVis SDK.

Most calls into the SDK will block until the operation has been complete. Some of these calls may take several seconds to respond, especially on Server with a large amount of Encoders. Your applications must take this into account.
Callbacks from the SDK must not be blocked. Any processing resulting in a callback must be passed to a separate thread in your application and the callback complete as soon as possible
Callbacks from the SDK must not call back into the SDK on the same thread. Call back into the SDK on a separate thread.

Sample applications

Full sample applications are available demonstrating the capabilities of the SDK

See Sample applications

Types

The EdgevisDecoder SDK is built on C++ types. The method calls are the same across all platforms, however the types will be platform specific. The table below describes the different types each platform will use.

C++ (SDK)	C#	Java
wstring	string	String
string	string	String
bool	bool	boolean
double	double	double
uint8_t	byte	short
int8_t	byte	byte
int32_t	int	int
int64_t	long	long

Files
file	EdgeVisDecoderSDK.h
	Convenience header to include all EdgeVisDecoderSDK headers.

file	OpResult.h