How do I change and Encoders settings?

The Encoder has several settings available that can be modifiedm including bandwidth, video and audio settings.

Prerequisite: This example requires a Server and Encoder object

See EncoderSettings class for what can be changed.

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

• C++
• C#

//Get the encoder settings object
EncoderSettings settings = encoder.Settings();

//Get the current encoder profile
EncoderProfile profile; 
settings.GetCurrentProfile(profile);

//Get the video info for this profile
VideoProfileInfo video_profile = profile.GetVideoInfo();

//Make the required changes to the video profile

float targetFrameRate = 5.0f; //5fps
int frameStep = (int)( 25.0f / targetFrameRate );  // assume PAL video input (25fps max) 

video_profile.frameStep = frameStep;
video_profile.frameHeight = 480;
video_profile.frameWidth = 640;

//Set the updated profile settings back to the encoder profile
//Check the result to ensure the new settings are valid
bool setok = profile.SetVideoInfo(video_profile);

if (setok)
{
    //Get the settings modifier 
    SettingsModifier sm (settings);

    //Commit the new profile back to the encoder
    OpResult result = sm.Commit(profile);
}

//Get the encoder settings object
EncoderSettings settings = encoder.Settings();

if (settings != null)
{
  //Get the current encoder profile
  EncoderProfile profile = new EncoderProfile();
  settings.GetCurrentProfile(profile);

  if (profile != null)
  {
      //Get the video info for this profile
      VideoProfileInfo videoProfile = profile.GetVideoInfo();

      if (videoProfile != null)
      {
          //Make the required changes to the video profile

          float targetFrameRate = 5.0f; //5fps
          int frameStep = (int)(25.0f / targetFrameRate); //assume PAL video input (25fps max)

          videoProfile.frameStep = frameStep;
          videoProfile.frameHeight = 480;
          videoProfile.frameWidth = 640;

          //Set the updated profile settings back to the encoder profile
          //Check the result to ensure the new settings are valid
          bool setok = profile.SetVideoInfo(videoProfile);

          if (setok)
          {
              //Get the settings modifier
              SettingsModifier sm = new SettingsModifier(settings);

              //Commit the new profile back to the encoder
              OpResult result = sm.Commit(profile);
          }

      }
  }
}