Detailed Description

The EncoderSettings interface provides access to an Encoder's configuration, connection profile and camera settings.

When the settings are requested they are initially obtained by querying the Encoder. Once they have been obtained they are stored in an internal cache and future requests do not need to query the Encoder. If the settings on the Encoder have changed then the cached settings may no longer be valid. There are 2 possible ways of handling this:

The user may call one of the Invalidate functions, which cause the cached setting(s) to be cleared.The settings will be fetched from the Encoder again the next time they are requested. If the user is an Encoder Administrator then they are able to receive settings update notifications. In this case the cache will automatically be kept up to date by the settings update notifications that come from the Server.

Encoder settings structure

The encoder settings are sructured as follows:

Encoder Settings
- EncoderConfig The Encoder config object has the following available settings
  - Current Video Input
  - Colour Settings
  - Audio Settings
  - Video Filter Settings
  - Encoder's Time Zone
  - Current Connection Profile Settings
  - Available Connection Profiles
  - Relay power state
  - Camera power state
  - Local Wifi enabled state (if applicable)
  - Area of Interest (AOI) region and state information
- CameraInfo The CameraInfo object has the following available settings
  - Input ID (input the camera is connected to on the Encoder)
  - Enabled (whether the input is enabled or disabled)
  - PTZ Enabled (whether the camera supports PTZ or not)
  - PTZ Camera Type (The type of PTZ Camera e.g. Pelco-D)
  - PTZ Presets
- EncoderProfile The encoder profiles store the video, audio and bandwidth settings
  - Profile Name (e.g. LAN)
  - Bandwidth Settings
    - Channel bandwidth
    - Maximum bandwidth
    - Minimum bandwidth
  - Audio Profile Settings
    - Audio enabled
    - Audio bit rate
  - Video Profile Settings
    - Frame height
    - Frame width
    - frame step (fps)

Changing Settings

The EncoderSettings interface is immutable. The settings it stores cannot be modified.

To change the encoder settings see the SettingsModifier class.

Availability

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

#include <EncoderSettings.h>

Public Member Functions
DB_EDGEVIS_SDK OpResult	GetEncoderConfig (EncoderConfig &result)
	Retrieves the current Encoder configuration settings. More...

DB_EDGEVIS_SDK bool	IsConfigValid ()
	Determines if the cached Encoder configuration settings are still valid. More...

DB_EDGEVIS_SDK void	InvalidateEncoderConfig ()
	Invalidates the currently cached Encoder configuration settings. More...

DB_EDGEVIS_SDK std::wstring	GetCurrentProfileName ()
	Retrieves the name of the Encoder's current connection profile. More...

DB_EDGEVIS_SDK OpResult	GetCurrentProfile (EncoderProfile &result)
	Retrieves the Encoder's current connection profile settings. More...

DB_EDGEVIS_SDK OpResult	GetProfile (EncoderProfile &result, const std::wstring &profileName)
	Retrieves connection profile settings for the Encoder. More...

DB_EDGEVIS_SDK OpResult	GetAvailableProfiles (std::vector< EncoderProfile > &result)
	Retrieves all available connection profile settings for the Encoder. More...

DB_EDGEVIS_SDK bool	IsProfileValid (const std::wstring &profileName) const
	Determines if the cached Encoder connection profile settings are still valid. More...

DB_EDGEVIS_SDK void	InvalidateEncoderProfile (const std::wstring &profileName=L"")
	Invalidates the currently cached Encoder connection profile settings. More...

DB_EDGEVIS_SDK int32_t	CameraInputs ()
	Retrieves the number of camera inputs that the Encoder has available. More...

DB_EDGEVIS_SDK OpResult	GetCameraInfo (std::vector< CameraInfo > &result, bool includeVirtual=true)
	Retrieves a list of all CameraInput objects for all active inputs on the Encoder. More...

DB_EDGEVIS_SDK OpResult	GetCameraInfo (CameraInfo &result, int32_t inputId)
	Retrieves the CameraInfo settings for the specified camera input. More...

DB_EDGEVIS_SDK OpResult	GetCurrentCameraInfo (CameraInfo &result)
	Retrieves the CameraInfo settings for the currently active camera input on the Encoder. More...

DB_EDGEVIS_SDK bool	IsCameraInfoValid ()
	Determines if the cached camera input information for the Encoder is valid. More...

DB_EDGEVIS_SDK void	InvalidateCameraInfo ()
	Invalidates the currently cached camera input information for the Encoder. More...

DB_EDGEVIS_SDK void	InvalidateUpdateSequenceNos ()
	Invalidates setting update sequence numbers. More...

DB_EDGEVIS_SDK void	InvalidateAll ()
	Invalidates all cached settings and settings update sequence numbers.

DB_EDGEVIS_SDK Encoder	GetEncoder () const
	Returns the Encoder object that the EncoderSettings object refers to. More...

DB_EDGEVIS_SDK VideoFrameLayout	GetVideoFrameLayout (int32_t input)
	Returns the VideoFrameLayout describing the sources used to construct the received YCbCrFrame for the specified input. More...

DB_EDGEVIS_SDK void	RegisterSettingsListener (IEncoderSettingsListener *listener)
	Registers the specified encoder settings listener from the set of listeners to be notified about Encoder settings changes. More...

DB_EDGEVIS_SDK void	UnregisterSettingsListener (IEncoderSettingsListener *listener)
	Removes the specified encoder settings listener from the set of listeners to be notified about Encoder settings changes. More...

Member Function Documentation

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::EncoderSettings::GetEncoderConfig ( EncoderConfig & result )

Retrieves the current Encoder configuration settings.

If the settings have already been fetched from the Encoder and have not been marked as invalid then the settings returned will be the current stored settings. Otherwise, the configuration settings are fetched from the Encoder again.

Parameters

result the current EncoderConfig representing the Encoder's configuration settings.

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 bool EdgeVisDecoderSDK::EncoderSettings::IsConfigValid ( )

Determines if the cached Encoder configuration settings are still valid.

The settings are valid if they have been set before and if they have not been invalidated by a call to InvalidateEncoderConfig.

Returns: True if the settings are valid, false otherwise.

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::EncoderSettings::InvalidateEncoderConfig ( )

Invalidates the currently cached Encoder configuration settings.

This means that the next time the configuration settings are requested using GetEncoderConfig they will be refreshed by requesting them from the Encoder.

DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::EncoderSettings::GetCurrentProfileName ( )

Retrieves the name of the Encoder's current connection profile.

Returns: std::wstring The name of the current connection profile.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::EncoderSettings::GetCurrentProfile ( EncoderProfile & result )

Retrieves the Encoder's current connection profile settings.

If the settings have already been fetched from the Encoder and have not been marked as invalid then the settings returned will be the current stored settings. Otherwise, the settings are fetched from the Encoder again.

Parameters

result The current EncoderProfile representing the Encoder's current connection profile settings.

Returns

OpResult

OR_Success
OR_ConnectionFailed
OR_NotConnected
OR_PermissionDenied
OR_EncoderNotSupported (Encoder is too old)
OR_InvalidProfileName (Unknown profile name)

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::EncoderSettings::GetProfile	(	EncoderProfile &	result,
		const std::wstring &	profileName
	)

Retrieves connection profile settings for the Encoder.

The profile returned depends on the requested profile name. If the settings have already been fetched from the Encoder and have not been marked as invalid then the settings returned will be the current stored settings. Otherwise, the settings are fetched from the Encoder again.

Parameters

result	The EncoderProfile representing the named connection profile settings for the Encoder.
profileName	The name of the profile to retrieve

Returns

OpResult

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

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::EncoderSettings::GetAvailableProfiles ( std::vector< EncoderProfile > & result )

Retrieves all available connection profile settings for the Encoder.

If the settings have already been fetched from the Encoder and have not been marked as invalid then the settings returned will be the current stored settings. Otherwise, the settings are fetched from the Encoder again.

Parameters

result The list of EncoderProfile representing the available connection profile settings for the Encoder.

Returns

OpResult

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

DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderSettings::IsProfileValid ( const std::wstring & profileName ) const

Determines if the cached Encoder connection profile settings are still valid.

The settings are valid if they have been set before and if they have not been invalidated by a call to InvalidateEncoderProfile.

Parameters

profileName The name of the profile to check

Returns: True if the settings are valid, false otherwise.

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::EncoderSettings::InvalidateEncoderProfile ( const std::wstring & profileName = L"" )

Invalidates the currently cached Encoder connection profile settings.

This means that the next time the profile settings are requested using GetCurrentProfile or GetProfile they will be refreshed by requesting them from the Encoder.

Parameters

profileName The name of the connection profile to invalidate. If the name is blank then all the cached connection profiles will be invalidated.

DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::EncoderSettings::CameraInputs ( )

Retrieves the number of camera inputs that the Encoder has available.

If the settings have already been fetched from the Encoder and have not been marked as invalid then the settings returned will be the current stored settings. Otherwise, the settings are fetched from the Encoder again.

Returns: The number of available camera inputs. Some of the inputs may still be unavailable to use. Check the configuration of each camera input to determine if it is enabled.

DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::EncoderSettings::GetCameraInfo	(	std::vector< CameraInfo > &	result,
		bool	includeVirtual = `true`
	)

Retrieves a list of all CameraInput objects for all active inputs on the Encoder.

If the settings have already been fetched from the Encoder and have not been marked as invalid then the settings returned will be the current stored settings. Otherwise, the settings are fetched from the Encoder again.

Parameters

result List of CameraInput objects for all active inputs on the Encoder.

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::EncoderSettings::GetCameraInfo	(	CameraInfo &	result,
		int32_t	inputId
	)

Retrieves the CameraInfo settings for the specified camera input.

If the settings have already been fetched from the Encoder and have not been marked as invalid then the settings returned will be the current stored settings. Otherwise, the settings are fetched from the Encoder again.

Parameters

inputId	the input number to retrieve
result	CameraInfo object for the specified camera input.

Returns

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::EncoderSettings::GetCurrentCameraInfo ( CameraInfo & result )

Retrieves the CameraInfo settings for the currently active camera input on the Encoder.

If the settings have already been fetched from the Encoder and have not been marked as invalid then the settings returned will be the current stored settings. Otherwise, the settings are fetched from the Encoder again.

Parameters

result object for the currently active camera input.

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 bool EdgeVisDecoderSDK::EncoderSettings::IsCameraInfoValid ( )

Determines if the cached camera input information for the Encoder is valid.

The settings are valid if they have been set before and if they have not been invalidated by a call to InvalidateCameraInfo.

Returns: True if the settings are valid, false otherwise.

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::EncoderSettings::InvalidateCameraInfo ( )

Invalidates the currently cached camera input information for the Encoder.

This means that the next time the camera input information is requested using one of the GetCameraInfo, GetCurrentCameraInfo or CameraInputs methods they will be refreshed by requesting them from the Encoder.

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::EncoderSettings::InvalidateUpdateSequenceNos ( )

Invalidates setting update sequence numbers.

This will cause the settings queries to re-register for settings update notifications the next time settings are requested.

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

Returns the Encoder object that the EncoderSettings object refers to.

Returns: The Encoder object used by this object.

DB_EDGEVIS_SDK VideoFrameLayout EdgeVisDecoderSDK::EncoderSettings::GetVideoFrameLayout ( int32_t input )

Returns the VideoFrameLayout describing the sources used to construct the received YCbCrFrame for the specified input.

Parameters

input The input index to retrieve the VideFrameLayout config for. If an invalid input is specified the returned object will have a type of VideoFrameLayout_Unknown.

Returns: The VideoFrameLayout object describing the composition of YCbCrFrames received from the specified input.

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::EncoderSettings::RegisterSettingsListener ( IEncoderSettingsListener * listener )

Registers the specified encoder settings listener from the set of listeners to be notified about Encoder settings changes.

Parameters

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

DB_EDGEVIS_SDK void EdgeVisDecoderSDK::EncoderSettings::UnregisterSettingsListener ( IEncoderSettingsListener * listener )

Removes the specified encoder settings listener from the set of listeners to be notified about Encoder settings changes.

Parameters

listener Pointer to the listening object to remove.

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

SDKs/EdgeVisDecoderSDK/EncoderSettings.h

Detailed Description

Encoder settings structure

Changing Settings

Availability

Public Member Functions

Member Function Documentation