EdgeVisDecoderSDK::SettingsModifier Class Reference
Detailed Description
The settings modifier is used to change the settings on an Encoder.
The general steps required are:
- Obtain an EncoderSettings object by calling the Settings property on the Encoder object.
- Obtain the Config object required from the EncoderSettings object. Available objects are:
- Modify the setting you want to change
- Obtain the SettingsModifier object
- Call Commit on the SettingsModifier object passing the updated settings object as a parameter to apply the new settings to the Encoder.
Examples
This code example will show how to change the settings on an encoder.
#include <SettingsModifier.h>
Public Member Functions | |
| DB_EDGEVIS_SDK | SettingsModifier (EncoderSettings settings) |
| Creates a new SettingsModifier object that will be used to modify settings on the specified Encoder. More... | |
| DB_EDGEVIS_SDK OpResult | Commit (const EncoderConfig &cfg) |
| Applies Encoder configuration changes. More... | |
| DB_EDGEVIS_SDK OpResult | Commit (const EncoderProfile &profile) |
| Applies Encoder connection profile changes. More... | |
| DB_EDGEVIS_SDK OpResult | Commit (const std::vector< EncoderProfile > &profiles) |
| Applies Encoder connection profile changes for multiple profiles. More... | |
| DB_EDGEVIS_SDK OpResult | Commit (const CameraInfo &ci) |
| Applies Encoder camera information setting changes. More... | |
Constructor & Destructor Documentation
| DB_EDGEVIS_SDK EdgeVisDecoderSDK::SettingsModifier::SettingsModifier | ( | EncoderSettings | settings | ) |
Creates a new SettingsModifier object that will be used to modify settings on the specified Encoder.
- Parameters
-
settings Pointer to the Encoder object whose settings are to be modified.
Member Function Documentation
| DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::SettingsModifier::Commit | ( | const EncoderConfig & | cfg | ) |
Applies Encoder configuration changes.
- Parameters
-
cfg The EncoderConfig object containing the configuration changes to apply.
- Returns
- OpResult
Potential OpResults Returned
- OR_Success
- OR_ConnectionFailed
- OR_NotConnected (Encoder is not connected to the server. Unable to set updated encoder config)
- OR_LicenseError (There are not enough licenses on this encoder to configure Analytics on this input)
- OR_PermissionDenied (not allowed to set settings)
- OR_EncoderNotSupported (Encoder is too old)
- OR_NotSupported (If Analytics, not supported type)
| DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::SettingsModifier::Commit | ( | const EncoderProfile & | profile | ) |
Applies Encoder connection profile changes.
- Parameters
-
profile The EncoderProfile object containing the connection profile changes to apply.
- Returns
- OpResult
Potential OpResults Returned
- OR_Success
- OR_ConnectionFailed
- OR_NotConnected (Encoder is not connected to the server. Unable to set encoder profile)
- OR_PermissionDenied (not allowed to set settings)
- OR_InvalidProfileName (Incorrect profile name provided. Unable to set encoder profile)
- OR_SettingNotValid (Incorrect profile name provided. Unable to set encoder profile)
- OR_Failed (No server object has been instantiated, programmer error)
| DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::SettingsModifier::Commit | ( | const std::vector< EncoderProfile > & | profiles | ) |
Applies Encoder connection profile changes for multiple profiles.
- Parameters
-
profiles The list of EncoderProfile objects containing the connection profile changes to apply.
| DB_EDGEVIS_SDK OpResult EdgeVisDecoderSDK::SettingsModifier::Commit | ( | const CameraInfo & | ci | ) |
Applies Encoder camera information setting changes.
At present the only camera information that can be changed from the SDK is the PTZ preset information.
- Parameters
-
ci The CameraInfo object containing the new camera information to be set.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/SettingsModifier.h