Detailed Description
Certain Encoder settings can be obtained and modified through viewer applications using the SDK.
The Encoder settings fall into the following categories:
Accessing Encoder Settings
- Configuration settings: see EncoderConfig.
- e.g. Current video input, video colour settings, global audio settings, current connection profile.
- Connection profile settings: see EncoderProfile.
- e.g. Bandwidth settings, video frame rate and dimensions, profile specific audio settings.
- Camera input settings: see CameraInfo.
- e.g. Camera PTZ information.
The Encoder Settings can be obtained through the Settings property on an Encoder interface. This will return an EncoderSettings interface object that can be used to obtain any of the above settings.
Modifying Encoder Settings
The settings that can be obtained from an EncoderSettings interface represent the current known configuration for an Encoder. For this reason the EncoderSettings class is immutable and the settings it returns will only change once new settings have been applied successfully on the Encoder itself. To modify the Encoder's settings the SettingsModifier interface must be used. An instance of the SettingsModifier interface can be obtained by calling the ModifySettings() method on the EncoderSettings interface. Using the SettingsModifier interface the settings objects listed above can be modified then applied to the Encoder by calling Commit and passing the setting object as a parameter. This will send a request to the Encoder containing the updated settings to allow it to apply the new settings. If the settings change was actioned successfully then the next time the settings are requested from the EncoderSettings interface the settings returned will reflect the recent changes.
Encoder Settings Update Notifications
The EncoderSettings interface holds a cache of the Encoder's settings so that it does not need to re-request the settings from the Encoder every time they are required. If the Encoder's settings are changed by another application it is possible that this cache then becomes out of date and no longer reflects the Encoder's current configuration. There are 2 possible ways of handling this:
The user may call one of the Invalidate functions on the EncoderSettings interface, which causes the cached setting(s) to be cleared.The settings will be fetched from the Encoder again the next time they are requested. This relies on the User knowing that the settings have changed. 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. The application is notified about settings update notifications through the SettingsUpdated event method in the IEncoderListener interface.
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:
- EncoderConfig
- CameraInfo
- EncoderProfile
- 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.
Example
A snippet of Sample applications
Files | |
| file | ConfigTypes.h |
| Contains the structs used in the Encoder settings. | |
| file | EncoderInfo.h |
| file | AudioSource.h |
| This enum is used with the StreamConfig class to enable audio sources for the media stream. | |
Classes | |
| struct | BandwidthProfileInfo |
| The Bandwidth profile info as used in the EncoderProfile object. More... | |
| struct | AudioProfileInfo |
| The audio profile info as used in the EncoderProfile object. More... | |
| struct | VideoProfileInfo |
| The video profile info as used in the EncoderProfile object. More... | |
| class | EdgeVisDecoderSDK::AnalyticsConfig |
| Defines the analytics configuration to use for a video input. More... | |
| class | EdgeVisDecoderSDK::AnalyticsInfo |
| Defines the type of analytics that the encoder will use and the configuration for each video input that will use these analytics. More... | |
| class | EdgeVisDecoderSDK::AnalyticsRegion |
| Defines a region within the video frame within which the analytics will be applied. More... | |
| class | EdgeVisDecoderSDK::AnalyticsRegionVertex |
| Defines a vertex within the video frame. More... | |
| class | EdgeVisDecoderSDK::EncoderConfig |
| The EncoderConfig interface contains the Encoder's global configuration settings. More... | |
| class | EdgeVisDecoderSDK::EncoderSettings |
| The EncoderSettings interface provides access to an Encoder's configuration, connection profile and camera settings. More... | |
| class | EdgeVisDecoderSDK::EncoderSettingsChangeInfo |
| Describes the Encoder settings that have been changed. More... | |
| class | EdgeVisDecoderSDK::ISettings |
| Definition of the ISettings interface class. More... | |
| class | EdgeVisDecoderSDK::SettingsModifier |
| The settings modifier is used to change the settings on an Encoder. More... | |
| class | EdgeVisSDKCore::AreaOfInterestConfig |
| Defines the area of interest configuration to use for a video input. More... | |
| class | EdgeVisSDKCore::BandwidthConfig |
| Defines the bandwidth configuration to use for an encoder. More... | |
| class | EdgeVisSDKCore::ConnectionProfile |
AvailabilityMore... | |
| class | EdgeVisSDKCore::IridiumConfig |
| Defines the Iridium configuration in use for an encoder. More... | |
| class | EdgeVisSDKCore::SecureConnectEndpointConfig |
AvailabilityMore... | |
| class | EdgeVisSDKCore::StreamConfig |
| Class to allow for configuring the streaming characteristics of an Encoder. More... | |
Typedefs | |
| typedef enum AnalyticsConfigMode | AnalyticsConfigMode |
| The possible modes for analytics to operate in. | |
| typedef struct BandwidthProfileInfo | BandwidthProfileInfo |
| The Bandwidth profile info as used in the EncoderProfile object. More... | |
| typedef struct AudioProfileInfo | AudioProfileInfo |
| The audio profile info as used in the EncoderProfile object. More... | |
| typedef struct VideoProfileInfo | VideoProfileInfo |
| The video profile info as used in the EncoderProfile object. More... | |
Enumerations |
Typedef Documentation
| typedef struct BandwidthProfileInfo BandwidthProfileInfo |
The Bandwidth profile info as used in the EncoderProfile object.
| typedef struct AudioProfileInfo AudioProfileInfo |
The audio profile info as used in the EncoderProfile object.
| typedef struct VideoProfileInfo VideoProfileInfo |
The video profile info as used in the EncoderProfile object.
Enumeration Type Documentation
| enum AnalyticsConfigMode |
| enum ProfilePreset |