EdgeVisEncoderSDK::EncoderProfile Class Reference

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

Use

  • Retrieve the available profiles from the GetProfiles method on the Encoder object
  • From the list select the EnocderProfile to be modified
  • Once modified call the SetProfile method on the Encoder object

Switching Profiles

  • Retrieve the name of the current profile by using the GetCurrentProfile on the encoder object
  • Set the profile to apply to the encoder by calling the SetCurrentProfile on the encoder object. The profile settings will be applied to the Encoder.

Remote changes

Profiles can be updated remotely. Subscribe to the IRemoteConfigListener to be notified of remote changed

Availability

Available in version 6.5 of Encoder SDK. Requires a server version greater than 6.5

#include <EncoderProfile.h>

Public Member Functions

DB_EDGEVIS_SDK std::wstring ProfileName () const
 Get the profiles name. More...
 
DB_EDGEVIS_SDK BandwidthProfileInfo GetBandwidthInfo () const
 Get the bandwidth profile object. More...
 
DB_EDGEVIS_SDK bool SetBandwidthInfo (const BandwidthProfileInfo &bandwidthProfile)
 Set the bandwidth profile object. More...
 
DB_EDGEVIS_SDK AudioProfileInfo GetAudioInfo () const
 Get the audio profile object. More...
 
DB_EDGEVIS_SDK bool SetAudioInfo (const AudioProfileInfo &audioProfile)
 Set the audio profile object. More...
 
DB_EDGEVIS_SDK VideoProfileInfo GetVideoInfo () const
 Get the video profile object. More...
 
DB_EDGEVIS_SDK bool SetVideoInfo (const VideoProfileInfo &videoProfile)
 Set the video profile object. More...
 

Member Function Documentation

DB_EDGEVIS_SDK std::wstring EdgeVisEncoderSDK::EncoderProfile::ProfileName ( ) const

Get the profiles name.

Returns
The name of the profile
DB_EDGEVIS_SDK BandwidthProfileInfo EdgeVisEncoderSDK::EncoderProfile::GetBandwidthInfo ( ) const

Get the bandwidth profile object.

Returns
The BandwidthProfileInfo for this profile
DB_EDGEVIS_SDK bool EdgeVisEncoderSDK::EncoderProfile::SetBandwidthInfo ( const BandwidthProfileInfo bandwidthProfile)

Set the bandwidth profile object.

Parameters
bandwidthProfileThe bandwidth profile to set
DB_EDGEVIS_SDK AudioProfileInfo EdgeVisEncoderSDK::EncoderProfile::GetAudioInfo ( ) const

Get the audio profile object.

Returns
The AudioProfileInfo for this profile
DB_EDGEVIS_SDK bool EdgeVisEncoderSDK::EncoderProfile::SetAudioInfo ( const AudioProfileInfo audioProfile)

Set the audio profile object.

Parameters
audioProfileThe audio profile to set
DB_EDGEVIS_SDK VideoProfileInfo EdgeVisEncoderSDK::EncoderProfile::GetVideoInfo ( ) const

Get the video profile object.

Returns
The VideoProfileInfo for this profile
DB_EDGEVIS_SDK bool EdgeVisEncoderSDK::EncoderProfile::SetVideoInfo ( const VideoProfileInfo videoProfile)

Set the video profile object.

Parameters
videoProfileThe video profile to set

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