Detailed Description
The EncoderProfile interface contains Encoder connection profile settings.
A connection profile represents the settings an Encoder uses for a chosen network. For example, an Encoder connected to a LAN network may display video at a high resolution and high frame rate since bandwidth is not limited, whereas an Encoder connected to a mobile network (e.g. GPRS) has limited bandwidth so the video resolution and frame rate need to be reduced to compensate for this.
Encoder profile settings include:
- Profile Name (e.g. LAN)
- Bandwidth Settings
- Audio Profile Settings
- Video Profile Settings
An EncoderProfile interface extends the EncoderSetting interface
Changing Settings
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 <EncoderProfile.h>
Public Member Functions | |
| DB_EDGEVIS_SDK | EncoderProfile () |
| Creates a new EncoderProfile object. | |
| DB_EDGEVIS_SDK std::wstring | ProfileName () const |
| Gets the profile's name. More... | |
| DB_EDGEVIS_SDK EncoderSettings | GetSettings () const |
| Gets the current Encoder settings. More... | |
| DB_EDGEVIS_SDK BandwidthProfileInfo | GetBandwidthInfo () const |
| Gets the bandwidth information from the profile. More... | |
| DB_EDGEVIS_SDK AudioProfileInfo | GetAudioInfo () const |
| Gets the audio information from the profile. More... | |
| DB_EDGEVIS_SDK VideoProfileInfo | GetVideoInfo () const |
| Gets the video information from the profile. More... | |
| DB_EDGEVIS_SDK bool | SetProfileName (const std::wstring &pn) |
| Sets the profile's name. More... | |
| DB_EDGEVIS_SDK bool | SetBandwidthInfo (const BandwidthProfileInfo &bi) |
| Sets the profile's bandwidth information. More... | |
| DB_EDGEVIS_SDK bool | SetAudioInfo (const AudioProfileInfo &ai) |
| Sets the profile's audio information. More... | |
| DB_EDGEVIS_SDK bool | SetVideoInfo (const VideoProfileInfo &vi) |
| Sets the profile's video information. More... | |
| DB_EDGEVIS_SDK std::vector< int32_t > | GetAvailableFrameStepValues () |
| Retrieve a list of valid frame step values for this encoder. More... | |
| DB_EDGEVIS_SDK std::vector< std::pair< int32_t, int32_t > > | GetAvailableFrameSizeValues () |
| Retrieve a list of valid frame dimensions values for this encoder. More... | |
| virtual DB_EDGEVIS_SDK std::wstring | Name () const |
| Gets the name of the settings object. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::EncoderProfile::ProfileName | ( | ) | const |
Gets the profile's name.
- Returns
- The name of the profile.
| DB_EDGEVIS_SDK EncoderSettings EdgeVisDecoderSDK::EncoderProfile::GetSettings | ( | ) | const |
Gets the current Encoder settings.
- Returns
- The current EncoderSettings object
| DB_EDGEVIS_SDK BandwidthProfileInfo EdgeVisDecoderSDK::EncoderProfile::GetBandwidthInfo | ( | ) | const |
Gets the bandwidth information from the profile.
- Returns
- BandwidthProfileInfo containing the profile's bandwidth information.
| DB_EDGEVIS_SDK AudioProfileInfo EdgeVisDecoderSDK::EncoderProfile::GetAudioInfo | ( | ) | const |
Gets the audio information from the profile.
- Returns
- AudioProfileInfo containing the profile's audio information.
| DB_EDGEVIS_SDK VideoProfileInfo EdgeVisDecoderSDK::EncoderProfile::GetVideoInfo | ( | ) | const |
Gets the video information from the profile.
- Returns
- VideoProfileInfo containing the profile's video information.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderProfile::SetProfileName | ( | const std::wstring & | pn | ) |
Sets the profile's name.
- Parameters
-
pn The new profile name. The name must not be blank.
- Returns
- True if the setting was set successfully, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderProfile::SetBandwidthInfo | ( | const BandwidthProfileInfo & | bi | ) |
Sets the profile's bandwidth information.
- Parameters
-
bi The new bandwidth configuration information.
Valid values:
- maxBandwidth >= 5000 or NOT_SET
- maxBandwidth <= 2000000 or NOT_SET
- minBandwidth >= 2000 or NOT_SET
- maxBandwidth >= minBandwidth
- channelBandwidth >= maxBandwidth
- Returns
- True if the setting was set successfully, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderProfile::SetAudioInfo | ( | const AudioProfileInfo & | ai | ) |
Sets the profile's audio information.
- Parameters
-
ai The new audio configuration information. Valid values: - enableAudio true or false
- audioMode >= 0 or NOT_SET
- audioQuality >= 0 or NOT_SET
- Returns
- True if the setting was set successfully, false otherwise.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::EncoderProfile::SetVideoInfo | ( | const VideoProfileInfo & | vi | ) |
Sets the profile's video information.
- Parameters
-
vi The new video configuration information. Valid values: - frameStep must be a value from the list provided by GetAvailableFrameStepValues
- height and width must be a pair of values from the list provided by GetAvailableFrameSizeValues
- Returns
- True if the setting was set successfully, false otherwise.
| DB_EDGEVIS_SDK std::vector<int32_t> EdgeVisDecoderSDK::EncoderProfile::GetAvailableFrameStepValues | ( | ) |
Retrieve a list of valid frame step values for this encoder.
- Returns
- A vector of frame step values that are valid for this encoder.
| DB_EDGEVIS_SDK std::vector<std::pair<int32_t, int32_t> > EdgeVisDecoderSDK::EncoderProfile::GetAvailableFrameSizeValues | ( | ) |
Retrieve a list of valid frame dimensions values for this encoder.
- Returns
- A vector of frame dimensions values that are valid for this encoder. Each vector element is a pair containing a supported frame height and width.
|
virtual |
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/EncoderProfile.h