Detailed Description
The EncoderConfig interface contains the Encoder's global configuration settings.
This includes:
- 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
An EncoderConfig interface extends the EncoderSetting interface so it can be used to modify the Encoder's configuration settings using the SettingsModifier interface.
- Note
- Settings that are set to NOT_SET (-200) will not change when the configuration is applied.
Availability
Available in version 6.0 of Decoder SDK. Requires a server version greater than 6.0
#include <EncoderConfig.h>
Public Member Functions | |
| DB_EDGEVIS_SDK | EncoderConfig () |
| Creates a new EncoderConfig object. | |
| DB_EDGEVIS_SDK int32_t | VideoInput () const |
| Gets the current video input. More... | |
| DB_EDGEVIS_SDK bool | VideoInput (int32_t input) |
| Sets the current video input. More... | |
| DB_EDGEVIS_SDK CameraConfig | GetCameraConfig (int32_t input_id) const |
| Gets the camera configuration information. More... | |
| DB_EDGEVIS_SDK ColourInfo | GetColourInfo () const |
| Gets the video colour information. More... | |
| DB_EDGEVIS_SDK bool | SetColourInfo (const ColourInfo &ci) |
| Sets the video colour information. More... | |
| DB_EDGEVIS_SDK FilterInfo | GetFilterInfo () const |
| Gets the video filter information. More... | |
| DB_EDGEVIS_SDK bool | SetFilterInfo (const FilterInfo &fi) |
| Sets the video filter information. More... | |
| DB_EDGEVIS_SDK AudioInfo | GetAudioInfo () const |
| Gets the audio configuration information. More... | |
| DB_EDGEVIS_SDK bool | SetAudioInfo (const AudioInfo &ai) |
| Sets the audio configuration information. More... | |
| DB_EDGEVIS_SDK std::vector< std::wstring > | AvailableProfiles () |
| Gets the available connection profile names as a list. More... | |
| DB_EDGEVIS_SDK bool | SetAvailableProfiles (const std::vector< std::wstring > &names) |
| Sets the new list of available connection profile names. More... | |
| DB_EDGEVIS_SDK std::wstring | StaticGPSLocation () const |
| Gets the Encoder's static GPS location so it can be represented on a map without the need for a GPS device to be connected. More... | |
| DB_EDGEVIS_SDK bool | SetStaticGPSLocation (const std::wstring &loc) |
| Sets the Encoder's static GPS location so it can be represented on a map without the need for a GPS device to be connected. More... | |
| DB_EDGEVIS_SDK bool | GetGPSEnabled () const |
| Gets whether a GPS device is enabled for retrieving location information. More... | |
| DB_EDGEVIS_SDK bool | SetGPSEnabled (bool enabled) |
| Sets whether a GPS device is enabled for retrieving location information. More... | |
| DB_EDGEVIS_SDK std::wstring | ConnectionProfile () const |
| Gets the name of the currently active connection profile. More... | |
| DB_EDGEVIS_SDK std::wstring | TimeZoneID () const |
| Gets the Encoder's timezone ID. More... | |
| DB_EDGEVIS_SDK bool | SerialAlarmDeviceEnabled () const |
| Gets the enabled state of the serial alarm device. More... | |
| DB_EDGEVIS_SDK bool | RelayState () const |
| Gets the powered state of the relay (if the Encoder has one). More... | |
| DB_EDGEVIS_SDK bool | RelayState (bool powered) |
| Sets the powered state of the relay (if the Encoder has one). More... | |
| DB_EDGEVIS_SDK bool | GetRelayState (int8_t index) const |
| Gets the powered state of the relay with the specified index (if the Encoder has a corresponding relay). More... | |
| DB_EDGEVIS_SDK bool | SetRelayState (int8_t index, bool powered) |
| Sets the powered state of the relay with the specified index (if the Encoder has a corresponding relay). More... | |
| DB_EDGEVIS_SDK int32_t | CameraPower (int32_t camera) const |
| Gets the powered state of the camera if it is powered from the Encoder (S400 and TriStar Encoders only). More... | |
| DB_EDGEVIS_SDK bool | CameraPower (int32_t camera, int32_t pwr) |
| Sets the powered state of the camera if it is powered from the Encoder (S400 and TriStar Encoders only). More... | |
| DB_EDGEVIS_SDK bool | ArchiveRemotePlaybackEnabled () const |
| Gets the enabled state of remote archive playback. More... | |
| DB_EDGEVIS_SDK bool | LocalWifiEnabled () const |
| Gets the enabled state of the local Wifi connection if the Encoder supports it. More... | |
| DB_EDGEVIS_SDK LocalWifiDownloadInfo | GetLocalWifiDownloadInfo () const |
| Retrieves the encoder's local Wifi download information. More... | |
| DB_EDGEVIS_SDK bool | SetLocalWifiDownloadEnabled (bool enable) |
| Sets the enable state of the local Wifi download access point. More... | |
| DB_EDGEVIS_SDK AreaOfInterestConfig | GetAreaOfInterestConfig (const int32_t input) const |
| Retrieves the encoder's area of interest configuration information. More... | |
| DB_EDGEVIS_SDK bool | SetAreaOfInterestConfig (const AreaOfInterestConfig &aoi) |
| Sets the area of interest configuration information. More... | |
| DB_EDGEVIS_SDK bool | SetAnalyticsInfo (const AnalyticsInfo &ai) |
| Sets the analytics configuration information. More... | |
| DB_EDGEVIS_SDK bool | CanConfigureVideoAnalytics () const |
| Determine if this Decoder SDK can configure video analytics on this specific encoder using the GetVideoAnalyticsConfig() and SetVideoAnalyticsConfig() methods. More... | |
| DB_EDGEVIS_SDK int32_t | GetVideoAnalyticsVersion () const |
| Get the version of the currently configured video analytics config. More... | |
| DB_EDGEVIS_SDK VideoAnalyticsConfig | GetVideoAnalyticsConfig (const int32_t input) const |
| Gets the video analytics configuration. More... | |
| DB_EDGEVIS_SDK std::map< int32_t, VideoAnalyticsConfig > | GetVideoAnalyticsConfig () const |
| Get a map of the video analytics configuration for each available input. More... | |
| DB_EDGEVIS_SDK bool | SetVideoAnalyticsConfig (const int32_t input, const VideoAnalyticsConfig &config) |
| Sets the video analytics configuration. More... | |
| DB_EDGEVIS_SDK VideoCodecMode | GetCodecMode () const |
| Gets the current codec mode. More... | |
| DB_EDGEVIS_SDK bool | SetCodecMode (VideoCodecMode cm) |
| Sets the codec mode. More... | |
| DB_EDGEVIS_SDK std::wstring | GetPTZTours () |
| Gets the list of available PTZ tours for encoders that support the feature. More... | |
| DB_EDGEVIS_SDK bool | SetPTZTours (const std::wstring &tours) |
| Sets the list of available PTZ tours on the encoder. More... | |
| DB_EDGEVIS_SDK std::wstring | PrimaryConnection () |
| Gets the name of the primary connection set on the Encoder. More... | |
| DB_EDGEVIS_SDK std::wstring | BackupConnection () |
| Gets the name of the backup connection set on the Encoder. More... | |
| DB_EDGEVIS_SDK bool | PrimaryConnectionInUse () |
| Gets the status of the primary connection. More... | |
| DB_EDGEVIS_SDK bool | BackupConnectionInUse () |
| Gets the status of the backup connection. More... | |
| DB_EDGEVIS_SDK std::wstring | CommunicationMethod () |
| Gets the name of the current communication method Will return a string of the type of communication method in use. More... | |
| DB_EDGEVIS_SDK int32_t | GetSecureConnectBandwidthPercentage () const |
| Gets the percentage of the available bandwidth that may be used for Secure Connect. More... | |
| DB_EDGEVIS_SDK std::vector< SecureConnectEndpointConfig > | GetSecureConnectEndpoints () const |
| Returns the list of available SecureConnect end points. More... | |
| DB_EDGEVIS_SDK int64_t | GetResumeSleepTime () const |
| Returns the UTC timestamp at which the encoder will enter sleep. More... | |
| DB_EDGEVIS_SDK bool | SetResumeSleepTime (int64_t resume_sleep_time) |
| Sets the UTC timestamp at which the encoder will enter sleep. More... | |
| DB_EDGEVIS_SDK std::wstring | GetSerialAlarmDevice () const |
| Retrieve the name of the serial alarm device that is currently configured. More... | |
| DB_EDGEVIS_SDK bool | GetEdgeRecordingEnabled () const |
| Returns if edge recording is enabled for the encoder. More... | |
| DB_EDGEVIS_SDK bool | SetEdgeRecordingEnabled (bool enabled) |
| Set edge recording enabled or disabled for the encoder. More... | |
| DB_EDGEVIS_SDK bool | SupportsAlarmRecording () const |
| Returns whether or not the encoder is capable of indicating it is recording due to an alarm action. More... | |
| DB_EDGEVIS_SDK bool | GetAlarmRecording () const |
| Returns whether or not the encoder is recording due to an alarm action. More... | |
| DB_EDGEVIS_SDK bool | GetIridiumConfig (IridiumConfig &result) const |
| Get the Iridium configuration in use for this encoder. More... | |
| DB_EDGEVIS_SDK bool | GetBandwidthConfig (BandwidthConfig &bw_cfg) const |
| Get the bandwidth configuration for the encoder. More... | |
| DB_EDGEVIS_SDK bool | SetBandwidthConfig (const BandwidthConfig &bw_cfg) |
| Set the bandwidth configuration for the encoder. More... | |
| DB_EDGEVIS_SDK bool | GetStreamConfig (StreamConfig &stream_cfg) const |
| Get the stream configuration for the encoder. More... | |
| DB_EDGEVIS_SDK bool | SetStreamConfig (const StreamConfig &stream_cfg) |
| Set the stream configuration for the encoder. More... | |
| DB_EDGEVIS_SDK bool | GetReserveIdleStreamBandwidth () const |
| Get the reserve idle stream bandwidth configuration for the encoder. More... | |
| DB_EDGEVIS_SDK bool | SetReserveIdleStreamBandwidth (const bool reserve_idle) |
| Set the reserve idle stream bandwidth configuration for the encoder. More... | |
| DB_EDGEVIS_SDK bool | GetAudioOnlyEnabled () const |
| Gets whether an encoder is in audio only mode. More... | |
| virtual std::wstring | Name () const |
| Gets the name of the settings object. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::EncoderConfig::VideoInput | ( | ) | const |
Gets the current video input.
- Returns
- The current video input
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::VideoInput | ( | int32_t | input | ) |
Sets the current video input.
- Parameters
-
input The new video input. This must be >=-1 (all inputs for devices that support Timespace) or equal to the NOT_SET value.
- Returns
- True if the setting was set successfully, false otherwise.
| DB_EDGEVIS_SDK CameraConfig EdgeVisDecoderSDK::EncoderConfig::GetCameraConfig | ( | int32_t | input_id | ) | const |
Gets the camera configuration information.
- Parameters
-
input_id The encoder input to retrieve
- Returns
- Camera configuration information.
| DB_EDGEVIS_SDK ColourInfo EdgeVisDecoderSDK::EncoderConfig::GetColourInfo | ( | ) | const |
Gets the video colour information.
- Returns
- Video colour information.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetColourInfo | ( | const ColourInfo & | ci | ) |
Sets the video colour information.
- Parameters
-
ci The new video colour information. Any values that should not be modified from their current value should be set to the NOT_SET value.
- Returns
- True if the setting was set successfully, false otherwise.
| DB_EDGEVIS_SDK FilterInfo EdgeVisDecoderSDK::EncoderConfig::GetFilterInfo | ( | ) | const |
Gets the video filter information.
- Returns
- Video filter information.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetFilterInfo | ( | const FilterInfo & | fi | ) |
Sets the video filter information.
- Parameters
-
fi The new video filter information.
- Returns
- True if the setting was set successfully, false otherwise.
| DB_EDGEVIS_SDK AudioInfo EdgeVisDecoderSDK::EncoderConfig::GetAudioInfo | ( | ) | const |
Gets the audio configuration information.
- Returns
- Audio configuration information.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetAudioInfo | ( | const AudioInfo & | ai | ) |
Sets the audio configuration information.
- Parameters
-
ai The new audio configuration information. Valid values: enabled true or false volumeLeft >= 0 or NOT_SET volumeRight >= 0 or NOT_SET channels >= 0 or NOT_SET
- Returns
- True if the setting was set successfully, false otherwise.
| DB_EDGEVIS_SDK std::vector< std::wstring > EdgeVisDecoderSDK::EncoderConfig::AvailableProfiles | ( | ) |
Gets the available connection profile names as a list.
- Returns
- A list of available connection profile names.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetAvailableProfiles | ( | const std::vector< std::wstring > & | names | ) |
Sets the new list of available connection profile names.
- Parameters
-
names The new list of available connection profile names. The list must not be empty.
- Returns
- True if the setting was set successfully, false otherwise.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::EncoderConfig::StaticGPSLocation | ( | ) | const |
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetStaticGPSLocation | ( | const std::wstring & | loc | ) |
Sets the Encoder's static GPS location so it can be represented on a map without the need for a GPS device to be connected.
- Parameters
-
loc Comma separated String containing the WGS84 latitude and longitude of the Encoder. (e.g. 55.508738,-5.241748).
- Returns
- True if the setting was set successfully, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::GetGPSEnabled | ( | ) | const |
Gets whether a GPS device is enabled for retrieving location information.
- Returns
- True if a GPS device is enabled, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetGPSEnabled | ( | bool | enabled | ) |
Sets whether a GPS device is enabled for retrieving location information.
A GPS device must already be configured.
- Parameters
-
enabled True to enable use of the configured GPS device, false otherwise.
- Returns
- Always true.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::EncoderConfig::ConnectionProfile | ( | ) | const |
Gets the name of the currently active connection profile.
- Returns
- Name of the active connection profile.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::EncoderConfig::TimeZoneID | ( | ) | const |
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SerialAlarmDeviceEnabled | ( | ) | const |
Gets the enabled state of the serial alarm device.
- Returns
- True if a serial alarm device is in use, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::RelayState | ( | ) | const |
Gets the powered state of the relay (if the Encoder has one).
- Returns
- True if the relay is powered, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::RelayState | ( | bool | powered | ) |
Sets the powered state of the relay (if the Encoder has one).
- Parameters
-
powered True if the relay should be powered on, false if it should be off.
- Returns
- Always true.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::GetRelayState | ( | int8_t | index | ) | const |
Gets the powered state of the relay with the specified index (if the Encoder has a corresponding relay).
- Parameters
-
index The index of the relay to get the state of. Index values are zero based.
- Returns
- True if the relay is powered, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetRelayState | ( | int8_t | index, |
| bool | powered | ||
| ) |
Sets the powered state of the relay with the specified index (if the Encoder has a corresponding relay).
- Parameters
-
index The index of the relay to set. Index values are zero based. powered True if the relay should be powered on, false if it should be off.
- Returns
- True if the encoder supports the relay requested, false otherwise.
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::EncoderConfig::CameraPower | ( | int32_t | camera | ) | const |
Gets the powered state of the camera if it is powered from the Encoder (S400 and TriStar Encoders only).
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::CameraPower | ( | int32_t | camera, |
| int32_t | pwr | ||
| ) |
Sets the powered state of the camera if it is powered from the Encoder (S400 and TriStar Encoders only).
- Parameters
-
camera The zero-based camera input to check the state of. 0 = Camera 1, 1 = Camera 2. pwr The new camera power setting. 1 = Camera power off, 2 = Camera powered when it is being viewed, 3 = Camera always powered.
- Returns
- True if a valid camera input was specified, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::ArchiveRemotePlaybackEnabled | ( | ) | const |
Gets the enabled state of remote archive playback.
- Returns
- True if remote archive playback is enabled, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::LocalWifiEnabled | ( | ) | const |
Gets the enabled state of the local Wifi connection if the Encoder supports it.
- Returns
- True if local Wifi is enabled, false otherwise.
| DB_EDGEVIS_SDK LocalWifiDownloadInfo EdgeVisDecoderSDK::EncoderConfig::GetLocalWifiDownloadInfo | ( | ) | const |
Retrieves the encoder's local Wifi download information.
- Returns
- Local Wifi download configuration information.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetLocalWifiDownloadEnabled | ( | bool | enable | ) |
Sets the enable state of the local Wifi download access point.
Note that this is only settable if the local Wifi download mode is set to Switched mode.
- Parameters
-
enable True to enable use of the local Wifi download access point, false otherwise.
- Returns
- True if sets, False if not available or not set to switched
| DB_EDGEVIS_SDK AreaOfInterestConfig EdgeVisDecoderSDK::EncoderConfig::GetAreaOfInterestConfig | ( | const int32_t | input | ) | const |
Retrieves the encoder's area of interest configuration information.
- Parameters
-
input The input to retrieve the area of interest config for. If the encoder does not support per-input area of interest the input field is ignored.
- Returns
- Area of interest configuration information. If the encoder does not support per-input area of interest the input index will be set to -1.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetAreaOfInterestConfig | ( | const AreaOfInterestConfig & | aoi | ) |
Sets the area of interest configuration information.
- Parameters
-
aoi The new area of interest configuration information. Valid values: enabled = true or false rows = 9 columns = 11 bandwidthBias = a value in the range 0-32 inclusive regionMap must have rows * columns entries. An element shall contain a 1 for an area to be included in the area of interest, or 0 for an area to be excluded.
- Returns
- True if the setting was set successfully, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetAnalyticsInfo | ( | const AnalyticsInfo & | ai | ) |
Sets the analytics configuration information.
- Parameters
-
ai The new analytics configuration information. Valid values: sensitivity 0.0 -> 1.0 min_width >= 0.015 min_height >= 0.1 max_width <= 0.75 max_height <= 0.75 max_width >= min_width max_height >= min_height
- Returns
- True if the setting was set successfully, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::CanConfigureVideoAnalytics | ( | ) | const |
Determine if this Decoder SDK can configure video analytics on this specific encoder using the GetVideoAnalyticsConfig() and SetVideoAnalyticsConfig() methods.
- Returns
- True if this Decoder SDK is capable of configuring video analytics on this encoder, false otherwise.
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::EncoderConfig::GetVideoAnalyticsVersion | ( | ) | const |
Get the version of the currently configured video analytics config.
- Returns
- The version number for the currently configured video analytics, or -1 if nto avialable.
| DB_EDGEVIS_SDK VideoAnalyticsConfig EdgeVisDecoderSDK::EncoderConfig::GetVideoAnalyticsConfig | ( | const int32_t | input | ) | const |
Gets the video analytics configuration.
- Parameters
-
The input to retreive the video analytics config for.
- Returns
- The current video analytics configuration.
| DB_EDGEVIS_SDK std::map<int32_t, VideoAnalyticsConfig> EdgeVisDecoderSDK::EncoderConfig::GetVideoAnalyticsConfig | ( | ) | const |
Get a map of the video analytics configuration for each available input.
- Returns
- A map of input index to the corresponding video analytics config.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetVideoAnalyticsConfig | ( | const int32_t | input, |
| const VideoAnalyticsConfig & | config | ||
| ) |
Sets the video analytics configuration.
- Parameters
-
config The new video analytics configuration information.
- Returns
- True if the setting was set successfully, false otherwise.
| DB_EDGEVIS_SDK VideoCodecMode EdgeVisDecoderSDK::EncoderConfig::GetCodecMode | ( | ) | const |
Gets the current codec mode.
This determines whether the encoder configuration will use a static frame rate and dynamic frame size, or a static frame size and dynamic frame rate. In static frame rate, dynamic frame size mode the frame rate can be manually configured in the encoder profile. In static frame size, dynamic frame rate mode the frame size can be manually configured in the encoder profile.
- Returns
- The current codec mode. This will return VCM_NotSupported for any encoders that do not support this feature.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetCodecMode | ( | VideoCodecMode | cm | ) |
Sets the codec mode.
This determines whether the encoder configuration will use a static frame rate and dynamic frame size, or a static frame size and dynamic frame rate. In static frame rate, dynamic frame size mode the frame rate can be manually configured in the encoder profile. In static frame size, dynamic frame rate mode the frame size can be manually configured in the encoder profile.
- Parameters
-
cm The new codec mode. This must be a valid value and cannot be set to VCM_NotSupported.
- Returns
- True if the codec mode was valid and the encoder supports this feature, false otherwise.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::EncoderConfig::GetPTZTours | ( | ) |
Gets the list of available PTZ tours for encoders that support the feature.
- Returns
- A coma separated string of the available tours.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetPTZTours | ( | const std::wstring & | tours | ) |
Sets the list of available PTZ tours on the encoder.
- Parameters
-
tours tours to set
- Returns
- True if the setting was set successfully, false otherwise.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::EncoderConfig::PrimaryConnection | ( | ) |
Gets the name of the primary connection set on the Encoder.
- Returns
- The name of the primary connection
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::EncoderConfig::BackupConnection | ( | ) |
Gets the name of the backup connection set on the Encoder.
- Returns
- The name of the backup connection
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::PrimaryConnectionInUse | ( | ) |
Gets the status of the primary connection.
- Returns
- True if the primary is currently being used. False otherwise;
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::BackupConnectionInUse | ( | ) |
Gets the status of the backup connection.
- Returns
- True if the backup is currently being used. False otherwise;
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::EncoderConfig::CommunicationMethod | ( | ) |
Gets the name of the current communication method Will return a string of the type of communication method in use.
e.g. "Wireless LAN" or "3G Modem"
- Returns
- The name of the connection
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::EncoderConfig::GetSecureConnectBandwidthPercentage | ( | ) | const |
Gets the percentage of the available bandwidth that may be used for Secure Connect.
- Returns
- The percentage of the available bandwidth to use.
| DB_EDGEVIS_SDK std::vector< SecureConnectEndpointConfig > EdgeVisDecoderSDK::EncoderConfig::GetSecureConnectEndpoints | ( | ) | const |
Returns the list of available SecureConnect end points.
- Returns
- A collection of SecureConnectEndpointConfig.
| DB_EDGEVIS_SDK int64_t EdgeVisDecoderSDK::EncoderConfig::GetResumeSleepTime | ( | ) | const |
Returns the UTC timestamp at which the encoder will enter sleep.
- Returns
- The UTC timestamp in ms that the encoder will enter sleep at.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetResumeSleepTime | ( | int64_t | resume_sleep_time | ) |
Sets the UTC timestamp at which the encoder will enter sleep.
- Parameters
-
resume_sleep_time UTC timestamp in ms that the encoder should go back to sleep.
- Returns
- True if the setting was set successfully, false otherwise.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::EncoderConfig::GetSerialAlarmDevice | ( | ) | const |
Retrieve the name of the serial alarm device that is currently configured.
- Returns
- The name of the serial alarm device currently configured. Expected values are rdc, 7tech, qualtron or an empty string.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::GetEdgeRecordingEnabled | ( | ) | const |
Returns if edge recording is enabled for the encoder.
Note that if an encoder is using an external archive or there is no media present this value will not necessarily reflect the current recording state.
- Returns
- True if edge recording is enabled, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetEdgeRecordingEnabled | ( | bool | enabled | ) |
Set edge recording enabled or disabled for the encoder.
Note that if an encoder is using an external archive or there is no media present setting this value will not cause recording to start.
- Parameters
-
enabled True to enable edge recording, false to disable edge recording.
- Returns
- Always true.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SupportsAlarmRecording | ( | ) | const |
Returns whether or not the encoder is capable of indicating it is recording due to an alarm action.
- Returns
- True if the encoder can report it is recording due to an alarm action, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::GetAlarmRecording | ( | ) | const |
Returns whether or not the encoder is recording due to an alarm action.
Note that if an encoder is using an external archive or there is no media present this value will not necessarily reflect the current recording state.
- Returns
- True if the encoder is recording due to an alarm action, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::GetIridiumConfig | ( | IridiumConfig & | result | ) | const |
Get the Iridium configuration in use for this encoder.
- Parameters
-
result The Iridium configuraton in use
- Returns
- True if the IridiumConfig has been retrieved successfully, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::GetBandwidthConfig | ( | BandwidthConfig & | bw_cfg | ) | const |
Get the bandwidth configuration for the encoder.
Note that for multi-stream encoders the BandwidthConfig object returned applies to all of the streams.
- Parameters
-
bw_cfg The BandwidthConfig for the encoder. If the encoder is multi-stream capable then this config applies to all of the streams on the encoder.
- Returns
- True if the BandwidthConfig has been retrieved successfully, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetBandwidthConfig | ( | const BandwidthConfig & | bw_cfg | ) |
Set the bandwidth configuration for the encoder.
Note that for multi-stream encoders the BandwidthConfig supplied will be applied to all of the streams.
- Parameters
-
bw_cfg The BandwidthConfig to apply to the encoder. If the encoder is multi-stream capable then this config will be apoplied to all of the streams on the encoder.
- Returns
- True if the BandwidthConfig has been set successfully, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::GetStreamConfig | ( | StreamConfig & | stream_cfg | ) | const |
Get the stream configuration for the encoder.
- Parameters
-
stream_cfg The StreamConfig for the encoder.
- Returns
- True if the StreamConfig has been retrieved successfully, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetStreamConfig | ( | const StreamConfig & | stream_cfg | ) |
Set the stream configuration for the encoder.
- Parameters
-
stream_cfg The StreamConfig to apply to the encoder.
- Returns
- True if the StreamConfig has been set successfully, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::GetReserveIdleStreamBandwidth | ( | ) | const |
Get the reserve idle stream bandwidth configuration for the encoder.
When enabled on multi-stream encoders this allows bandwidth allocated to other streams to be reallocated to active streams.
- Returns
- True if the reserve idle stream bandwidth is enabled, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::SetReserveIdleStreamBandwidth | ( | const bool | reserve_idle | ) |
Set the reserve idle stream bandwidth configuration for the encoder.
When enabled on multi-stream encoders this allows bandwidth allocated to other streams to be reallocated to active streams.
- Parameters
-
reserve_idle Set true to reserve idle stream bandwidth, false to allow .
- Returns
- True if the StreamConfig has been set successfully, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderConfig::GetAudioOnlyEnabled | ( | ) | const |
Gets whether an encoder is in audio only mode.
This is a supported mode on BW encoders.
- Returns
- True if an encoder has audio only mode enabled, false otherwise.
|
inlinevirtual |
Gets the name of the settings object.
The settings object will have a unique name.
- Returns
- The name of the settings object..
Implements EdgeVisDecoderSDK::ISettings.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/EncoderConfig.h