Detailed Description

An Encoder interface represents an Encoder that is managed by the server.

Once you obtain the interface you will be able to enumerate the available Stream interfaces to obtain media such as audio, video, GPS location or to manage the Encoder settings.

See Encoder for more iformation

Availability

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

#include <Encoder.h>

Public Types
typedef std::vector< Stream >	StreamsList
	A collection of Stream data.

typedef std::vector< Camera >	CameraList
	A collection of Camera objects.

Public Member Functions
virtual DB_EDGEVIS_SDK Server	GetServer () const
	Gets the Server object that the Encoder is connected to. More...

DB_EDGEVIS_SDK bool	IsConnectedToServer () const
	Determines if the Encoder object was known to be connected to the Server when this Encoder object was fetched from the Server. More...

DB_EDGEVIS_SDK std::wstring	TimezoneID () const
	Gets the Encoder's timezone ID. More...

DB_EDGEVIS_SDK std::wstring	Location () const
	Gets the Encoder's GPS location. More...

DB_EDGEVIS_SDK int32_t	MaxBandwidth () const
	Gets the Encoder's video stream maximum bandwidth. More...

DB_EDGEVIS_SDK int32_t	MinBandwidth () const
	Gets the Encoder's video stream minimum bandwidth. More...

DB_EDGEVIS_SDK std::wstring	OS () const
	Gets the Encoder's OS information. More...

DB_EDGEVIS_SDK int64_t	LastConnectDisconnectTime () const
	Gets the time the Encoder last connected to or disconnected from the server. More...

DB_EDGEVIS_SDK int64_t	DeepSleepWakeTime () const
	Gets the Encoder's deep sleep wake time. More...

DB_EDGEVIS_SDK int64_t	DeepSleepNextCheckInTime () const
	Gets the Encoder's deep sleep check-in time. More...

DB_EDGEVIS_SDK int64_t	ResumeSleepTime () const
	Gets the time that the encoder will enter sleep. More...

DB_EDGEVIS_SDK EncoderInfo	GetEncoderInfo ()
	Gets the extended Encoder Information. More...

DB_EDGEVIS_SDK StreamsList	GetStreams () const
	Gets a list of Streams that are available on the Encoder. More...

DB_EDGEVIS_SDK MediaStream	GetMediaStream () const
	Looks for the video stream in the list of streams for the Encoder and returns a pointer to it. More...

DB_EDGEVIS_SDK AnalyticsStream	GetAnalyticsStream () const
	Looks for the analytics stream in the list of streams for the Encoder and returns a pointer to it. More...

DB_EDGEVIS_SDK PTZStream	GetPTZStream () const
	Looks for the PTZ (telemetry) stream in the list of streams for the Encoder and returns a pointer to it. More...

DB_EDGEVIS_SDK PassThruStream	GetPassThruStream () const
	Looks for the serial pass-thru stream in the list of streams for the Encoder and returns a pointer to it. More...

DB_EDGEVIS_SDK ArchiveService	GetArchiveService () const
	Gets a pointer to the ArchiveService service object. More...

DB_EDGEVIS_SDK FullResService	GetFullResService () const
	Gets a pointer to the FullResService service object. More...

DB_EDGEVIS_SDK SecureConnectProxyService	GetSecureConnectProxyService () const
	Gets a pointer to the SecureConnectProxyService service object. More...

DB_EDGEVIS_SDK Stream	GetStream (const std::wstring &name) const
	Gets the Stream object with the specified name. More...

DB_EDGEVIS_SDK Stream	GetStream (StreamType type) const
	Gets the Stream object with the specified StreamType. More...

DB_EDGEVIS_SDK EncoderSettings	Settings () const
	Obtains the Encoder's settings object. More...

DB_EDGEVIS_SDK OpResult	Cameras (CameraList &result, bool include_virtual=true) const
	Gets the Camera objects for the cameras connected to the Encoder's inputs. More...

DB_EDGEVIS_SDK OpResult	GetCamera (Camera &result, int32_t inputId) const
	Gets the Camera object representing the specified camera input on the Encoder. More...

DB_EDGEVIS_SDK OpResult	GetCurrentCamera (Camera &result) const
	Gets the Camera object representing the currently active input on the Encoder. More...

DB_EDGEVIS_SDK int32_t	SensorColour () const
	Gets the colour of the sensors on this encoder. More...

DB_EDGEVIS_SDK OpResult	SetSensorColour (int32_t rgb)
	Sets the colour of the sensors on this encoder. More...

DB_EDGEVIS_SDK std::vector< SensorInfo >	Sensors () const
	Gets the SensorData objects for the alarm sensors connected to the Encoder. More...

DB_EDGEVIS_SDK OpResult	SetSensor (std::wstring sensor_id, const std::wstring &friendly_name, const double lat, const double lon)
	Sets a sensor that is connected to the encoder. More...

DB_EDGEVIS_SDK OpResult	SetSensor (std::wstring sensor_id, const std::wstring &friendly_name, const double lat, const double lon, const SensorModel model)
	Sets a sensor that is connected to the encoder. More...

DB_EDGEVIS_SDK OpResult	RemoveSensor (std::wstring sensor_id)
	Removes a sensor from the encoder. More...

DB_EDGEVIS_SDK OpResult	RemoveAllSensors ()
	Removes all the sensor from the encoder. More...

DB_EDGEVIS_SDK void	RegisterListener (IEncoderListener *listener)
	Registers the specified listener to be notified when an event associated with the Encoder is fired. More...

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

DB_EDGEVIS_SDK OpResult	QueryStatus (std::vector< EncoderStatusInfo > &result, const std::wstring typeFilter=L"", bool all=false, int64_t startTime=0, int64_t endTime=0)
	Sends a query to the Encoder to obtain Encoder status information. More...

DB_EDGEVIS_SDK OpResult	QueryEvents (EncoderEvents &result, const std::wstring typeFilter=L"", int64_t startTime=0, int64_t endTime=0)
	Queries historical Encoder events held on the Server. More...

DB_EDGEVIS_SDK OpResult	QueryFeatures (std::vector< FeatureInfo > &result)
	Queries the features available for the Encoder. More...

DB_EDGEVIS_SDK bool	GetFeature (std::wstring featureName, FeatureInfo &feature)
	Retrieve the FeatureInfo for a particular feature. More...

DB_EDGEVIS_SDK bool	HasFeatureAvailable (std::wstring featureName, int32_t timeout=0)
	Helper method to determine if a feature is available for use. More...

DB_EDGEVIS_SDK int32_t	GetFeatureLicenceCount (std::wstring featureName)
	Retrieve the licence count for a feature. More...

DB_EDGEVIS_SDK int32_t	MaxLicencedHeight ()
	Returns the max available height for the video frame that the licence allows. More...

DB_EDGEVIS_SDK int32_t	MinLicencedFrameStep ()
	Returns the minimum frame step (i.e maximum rame rate) that the licence allows. More...

DB_EDGEVIS_SDK int32_t	MaxSupportedHeight ()
	Returns the max available height for the video frame that the encoder supports. More...

DB_EDGEVIS_SDK OpResult	QueryDeepSleepTime (int64_t &wakeTime)
	Queries the deep sleep time for the Encoder. More...

DB_EDGEVIS_SDK OpResult	SetDeepSleepTime (const int64_t newTime)
	Sets the Deep Sleep wake time for the Encoder. More...

DB_EDGEVIS_SDK OpResult	SetResumeSleepTime (const int64_t newTime)
	Sets the time that the encoder will return to sleep. More...

DB_EDGEVIS_SDK OpResult	PostponeDeepSleep (int32_t timeMins)
	Postpones a deep sleep that is scheduled on an Encoder by a number of minutes. More...

DB_EDGEVIS_SDK void	RequestKeyFrame ()
	Requests that a keyframe is inserted into the media stream. More...

virtual DB_EDGEVIS_SDK std::wstring	Name () const
	Gets the name of the Encoder. More...

virtual DB_EDGEVIS_SDK std::wstring	QualifiedName () const
	Gets the qualified name of the Encoder, potentially including any prefixes. More...

virtual DB_EDGEVIS_SDK std::wstring	UniqueID () const
	Gets the Encoder's unique identifier. More...

virtual DB_EDGEVIS_SDK std::wstring	DeviceID () const
	Gets the unique identifier of the Encoder's parent device. More...

virtual DB_EDGEVIS_SDK std::wstring	Version () const
	Gets the Encoder's firmware version. More...

virtual DB_EDGEVIS_SDK std::wstring	Domain () const
	Gets the server domain that the encoder belongs to. More...

virtual DB_EDGEVIS_SDK std::wstring	Groups () const
	Gets the list of encoder groups that the encoder belongs to. More...

DB_EDGEVIS_SDK bool	CheckEncoderVersion (int32_t majorVer) const
	Checks the Encoder version number is equal to or greater than the specified version number. More...

DB_EDGEVIS_SDK OpResult	CheckEncoderVersionEx (const std::wstring &model)
	Uses ComponentInfoData to perform a more specific Encoder version check. More...

DB_EDGEVIS_SDK std::wstring	GetManagerURL ()
	Construct a valid URL for use with a browser component to access the encoder's Manager page. More...

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

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

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

DB_EDGEVIS_SDK OpResult	QueryEncoderCapabilities (EncoderCapabilities &capabilities)
	Queries the server to obtain the encoder capabilities. More...

DB_EDGEVIS_SDK std::wstring	GetCAMSRuleManagerURL ()
	Construct a valid URL for use with a browser component to access the encoder's CAMS Rules Manager page. More...

DB_EDGEVIS_SDK OpResult	Reboot ()
	Reboot the encoder. More...

DB_EDGEVIS_SDK DeepSleepManager	GetDeepSleepManager () const
	Retrieve a pointer to the Deep Sleep Manager singleton. More...

DB_EDGEVIS_SDK int32_t	GetStreamIndex () const
	Determine the stream index for this Encoder on the parent Device. More...

Member Function Documentation

virtual DB_EDGEVIS_SDK Server EdgeVisDecoderSDK::Encoder::GetServer ( ) const

virtual

Gets the Server object that the Encoder is connected to.

Returns: Pointer to the Server object the Encoder account is from.

Implements EdgeVisDecoderSDK::IAsset.

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::Encoder::IsConnectedToServer ( ) const

Determines if the Encoder object was known to be connected to the Server when this Encoder object was fetched from the Server.

The Encoder may have disconnected from or connected to the Server between querying the Server for this object and now.

Returns: True if the Encoder was connected to the Server, false otherwise.

DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Encoder::TimezoneID ( ) const

Gets the Encoder's timezone ID.

The timezone ID allows the client application to convert UTC timestamps to encoder times.

Returns: The Encoder's timezone ID as a string.

DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Encoder::Location ( ) const

Gets the Encoder's GPS location.

The Encoder will either have no GPS location, a fixed GPS location, or it will have a GPS device connected to it that will update its location. This method allows the location to be polled.

Returns: The Encoder's GPS WGS84 (EPSG/SRID:4326) location as a string in the format <LATITUDE,LONGITUDE>. An empty string if the Encoder does not have a GPS position. If the encoder is disconnected, the string is the last known location for the encoder.

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::Encoder::MaxBandwidth ( ) const

Gets the Encoder's video stream maximum bandwidth.

Returns: The Encoder's current maximum bandwidth for video in bits per second.

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::Encoder::MinBandwidth ( ) const

Gets the Encoder's video stream minimum bandwidth.

Returns: The Encoder's current minimum bandwidth for video in bits per second.

DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Encoder::OS ( ) const

Gets the Encoder's OS information.

Returns: The Encoder's operating system information.

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::Encoder::LastConnectDisconnectTime ( ) const

Gets the time the Encoder last connected to or disconnected from the server.

For a connected Encoder this allows calculation of uptime. For a disconnected Encoder this allows calculation of downtime.

Returns: The timestamp for the encoder's last connection to or disconnection from the server.

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::Encoder::DeepSleepWakeTime ( ) const

Gets the Encoder's deep sleep wake time.

This is the time that the encoder will reconnect to the server at.

Returns: The timestamp for the encoder's wake time. If the timestamp is 0 the encoder is not sleeping. If the timestamp is LLONG_MAX the encoder will sleep indefinitely, waking only for alarm events.

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::Encoder::DeepSleepNextCheckInTime ( ) const

Gets the Encoder's deep sleep check-in time.

This is the time that the encoder will next contact the server for a deep sleep update. This provides the encoder the opportunity to exit deep sleep early.

Returns: The timestamp for the encoder's next check-in time.

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::Encoder::ResumeSleepTime ( ) const

Gets the time that the encoder will enter sleep.

Returns: The timestamp for the encoder's next sleep.

DB_EDGEVIS_SDK EncoderInfo EdgeVisDecoderSDK::Encoder::GetEncoderInfo ( )

Gets the extended Encoder Information.

If this is the first time this method has been called on the Encoder a query will have to be sent to it to get the EncoderInfoData from it.

Returns: EncoderInfo object containing the extended Encoder information.

DB_EDGEVIS_SDK StreamsList EdgeVisDecoderSDK::Encoder::GetStreams ( ) const

Gets a list of Streams that are available on the Encoder.

This will consist of video and data streams.

Returns: Vector containing Stream objects representing the Streams available on the Encoder.

DB_EDGEVIS_SDK MediaStream EdgeVisDecoderSDK::Encoder::GetMediaStream ( ) const

Looks for the video stream in the list of streams for the Encoder and returns a pointer to it.

The video stream is taken to be the first media stream in the list of streams.

Returns: The MediaStream object representing the video stream. The MediaStream object will be invalid if no media stream is found.

DB_EDGEVIS_SDK AnalyticsStream EdgeVisDecoderSDK::Encoder::GetAnalyticsStream ( ) const

Looks for the analytics stream in the list of streams for the Encoder and returns a pointer to it.

Returns: The AnalyticsStream object representing the analytics stream. The AnalyticsStream object will be invalid if no analytics stream is found.

DB_EDGEVIS_SDK PTZStream EdgeVisDecoderSDK::Encoder::GetPTZStream ( ) const

Looks for the PTZ (telemetry) stream in the list of streams for the Encoder and returns a pointer to it.

The PTZ stream is taken to be the first PTZ stream in the list of streams.

Returns: The PTZStream object representing the PTZ (telemetry) stream. The PTZStream object will be invalid if no PTZ stream is found.

DB_EDGEVIS_SDK PassThruStream EdgeVisDecoderSDK::Encoder::GetPassThruStream ( ) const

Looks for the serial pass-thru stream in the list of streams for the Encoder and returns a pointer to it.

The serial pass-thru stream is taken to be the first serial pass-thru stream in the list of streams.

Returns: The PassThruStream object representing the serial pass-thru stream. The PassThruStream object will be invalid if no serial pass-thru stream is found.

DB_EDGEVIS_SDK ArchiveService EdgeVisDecoderSDK::Encoder::GetArchiveService ( ) const

Gets a pointer to the ArchiveService service object.

Returns: The ArchiveService. The ArchiveService object will be invalid if the service does not exist.

DB_EDGEVIS_SDK FullResService EdgeVisDecoderSDK::Encoder::GetFullResService ( ) const

Gets a pointer to the FullResService service object.

Returns: The FullResService. The FullResService object will be invalid if the service does not exist.

DB_EDGEVIS_SDK SecureConnectProxyService EdgeVisDecoderSDK::Encoder::GetSecureConnectProxyService ( ) const

Gets a pointer to the SecureConnectProxyService service object.

Returns: The SecureConnectProxyService. The SecureConnectProxyService object will be invalid if the service does not exist.

DB_EDGEVIS_SDK Stream EdgeVisDecoderSDK::Encoder::GetStream ( const std::wstring & name ) const

Gets the Stream object with the specified name.

Parameters

name	The name of the stream to search for.

Returns: The Stream object found. The Stream object will be invalid if no stream is found.

DB_EDGEVIS_SDK Stream EdgeVisDecoderSDK::Encoder::GetStream ( StreamType type ) const

Gets the Stream object with the specified StreamType.

Parameters

type	The type of the stream to search for.

Returns: The Stream object found. The Stream object will be invalid if no stream is found.

DB_EDGEVIS_SDK EncoderSettings EdgeVisDecoderSDK::Encoder::Settings ( ) const

Obtains the Encoder's settings object.

The EncoderSettings object if the parent object for all Encoder related configuration and settings.

Returns: The EncoderSettings object for the Encoder.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::Cameras	(	CameraList &	result,
		bool	include_virtual = `true`
	)		const

Gets the Camera objects for the cameras connected to the Encoder's inputs.

This may query the Encoder for the information.

Parameters

result	List of Camera objects connected to the Encoder.
include_virtual	Filter for physical inputs only when false, include virtual inputs when true.

Returns

OpResult

OR_Success
OR_ConnectionFailed
OR_NotConnected (Encoder has disconnected)
OR_PermissionDenied (not allowed to get settings)
OR_EncoderNotSupported (Encoder is too old)

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::GetCamera	(	Camera &	result,
		int32_t	inputId
	)		const

Gets the Camera object representing the specified camera input on the Encoder.

This may query the Encoder for the information.

Parameters

inputId The input ID of the Camera to return

Returns

Camera object for the specified camera input on the Encoder.

OpResult

OR_Success
OR_ConnectionFailed
OR_NotConnected (Encoder has disconnected)
OR_PermissionDenied (not allowed to get settings)
OR_EncoderNotSupported (Encoder is too old)
OR_InvalidCameraInput (Invalid camera input)

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::GetCurrentCamera ( Camera & result ) const

Gets the Camera object representing the currently active input on the Encoder.

This may query the Encoder for the information.

Returns

Camera object for the currently active input on the Encoder.

OPResult

OR_Success
OR_ConnectionFailed
OR_NotConnected (Encoder has disconnected)
OR_PermissionDenied (not allowed to get settings)
OR_EncoderNotSupported (Encoder is too old)

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::Encoder::SensorColour ( ) const

Gets the colour of the sensors on this encoder.

Colour is used to display the encoder and sensors on maps etc.

Returns: The colour of the Sensors as RGB values

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::SetSensorColour ( int32_t rgb )

Sets the colour of the sensors on this encoder.

Colour is used to display the encoder and sensors on maps etc.

Parameters

rgb	- The colour of the Sensors as RGB values

Returns: OpResult

DB_EDGEVIS_SDK std::vector< SensorInfo > EdgeVisDecoderSDK::Encoder::Sensors ( ) const

Gets the SensorData objects for the alarm sensors connected to the Encoder.

Returns: List of SensorData objects representing the sensors connected to the Encoder. An empty list if no sensors are connected to the Encoder.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::SetSensor	(	std::wstring	sensor_id,
		const std::wstring &	friendly_name,
		const double	lat,
		const double	lon
	)

Sets a sensor that is connected to the encoder.

If the Sensor already exists (sensor_id) it is overwritten

Parameters

sensor_id	The ID of the sensor. This is unique per encoder
friendly_name	A user friendly name of the sensor to display to the user
lat	The latitude of the sensor
lon	The longitude of the sensor

Returns: OpResult

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::SetSensor	(	std::wstring	sensor_id,
		const std::wstring &	friendly_name,
		const double	lat,
		const double	lon,
		const SensorModel	model
	)

Sets a sensor that is connected to the encoder.

If the Sensor already exists (sensor_id) it is overwritten

Parameters

sensor_id	The ID of the sensor. This is unique per encoder
friendly_name	A user friendly name of the sensor to display to the user
lat	The latitude of the sensor
lon	The longitude of the sensor
model	The model of the sensor

Returns: OpResult

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::RemoveSensor ( std::wstring sensor_id )

Removes a sensor from the encoder.

Parameters

sensor_id The ID of the sensor. This is unique per encoder

Returns: OpResult

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::RemoveAllSensors ( )

Removes all the sensor from the encoder.

Returns: OpResult

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::Encoder::RegisterListener ( IEncoderListener * listener )

Registers the specified listener to be notified when an event associated with the Encoder is fired.

Parameters

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

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::Encoder::UnregisterListener ( IEncoderListener * listener )

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

Parameters

listener Pointer to the listening object to remove.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::QueryStatus	(	std::vector< EncoderStatusInfo > &	result,
		const std::wstring	typeFilter = `L""`,
		bool	all = `false`,
		int64_t	startTime = `0`,
		int64_t	endTime = `0`
	)

Sends a query to the Encoder to obtain Encoder status information.

This will contain information such as the current CPU temperature, the current power supply voltage and the time of the last connection profile switch. This will block until the results have been obtained.

Parameters

result	A vector to contain the EncoderStatusInfo objects for each status report returned by the Encoder.
typeFilter	The type of Encoder Status Event to filter on. e.g. external_trigger. Leave blank to get all types of event.
all	True to get extended status information, false to get standard status information.
startTime	The start (earliest) time to filter events on. This is a UTC timestamp. If this is 0 then results are not filtered by time.
endTime	The end (latest) time to filter events on. This is a UTC timestamp. If this is 0 then the current system time is used.

Returns

OpResult

OR_Success
OR_ConnectionFailed
OR_NotConnected
OR_PermissionDenied
OR_EncoderNotSupported

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::QueryEvents	(	EncoderEvents &	result,
		const std::wstring	typeFilter = `L""`,
		int64_t	startTime = `0`,
		int64_t	endTime = `0`
	)

Queries historical Encoder events held on the Server.

This can be any or all types of Encoder Status Events such as external_trigger, power_up, high_temp, etc. Since this has the potential to return a large volume of results, which may adversely effect performance, the query is a paged query. This means that not all the results are returned at once. Instead a set number of results are returned per 'page'. To get the next set of results the next page can be requested and so on until all the results have been returned. An EncoderEvents object is returned by this method to help with this. It gathers together all the results across all the requested pages and makes it easy to request the next page.

Parameters

result	EncoderEvents object that holds the results of the query and can be used to request additional pages of results.
typeFilter	The type of Encoder Status Event to filter on. e.g. external_trigger. Leave blank to get all types of event.
startTime	The start (earliest) time to filter events on. This is a UTC timestamp. If this is 0 then results are not filtered by time.
endTime	The end (latest) time to filter events on. This is a UTC timestamp. If this is 0 then the current system time is used.

Returns

OpResult

OR_Success
OR_ConnectionFailed
OR_NotConnected (Encoder has disconnected)
OR_PermissionDenied (not allowed to query status)
OR_EncoderNotSupported (Encoder is too old)

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::QueryFeatures ( std::vector< FeatureInfo > & result )

Queries the features available for the Encoder.

This provides information on the hardware capabilities, configuration and permissions that the current user has to access the feature.

Parameters

result A list of FeatureInfo objects providing the feature name, a flag indicating if the feature is available on the encoder and a flag indicating if the current user is allowed to use the feature.

Returns

OpResult

OR_Success
OR_ConnectionFailed
OR_NotConnected

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::Encoder::GetFeature	(	std::wstring	featureName,
		FeatureInfo &	feature
	)

Retrieve the FeatureInfo for a particular feature.

The available features are listed in the FeatureInfo class.

Parameters

featureName	The name of the feature to retrieve the FeatureInfo for.
feature	The FeatureInfo retrieved for the requested feature name.

Returns: True if the requested feature name was found, false if it was not.

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::Encoder::HasFeatureAvailable	(	std::wstring	featureName,
		int32_t	timeout = `0`
	)

Helper method to determine if a feature is available for use.

This internally checks that the feature is supported, licenced and permitted for the current user.

Parameters

featureName	The name of the feature to check is available for use.
timeout	The maximum time before the request will return

Returns: True if the feature is available for use, false if it was not.

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::Encoder::GetFeatureLicenceCount ( std::wstring featureName )

Retrieve the licence count for a feature.

Parameters

featureName The name of the feature to retrieve the licence count for.

Returns: The number of licences assigned to the encoder for this feature.

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::Encoder::MaxLicencedHeight ( )

Returns the max available height for the video frame that the licence allows.

Returns: int The maximum licence height

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::Encoder::MinLicencedFrameStep ( )

Returns the minimum frame step (i.e maximum rame rate) that the licence allows.

Returns: int The maximum licence height

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::Encoder::MaxSupportedHeight ( )

Returns the max available height for the video frame that the encoder supports.

Returns: int The maximum supported height

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::QueryDeepSleepTime ( int64_t & wakeTime )

Queries the deep sleep time for the Encoder.

This will be the time, in UTC time, that the Encoder will wake up from Deep Sleep mode. Deep Sleep mode is where the Encoder will effectively switch itself off. It will then wait until the specified wake time to switch back on. The Encoder will periodically wake up and check with the Server in case the deep sleep has been cancelled. The wake time returned may be in the past. This indicates the last wake time the Encoder used to wake from Deep Sleep.

Parameters

wakeTime A pointer to the wake time, in UTC time, for Deep Sleep mode. This will be 0 if no Deep Sleep setting has ever been specified for the Encoder. It will be a time in the past if the Encoder has previously woken from Deep Sleep mode. It will be a time in the future if the Encoder is currently in Deep Sleep mode. Note that a wake time of 9223372036854775807 indicates that the encoder will wake on alarm triggers only.

Returns

OpResult

OR_ConnectionFailed
OR_NotConnected (Encoder has disconnected)
OR_PermissionDenied (not allowed to query status)
OR_EncoderNotSupported (Encoder is too old)

Warning: Use of this function is NOT recommended. Please use DeepSleepManager instead. (accessible via method 'GetDeepSleepManager')

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::SetDeepSleepTime ( const int64_t newTime )

Sets the Deep Sleep wake time for the Encoder.

This is in UTC time. Deep Sleep mode is where the Encoder will effectively switch itself off. It will then wait until the specified wake time to switch back on. The Encoder will periodically wake up and check with the Server in case the deep sleep has been cancelled. Setting the Deep Sleep wake time to a time in the past has no effect. Setting it to 0 will cancel an existing Deep Sleep. Although the Encoder will not wake up immediately. It will only wake up the next time it starts up to check with the Server to see if it should continue to sleep. The amount of time between checks is defined by the Server and can only be changed by the Server administrator. If the Deep Sleep wake time is set to a time in the future then the Encoder will go to sleep immediately.

Parameters

newTime The new Deep Sleep wake time in UTC time.

Returns: OpResult

Potential OpResults Returned

OR_Success
OR_ConnectionFailed
OR_NotConnected (Encoder has disconnected)
OR_PermissionDenied (not allowed to query status)
OR_EncoderNotSupported (This function is not supported by this encoder)

Warning: Use of this function is NOT recommended. Please use DeepSleepManager instead. (accessible via method 'GetDeepSleepManager')

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::SetResumeSleepTime ( const int64_t newTime )

Sets the time that the encoder will return to sleep.

Only applies to the case where the encoder has woken from sleep on an alarm event.

Returns: The timestamp that the encoder will return sleep.

Warning: Use of this function is NOT recommended. Please use DeepSleepManager instead. (accessible via method 'GetDeepSleepManager')

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::PostponeDeepSleep ( int32_t timeMins )

Postpones a deep sleep that is scheduled on an Encoder by a number of minutes.

Parameters

timeMins The number of minutes to delay a sleep.

Returns: OpResult

Potential OpResults Returned

OR_Success
OR_ConnectionFailed
OR_NotConnected (Encoder is not connected to the server. Unable to configure Deep Sleep settings)
OR_PermissionDenied (not allowed to query status)
OR_EncoderNotSupported (Deep Sleep is not supported by this encoder)
OR_SettingNotValid (Encoder is not due to enter sleep. Unable to postpone Deep Sleep)
OR_Failed (Error retrieving the encoder’s config. Unable to configure Deep Sleep settings)

Warning: Use of this function is NOT recommended. Please use DeepSleepManager instead. (accessible via method 'GetDeepSleepManager')

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::Encoder::RequestKeyFrame ( )

Requests that a keyframe is inserted into the media stream.

This can be done without actually having to open the media stream.

virtual DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Encoder::Name ( ) const

virtual

Gets the name of the Encoder.

Returns: Encoder's name.

Implements EdgeVisDecoderSDK::IAsset.

virtual DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Encoder::QualifiedName ( ) const

virtual

Gets the qualified name of the Encoder, potentially including any prefixes.

Returns: Encoder's qualififed name.

virtual DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Encoder::UniqueID ( ) const

virtual

Gets the Encoder's unique identifier.

Returns: Encoder's unique identifier.

Implements EdgeVisDecoderSDK::IAsset.

virtual DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Encoder::DeviceID ( ) const

virtual

Gets the unique identifier of the Encoder's parent device.

Note that multiple Encoder objects may have the same parent device.

Returns: The unique parent device identifier for the Encoder.

Implements EdgeVisDecoderSDK::IAsset.

virtual DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Encoder::Version ( ) const

virtual

Gets the Encoder's firmware version.

Returns: Encoder's firmware version.

Implements EdgeVisDecoderSDK::IAsset.

virtual DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Encoder::Domain ( ) const

virtual

Gets the server domain that the encoder belongs to.

Returns: Encoder's domain.

Implements EdgeVisDecoderSDK::IAsset.

virtual DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Encoder::Groups ( ) const

virtual

Gets the list of encoder groups that the encoder belongs to.

Returns: A comma separated list of the encoder's groups.

Implements EdgeVisDecoderSDK::IAsset.

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::Encoder::CheckEncoderVersion ( int32_t majorVer ) const

Checks the Encoder version number is equal to or greater than the specified version number.

Parameters

majorVer The major Encoder version number to compare against.

Returns: True if majorVer >= the current Encoder firmware version, false otherwise.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::CheckEncoderVersionEx ( const std::wstring & model )

Uses ComponentInfoData to perform a more specific Encoder version check.

At the moment this checks that the Encoder model matches exactly with the expected model name. If this is the first time this method has been called on the Encoder a query will have to be sent to it to get the EncoderInfoData from it.

Parameters

model The model name of the Encoder. This must match the model name in the ComponentInfoData returned by the Encoder.

Returns: OpResult OR_Success if the Encoder matches the expected model, OR_Fail.

This method may also return the following errors:

OR_ConnectionFailed
OR_NotConnected (Encoder has disconnected)
OR_PermissionDenied (not allowed to query status)
OR_EncoderNotSupported (Encoder is too old).

DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Encoder::GetManagerURL ( )

Construct a valid URL for use with a browser component to access the encoder's Manager page.

This method will automatically log in to a web manager session.

Returns: std::wstring The constructed URL for this encoder's manager page or empty string if it failed.

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::Encoder::GetTotalBytesSent ( )

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

Returns: The current total number of bytes sent

DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::Encoder::GetTotalBytesReceived ( )

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

Returns: The current total number of bytes received

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::QueryEncoderCapabilities ( EncoderCapabilities & capabilities )

Queries the server to obtain the encoder capabilities.

Parameters

capabilities An EncoderCapabilities object to populate on success.

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

DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::Encoder::GetCAMSRuleManagerURL ( )

Construct a valid URL for use with a browser component to access the encoder's CAMS Rules Manager page.

This method will automatically log in to a web manager session.

Returns: std::wstring The constructed URL for this encoder's CAMS rules manager page or empty string if it failed.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::Encoder::Reboot ( )

Reboot the encoder.

The encoder will disconnect from the server during the reboot.

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

DB_EDGEVIS_SDK DeepSleepManager EdgeVisDecoderSDK::Encoder::GetDeepSleepManager ( ) const

Retrieve a pointer to the Deep Sleep Manager singleton.

Returns: DeepSleepManager

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::Encoder::GetStreamIndex ( ) const

Determine the stream index for this Encoder on the parent Device.

Returns: The stream index of the Encoder.

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

SDKs/EdgeVisDecoderSDK/Encoder.h

Detailed Description

Availability

Public Types

Public Member Functions

Member Function Documentation