Detailed Description

A Server interface is used to make a connection to an EdgeVis server.

The Server object is the starting point for management of the EdgeVis server and using Encoder features.

Note: To connect securley to an EdgeVis Server a crypto variant of the Decoder SDK is required. Contact Digital Barriers for more assitance.

See Server for more info

Availability

Available in version 6.0 of Decoder SDK. Requires a server version greater than 6.0

#include <Server.h>

Public Member Functions
DB_EDGEVIS_SDK	Server (const std::wstring &appName, const std::wstring &appMetadata)
	Constructor for the Server object. More...

DB_EDGEVIS_SDK void	SetClusterInfoCachingEnabled (bool enabled)
	Enables or disables automatic caching of the server cluster token in a file managed by the SDK. More...

DB_EDGEVIS_SDK OpResult	Connect (const ServerAddresses &hostAddresses, const std::wstring &username, const std::wstring &password, const std::wstring &new_password, ServerAddresses &availableAddresses, ConnectionStrategy connect_strategy, ServerConnectInfo flags=SCI_ASPECT_CORRECT)
	Connects to an EdgeVis server. More...

DB_EDGEVIS_SDK OpResult	Connect (const ServerAddresses &hostAddresses, const Credentials credentials, ServerAddresses &availableAddresses, ConnectionStrategy connect_strategy, ServerConnectInfo flags=SCI_ASPECT_CORRECT)
	Connects to an EdgeVis server. More...

DB_EDGEVIS_SDK OpResult	Connect (const ServerAddresses &hostAddresses, const Credentials credentials, ServerAddresses &availableAddresses)
	Connects to an EdgeVis server. More...

DB_EDGEVIS_SDK PasswordResetInfo	GetPasswordResetInfo () const
	If a users password must be reset then the limitation for the password can be retrieved and used to ensure the user enters a correct password. More...

DB_EDGEVIS_SDK MFALoginResponse	GetMFALoginResponse () const
	Retrieve the multiple factor login response. More...

DB_EDGEVIS_SDK std::wstring	GetDevicePassword () const
	Retrieve a device password to use when logging in. More...

DB_EDGEVIS_SDK bool	HasCams () const
	Check if this server supports CAMS notifications. More...

DB_EDGEVIS_SDK bool	SupportsClientCamsRuleBuilder () const
	Check if this server supports CAMS rule builder in client applications. More...

DB_EDGEVIS_SDK ServerInfo	QueryServerInfo (const ServerAddresses &hostAddresses)
	Queries the server to obtain its current information. More...

DB_EDGEVIS_SDK OpResult	ValidateCredentials (const ServerAddresses &hostAddresses, const Credentials &credentials, ServerAddresses &availableAddresses)
	Test that the supplied credentials are valid for the given server. More...

DB_EDGEVIS_SDK OpResult	ValidateCredentials (const ServerAddresses &hostAddresses, const std::wstring &username, const std::wstring &password, const std::wstring &new_password, ServerAddresses &availableAddresses)
	Test that the supplied username and password are valid for the given server. More...

DB_EDGEVIS_SDK void	CancelQueryServerInfo ()
	Cancels the query for the ServerInfo. More...

DB_EDGEVIS_SDK void	CancelValidateCredentials ()
	Cancels the query for the Validate Credentials. More...

DB_EDGEVIS_SDK CamsNotificationManager	GetCamsNotificationManager ()
	Retrieve the CAMS notification manager for this server. More...

DB_EDGEVIS_SDK int32_t	GetAvailableLicenses () const
	Returns the number of available licenses on the system. More...

DB_EDGEVIS_SDK void	Disconnect ()
	Disconnects the session from the Server. More...

DB_EDGEVIS_SDK bool	IsConnected () const
	Determines of the Server session is currently connected. More...

DB_EDGEVIS_SDK ServerInfo	GetServerInfo () const
	Returns the current ServerInfo for the connected server. More...

DB_EDGEVIS_SDK OpResult	QueryEncoders (std::vector< Encoder > &result)
	Sends a query to the server to find all the Encoders that the currently connected user has permission to use. More...

DB_EDGEVIS_SDK OpResult	GetEncoders (std::vector< Encoder > &result)
	Returns a list of all available Encoders. More...

DB_EDGEVIS_SDK OpResult	QueryEncoder (Encoder &result, const std::wstring &name)
	Sends a query to the server to obtain information about an encoder that the user has access to. More...

DB_EDGEVIS_SDK OpResult	GetDevices (std::vector< Device > &result) const
	Returns a list of all available Devices. More...

DB_EDGEVIS_SDK OpResult	GetEncodersForDeviceUUID (const std::wstring &deviceUUID, std::vector< Encoder > &result) const
	Returns a list of Encoders available for a particular Device using its UUID. More...

DB_EDGEVIS_SDK OpResult	GetDeviceForEncoderUUID (const std::wstring &encoderUUID, Device &result)
	Returns the parent Device for an Encoder UUID. More...

DB_EDGEVIS_SDK void	RegisterListener (IServerListener *listener)
	Registers the specified listener to be notified when an event associated with the Server happens. More...

DB_EDGEVIS_SDK void	UnregisterListener (IServerListener *listener)
	Removes the specified listener from the set of listeners to be notified about Server. More...

DB_EDGEVIS_SDK void	RegisterEventListener (IServerEventListener *listener)
	Registers the specified listener to be notified when a CAMS notification associated with the Server happens. More...

DB_EDGEVIS_SDK void	UnregisterEventListener (IServerEventListener *listener)
	Removes the specified listener from the set of listeners to be notified about Server CAMS notifications. More...

DB_EDGEVIS_SDK Device	GetDevice (const std::wstring &name) const
	Returns the Device object with the specified name. More...

DB_EDGEVIS_SDK Device	GetDeviceByUUID (const std::wstring &uuid) const
	Returns the Device object with the specified UUID. More...

DB_EDGEVIS_SDK Encoder	GetEncoder (const std::wstring &name) const
	Returns the Encoder object with the specified name. More...

DB_EDGEVIS_SDK Encoder	GetEncoderByUUID (const std::wstring &uuid) const
	Returns the Encoder object with the specified UUID. More...

DB_EDGEVIS_SDK std::wstring	Name () const
	Returns the name of friendly name of the server currently connected to If not connected this will return an empty string. More...

DB_EDGEVIS_SDK std::wstring	Version () const
	Returns the name of version number of the server currently connected to If not connected this will return an empty string. More...

DB_EDGEVIS_SDK std::wstring	UniqueID () const
	Returns the name of Unique ID of the server currently connected to. More...

DB_EDGEVIS_SDK bool	IsAtLeastVersion (int32_t major, int32_t minor, int32_t build) const
	Will check that the server is at least a certain version number. More...

DB_EDGEVIS_SDK bool	SupportsUserConfig ()
	Returns if the server supports user config using the GetUserConfig and SetUserConfig methods. More...

DB_EDGEVIS_SDK OpResult	GetUserConfig (UserNotificationPreferences &user_config)
	Retrieve the current user's notification preferences from the server. More...

DB_EDGEVIS_SDK OpResult	SetUserConfig (UserNotificationPreferences &user_config)
	Update the current user's notification preferences on the server. More...

DB_EDGEVIS_SDK bool	SupportsEncoderManagerURLs () const
	Returns if the server supports encoder manager URLs obtained using the Encoder::GetManagerURL method. More...

DB_EDGEVIS_SDK bool	SupportsCamsTemplates () const
	Returns if the server supports template fields in CAMS rules. More...

DB_EDGEVIS_SDK std::wstring	GetWebAPIToken () const
	Retrieve a new web API token from the Server for the currently logged in user. More...

DB_EDGEVIS_SDK std::wstring	UserName () const
	Returns the name of the current user. More...

DB_EDGEVIS_SDK std::wstring	UserAccountName () const
	Returns the name of the account name for the current user. More...

DB_EDGEVIS_SDK int64_t	GetServerClockOffset () const
	Returns difference in the clock timestamps between the server clock and the clock on the client machine. More...

DB_EDGEVIS_SDK int64_t	GetTotalBytesSent ()
	Returns the current total number of bytes sent on this server. More...

DB_EDGEVIS_SDK int64_t	GetTotalBytesReceived ()
	Returns the current total number of bytes received on this server. More...

DB_EDGEVIS_SDK void	ResetDataUsageStats ()
	Resets the count of the total number of bytes sent and received for this server.

DB_EDGEVIS_SDK bool	SupportsClientSecurityPolicy () const
	Returns if the server supports client security policies. More...

DB_EDGEVIS_SDK OpResult	QueryClientSecurityPolicy (ClientSecurityPolicy &policy)
	Queries the server to obtain the client security policy for the current user. More...

DB_EDGEVIS_SDK OpResult	GetClientSecurityPolicy (ClientSecurityPolicy &policy)
	Gets the cached Client Security Policy object. More...

DB_EDGEVIS_SDK void	SetLoggingLevel (EdgeVisSDKCore::LoggingLevel level, const std::wstring &log_location)
	Set the logging level and log file location. More...

DB_EDGEVIS_SDK bool	SupportsStreamProfiles () const
	Returns if the server supports the new stream profile configuration API for encoders. More...

Static Public Member Functions
static DB_EDGEVIS_SDK std::wstring	ClientVersion ()
	Returns the version of the SDK. More...

Constructor & Destructor Documentation

DB_EDGEVIS_SDK EdgeVisDecoderSDK::Server::Server	(	const std::wstring &	appName,
		const std::wstring &	appMetadata
	)

Constructor for the Server object.

Parameters

appName	A String representing the name of the application. This is used to identify the application to the server session
appMetadata	A String representing MetaData of the application. Can be empty.

Member Function Documentation

static DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Server::ClientVersion ( )

static

Returns the version of the SDK.

Returns: The SDK version number

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::Server::SetClusterInfoCachingEnabled ( bool enabled )

Enables or disables automatic caching of the server cluster token in a file managed by the SDK.

The file will be written to the AppData directory for the current user, for example: C:.smith\AppData\Roaming\dbclustercache.cfg or the case of running as a Windows Service: C:.cfg This functionality is enabled by default. Note that if this functionality is disabled the application should persist the cluster tokens provided by the Server::Connect method and the IServerListener::ServerClusterChanged methods and pass the token to the ServerAddresses constructor for subsequent connections to the server.

Parameters

enabled True to enable the use of automatic cluster caching, false to disable it.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Server::Connect	(	const ServerAddresses &	hostAddresses,
		const std::wstring &	username,
		const std::wstring &	password,
		const std::wstring &	new_password,
		ServerAddresses &	availableAddresses,
		ConnectionStrategy	connect_strategy,
		ServerConnectInfo	flags = `SCI_ASPECT_CORRECT`
	)

Connects to an EdgeVis server.

This method attempts to connect to a Server. It is necessary to make this call before enumerating Encoder objects or otherwise interacting with Encoders. The list of available Encoders may vary depending on permissions configured at the server.

Parameters

hostAddresses	The server to connect to. This is a ServerAddresses object.
username	The username to use to connect
password	The password for the user to connect
new_password	If on attempting to connect an OpResult of OR_NewPasswordRequired is returned you must set a new password. This new password must meet the requirements as set down by the PasswordResetInfo class
availableAddresses	A list of available servers. This must be stored locally and used next time the Connect is called.
connect_strategy	For future use. Use the Default setting
flags	Determines if the video coming from an Encoder should be aspect ratio corrected before being retrieved for display to the user.

Returns: An OpResult

Potential OpResults Returned

OR_Success (connection to server was successful)
OR_AuthFailed (Authentication failed, no username or password provided. Please enter valid login credentials and try again.)
OR_Cancelled (Connection cancelled)
OR_ConnectionFailed (the server could not be contacted)
OR_NewPasswordRequired (the user's password has expired and must be updated using the new_password parameter)
OR_IncompatibleVersion (the server requires a newer version of the Decoder SDK)
OR_BadClusterConfig (the cluster config string returned from the server does not contain the address that is currently connected)

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Server::Connect	(	const ServerAddresses &	hostAddresses,
		const Credentials	credentials,
		ServerAddresses &	availableAddresses,
		ConnectionStrategy	connect_strategy,
		ServerConnectInfo	flags = `SCI_ASPECT_CORRECT`
	)

Connects to an EdgeVis server.

This method attempts to connect to a Server. It is necessary to make this call before enumerating Encoder objects or otherwise interacting with Encoders. The list of available Encoders may vary depending on permissions configured at the server.

Parameters

hostAddresses	The server to connect to. This is a ServerAddresses object.
credentials	A Credentials object containing the username, password and optionally a new password to set during log in. If on attempting to connect an OpResult of OR_NewPasswordRequired is returned you must set a new password. This new password must meet the requirements as set down by the PasswordResetInfo class
availableAddresses	A list of available servers. This must be stored locally and used next time the Connect is called.
connect_strategy	For future use. Use the Default setting
flags	Determines if the video coming from an Encoder should be aspect ratio corrected before being retrieved for display to the user.

Returns: An OpResult

Potential OpResults Returned

OR_Success (connection to server was successful)
OR_AuthFailed (Authentication failed, no username or password provided. Please enter valid login credentials and try again.)
OR_Cancelled (Connection cancelled)
OR_ConnectionFailed (the server could not be contacted)
OR_NewPasswordRequired (the user's password has expired and must be updated using the new_password parameter.)
OR_IncompatibleVersion (the server requires a newer version of the Decoder SDK)

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Server::Connect	(	const ServerAddresses &	hostAddresses,
		const Credentials	credentials,
		ServerAddresses &	availableAddresses
	)

Connects to an EdgeVis server.

This method attempts to connect to a Server. It is necessary to make this call before enumerating Encoder objects or otherwise interacting with Encoders. The list of available Encoders may vary depending on permissions configured at the server.

Parameters

hostAddresses	The server to connect to. This is a ServerAddresses object.
credentials	A Credentials object containing the username, password and optionally a new password to set during log in. If on attempting to connect an OpResult of OR_NewPasswordRequired is returned you must set a new password. This new password must meet the requirements as set down by the PasswordResetInfo class
availableAddresses	A list of available servers. This must be stored locally and used next time the Connect is called.

Returns: An OpResult

Potential OpResults Returned

OR_Success (connection to server was successful)
OR_AuthFailed (Authentication failed, no username or password provided. Please enter valid login credentials and try again.)
OR_Cancelled (Connection cancelled)
OR_ConnectionFailed (the server could not be contacted)
OR_NewPasswordRequired (the user's password has expired and must be updated using the new_password parameter.)
OR_IncompatibleVersion (the server requires a newer version of the Decoder SDK)

DB_EDGEVIS_SDK PasswordResetInfo EdgeVisDecoderSDK::Server::GetPasswordResetInfo ( ) const

If a users password must be reset then the limitation for the password can be retrieved and used to ensure the user enters a correct password.

Returns: A PasswordResetInfo object that describes the reason for the password reset and restrictions on the password complexity.

DB_EDGEVIS_SDK MFALoginResponse EdgeVisDecoderSDK::Server::GetMFALoginResponse ( ) const

Retrieve the multiple factor login response.

This contains information including reasons for an MFA Login failure.

Returns: A MFALoginResponse object that provides access to the reason for a multiple factor login failure the protocol version information, if the user is required to enrol and the quantity of emergency codes remaining.

DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Server::GetDevicePassword ( ) const

Retrieve a device password to use when logging in.

The device password is typically used on a trusted device to avoid prompting the user for a one-time code.

Returns: A string containing the device password which may be used for subsequent login requests,

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::Server::HasCams ( ) const

Check if this server supports CAMS notifications.

Returns: True if the server has support for CAMS notifications, false if it does not support CAMS.

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::Server::SupportsClientCamsRuleBuilder ( ) const

Check if this server supports CAMS rule builder in client applications.

Returns: True if the server has support for CAMS rule builder through clients, false if it does not support CAMS or has rule builder available in the manager web UI.

DB_EDGEVIS_SDK ServerInfo EdgeVisDecoderSDK::Server::QueryServerInfo ( const ServerAddresses & hostAddresses )

Queries the server to obtain its current information.

This will instantiate a connection to the server to retrieve the information such as its name, version, and unique ID.

If a Server connection is already in place then the existing server information will be returned

Note: To connect securley to an EdgeVis Server a crypto variant of the Decoder SDK is required. Contact Digital Barriers for more assitance.

Parameters

hostAddresses The server to connect to. This is a ServerAddresses object.

Returns: The ServerInfo of the requested server.

Call GetResult() on this to check if the key info was successfully populated. It will contain OR_Success on success.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Server::ValidateCredentials	(	const ServerAddresses &	hostAddresses,
		const Credentials &	credentials,
		ServerAddresses &	availableAddresses
	)

Test that the supplied credentials are valid for the given server.

If a Server connection is already in place then the credentials will checked for the existing connected session.

Parameters

hostAddresses	The server to connect to. This is a ServerAddresses object.
credentials	User credentials object containing username and password.
availableAddresses	A list of available servers. This must be stored locally and used next time the Connect is called.

Returns: opResult An OpResult.

Potential OpResults Returned

OR_Success
OR_NewPasswordRequired (the user's password has expired and must be updated using the new_password parameter.)
OR_Cancelled (Connection cancelled)
OR_AuthFailed (Authentication failed, no username or password provided. Please enter valid login credentials and try again.)
OR_ConnectionFailed (Please check the following for this server: - The server address you have entered is correct. - The server is online. - You have a network connection. - The server’s encryption settings match your chosen encryption connection method. If the problem continues contact your System Administrator.)
OR_AccountDisabled (Your account has been disabled. Please contact your System Administrator)
OR_AccountInactive (Your account has been inactive for too long. Please contact your System Administrator)
OR_AccountLocked (Your account has been locked out due to too many connection attempts with incorrect login details. Please contact your System Administrator)

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Server::ValidateCredentials	(	const ServerAddresses &	hostAddresses,
		const std::wstring &	username,
		const std::wstring &	password,
		const std::wstring &	new_password,
		ServerAddresses &	availableAddresses
	)

Test that the supplied username and password are valid for the given server.

If a Server connection is already in place then the credentials will checked for the existing connected session.

Parameters

hostAddresses	The server to connect to. This is a ServerAddresses object.
username	The username to validate.
password	The password to validate.
new_password	If on attempting to connect an OpResult of OR_NewPasswordRequired is returned you must set a new password. This new password must meet the requirements as set down by the PasswordResetInfo class
availableAddresses	A list of available servers. This must be stored locally and used next time the Connect is called.

Returns: opResult An OpResult.

Potential OpResults Returned

OR_Success
OR_NewPasswordRequired (the user's password has expired and must be updated using the new_password parameter.)
OR_Cancelled (Connection cancelled)
OR_AuthFailed (Authentication failed, no username or password provided. Please enter valid login credentials and try again.)
OR_ConnectionFailed (Please check the following for this server: - The server address you have entered is correct. - The server is online. - You have a network connection. - The server’s encryption settings match your chosen encryption connection method. If the problem continues contact your System Administrator.)
OR_AccountDisabled (Your account has been disabled. Please contact your System Administrator)
OR_AccountInactive (Your account has been inactive for too long. Please contact your System Administrator)
OR_AccountLocked (Your account has been locked out due to too many connection attempts with incorrect login details. Please contact your System Administrator)

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::Server::CancelQueryServerInfo ( )

Cancels the query for the ServerInfo.

This can be called on a separate thread as the QueryServerInfo() is a blocking call.

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::Server::CancelValidateCredentials ( )

Cancels the query for the Validate Credentials.

This can be called on a separate thread as the QueryValidateCredentialso() is a blocking call.

DB_EDGEVIS_SDK CamsNotificationManager EdgeVisDecoderSDK::Server::GetCamsNotificationManager ( )

Retrieve the CAMS notification manager for this server.

The CAMS notification manager allows existing notifications to be retrieved from the server and the ability to change the notificaiton states.

Returns: The CAMS notification Manager to allow interaction with CAMS notifications.

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::Server::GetAvailableLicenses ( ) const

Returns the number of available licenses on the system.

Returns: The number of Licences

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::Server::Disconnect ( )

Disconnects the session from the Server.

This will tear down all communications with the server

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::Server::IsConnected ( ) const

Determines of the Server session is currently connected.

Returns: True if connected

DB_EDGEVIS_SDK ServerInfo EdgeVisDecoderSDK::Server::GetServerInfo ( ) const

Returns the current ServerInfo for the connected server.

Returns: The ServerInfo for the server. If the server is not connected it will return null

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Server::QueryEncoders ( std::vector< Encoder > & result )

Sends a query to the server to find all the Encoders that the currently connected user has permission to use.

This results in a call to the server.

Returns the collection of all Encoder interfaces available from the Server for the current user. This collection includes all the Encoders that the user has permission to use whether they are connected to the Server or not

These Encoder objects are only valid while the server is connected. On a server disconnect the encoders will become invalid. On a Server reconnect you must requery the encoders and reopen any streams that are required

Parameters

result The list of available encoders

Returns: OpResult OR_Success if the query is successful. Error result if not.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Server::GetEncoders ( std::vector< Encoder > & result )

Returns a list of all available Encoders.

If QueryEncoders hasn't previously been called then a call to the server will be issued to fetch the encoders the user has permission to use.

Returns the collection of all Encoder interfaces available from the Server for the current user. This collection includes all the Encoders that the user has permission to use whether they are connected to the Server or not

These Encoder objects are only valid while the server is connected. On a server disconnect the encoders will become invalid. On a Server reconnect you must requery the encoders and reopen any streams that are required

Parameters

result The list of available encoders

Returns: OpResult OR_Success if the query is successful. Error result if not.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Server::QueryEncoder	(	Encoder &	result,
		const std::wstring &	name
	)

Sends a query to the server to obtain information about an encoder that the user has access to.

This results in a call to the server.

Returns an Encoder object representing the encoder that the user has access to. This will be empty if the encoder account does not exist or the user does not have access to it.

These Encoder objects are only valid while the server is connected. On a server disconnect the encoders will become invalid. On a Server reconnect you must requery the encoders and reopen any streams that are required

Parameters

result	The encoder object requested
name	The name of the encoder to retrieve

Returns: OpResult OR_Success if the query is successful. Error result if not.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Server::GetDevices ( std::vector< Device > & result ) const

Returns a list of all available Devices.

If the device list is not cached locally this call will result in a query to the Server.

Returns the collection of all Devices available from the Server for the current user. Each Device will represent a physical device and may provide more than one Encoder.

Parameters

result The list of available devices

Returns: OpResult OR_Success if the request is successful. Error result if not.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Server::GetEncodersForDeviceUUID	(	const std::wstring &	deviceUUID,
		std::vector< Encoder > &	result
	)		const

Returns a list of Encoders available for a particular Device using its UUID.

If the encoder list is not cached locally this call will result in a query to the Server.

Returns the collection of all Encoders available for the supplied Device UUID from the Server for the current user. This collection includes Encoders that the user has permission to use whether they are connected to the Server or not

Parameters

deviceUUID	The UUID of a Device object
result	The list of available encoders

Returns: OpResult OR_Success if the request is successful. Error result if not.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Server::GetDeviceForEncoderUUID	(	const std::wstring &	encoderUUID,
		Device &	result
	)

Returns the parent Device for an Encoder UUID.

If the encoder list is not cached locally this call will result in a query to the Server.

Returns the the parent Device for the Encoder with the supplied UUID.

Parameters

encoderUUID	The UUID of an Encoder object
result	The parent Device for the Encoder. The Device will be invalid if the supplied Encoder UUID is not valid or if the server does not support Devices.

Returns: OpResult OR_Success if the request is successful. Error result if not.

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::Server::RegisterListener ( IServerListener * listener )

Registers the specified listener to be notified when an event associated with the Server happens.

Parameters

listener Pointer to the listening object. Object must conform to the IServerListener interface

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::Server::UnregisterListener ( IServerListener * listener )

Removes the specified listener from the set of listeners to be notified about Server.

Parameters

listener Pointer to the listening object to remove.

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::Server::RegisterEventListener ( IServerEventListener * listener )

Registers the specified listener to be notified when a CAMS notification associated with the Server happens.

Parameters

listener Pointer to the listening object. Object must conform to the IServerEventListener interface

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::Server::UnregisterEventListener ( IServerEventListener * listener )

Removes the specified listener from the set of listeners to be notified about Server CAMS notifications.

Parameters

listener Pointer to the listening object to remove.

DB_EDGEVIS_SDK Device EdgeVisDecoderSDK::Server::GetDevice ( const std::wstring & name ) const

Returns the Device object with the specified name.

Returns a Device object representing the physical device that the user has access to. The name of the device is the account the physical unit uses to connect to the server.

This does not result in a call to the server and will return empty if

the device does not exist; this is equivalent to the account does not exist
the user does not have access to it.

>> >> These Device objects are only valid while the server is connected. On a server disconnect >> the devices will become invalid. On a Server reconnect you must find any devices of interest again. >>

Parameters

name The name of the device to retrieve

Returns
result The device object requested

DB_EDGEVIS_SDK Device EdgeVisDecoderSDK::Server::GetDeviceByUUID ( const std::wstring & uuid ) const

Returns the Device object with the specified UUID.

Returns a Device object representing the physical device that the user has access to. The name of the device is the account the physical unit uses to connect to the server.

This does not result in a call to the server and will return empty if

the device does not exist; this is equivalent to the account does not exist
the user does not have access to it.

>> >> These Device objects are only valid while the server is connected. On a server disconnect >> the devices will become invalid. On a Server reconnect you must find any devices of interest again. >>

Parameters

uuid The UUID of the device to retrieve

Returns
result The device object requested

DB_EDGEVIS_SDK Encoder EdgeVisDecoderSDK::Server::GetEncoder ( const std::wstring & name ) const

Returns the Encoder object with the specified name.

Returns an Encoder object representing the encoder that the user has access to.

This does not result in a call to the server and will return empty if

the encoder account does not exist
the user does not have access to it.

>> >> These Encoder objects are only valid while the server is connected. On a server disconnect >> the encoders will become invalid. On a Server reconnect you must reopen any streams that are required. >>

Parameters

name The name of the encoder to retrieve

Returns
result The encoder object requested

DB_EDGEVIS_SDK Encoder EdgeVisDecoderSDK::Server::GetEncoderByUUID ( const std::wstring & uuid ) const

Returns the Encoder object with the specified UUID.

Returns an Encoder object representing the encoder that the user has access to.

This does not result in a call to the server and will return empty if

the encoder account does not exist
the user does not have access to it.

>> >> These Encoder objects are only valid while the server is connected. On a server disconnect >> the encoders will become invalid. On a Server reconnect you must reopen any streams that are required. >>

Parameters

uuid The UUID of the encoder to retrieve

Returns
result The encoder object requested

DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Server::Name ( ) const

Returns the name of friendly name of the server currently connected to If not connected this will return an empty string.

Returns: The name of the server

DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Server::Version ( ) const

Returns the name of version number of the server currently connected to If not connected this will return an empty string.

Returns: The version number of the server

DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Server::UniqueID ( ) const

Returns the name of Unique ID of the server currently connected to.

The unique ID is a UUID that will not change on the server.

If not connected this will return an empty string

Returns: The Unique ID number of the server

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::Server::IsAtLeastVersion	(	int32_t	major,
		int32_t	minor,
		int32_t	build
	)		const

Will check that the server is at least a certain version number.

If not connected this will return an empty string

Parameters

major	The major version number
minor	The minor version number
build	The build number

Returns: True if the server version is at least the requested version

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::Server::SupportsUserConfig ( )

Returns if the server supports user config using the GetUserConfig and SetUserConfig methods.

Support for user config was added in Server 7.0.4

Returns: True if encoder manager URLs are supported, false if not supported.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Server::GetUserConfig ( UserNotificationPreferences & user_config )

Retrieve the current user's notification preferences from the server.

This includes E-mail addresses, phone numbers and mobile device push notification settings.

Parameters

user_config the UserNotificationPreferences object that will be populated with the user's current settings from the server.

Returns: OpResult OR_Success if the query is successful. Error result if not.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Server::SetUserConfig ( UserNotificationPreferences & user_config )

Update the current user's notification preferences on the server.

This includes E-mail addresses, phone numbers and mobile device push notification settings.

Parameters

user_config the UserNotificationPreferences containing the user's new settings for sending to the server.

Returns: OpResult

Potential OpResults Returned

OR_NotConnected (Encoder not connected to the server. Unable to apply User Notification preferences)
OR_NotSupported (Server failed to report user ID. Unable to apply User Notification preferences. Please contact your System Administrator)
OR_ConnectionFailed (Encoder not connected to the server. Unable to apply User Notification preferences)
OR_Failed (No server object instantiated, programmer error)

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::Server::SupportsEncoderManagerURLs ( ) const

Returns if the server supports encoder manager URLs obtained using the Encoder::GetManagerURL method.

Support for encoder manager URLS was added in Server 7.0.4

Returns: True if encoder manager URLs are supported, false if not supported.

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::Server::SupportsCamsTemplates ( ) const

Returns if the server supports template fields in CAMS rules.

Support for template fields was added in Server 7.1.0

Returns: True if CAMS rule templates are supported by the server, false if not supported.

DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Server::GetWebAPIToken ( ) const

Retrieve a new web API token from the Server for the currently logged in user.

NOTE: this call should be used only when requried to avoid flooding the server.

Returns: A token that may be used to access web resources at the server without requiring an additional log in or an empty string on failure.

DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Server::UserName ( ) const

Returns the name of the current user.

Returns: The name of the currently loggged in user.

DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Server::UserAccountName ( ) const

Returns the name of the account name for the current user.

Returns: The account name of the currently loggged in user. This will typically be the same as the user name submitted when logging in. When logging in using an e-mail address the user account name is likely to be different.

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::Server::GetServerClockOffset ( ) const

Returns difference in the clock timestamps between the server clock and the clock on the client machine.

Returns: The difference in the clock timestamps between the client machine and the server.

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::Server::GetTotalBytesSent ( )

Returns the current total number of bytes sent on this server.

Returns: The current total number of bytes sent

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::Server::GetTotalBytesReceived ( )

Returns the current total number of bytes received on this server.

Returns: The current total number of bytes received

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::Server::SupportsClientSecurityPolicy ( ) const

Returns if the server supports client security policies.

Support for client security policies was added in Server 7.2.0

Returns: True if client security policies are supported by the server, false if not supported.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Server::QueryClientSecurityPolicy ( ClientSecurityPolicy & policy )

Queries the server to obtain the client security policy for the current user.

Parameters

policy A ClientSecurityPolicy object to populate on success.

Returns: OpResult OR_Success if the query is successful. Error result if not.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Server::GetClientSecurityPolicy ( ClientSecurityPolicy & policy )

Gets the cached Client Security Policy object.

This is cached when a connection is made with the server.

Parameters

policy A ClientSecurityPolicy object to populate on success.

Returns: OpResult OR_Success The returned populated client policy is valid. OR_Unknown The client policy has not been cached yet. OR_NotSupported Client policy is not supported by the server, the policy object return will contain client defaults. OR_NotConnected The client policy is not been cached, no suitable connection was made to the server. Other: The client policy is not valid.

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::Server::SetLoggingLevel	(	EdgeVisSDKCore::LoggingLevel	level,
		const std::wstring &	log_location
	)

Set the logging level and log file location.

Parameters

level	Logging level, for example Info. Possible values are: Finest Finer Fine Config Info Warning Severe Off
log_location	Location on the file system where the log files will be written.

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::Server::SupportsStreamProfiles ( ) const

Returns if the server supports the new stream profile configuration API for encoders.

Support for the new stream profile config API was added in Server 7.4.0

Returns: True if the new bandwidth config API is supported by the server, false if not supported.

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

SDKs/EdgeVisDecoderSDK/Server.h

Detailed Description

Availability

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation