CanSaveObjectSettings Method

Summary
Determines whether the specified settings can be saved.
Syntax
C#
C++/CLI
public virtual bool CanSaveObjectSettings( 
   ConvertSettings flags 
) 
public: 
virtual bool CanSaveObjectSettings(  
   ConvertSettings flags 
)  

Parameters

flags
A combination of ConvertSettings enumeration values.

Return Value

true if the specified Settings can be saved; false, if one or more of the settings can not be saved.

Remarks

The convert object settings can be saved to a stream by calling SaveSettingsToStream. These settings can also be saved to a file by calling SaveSettingsToFile. Settings saved to a file can be loaded using LoadSettingsFromFile. Settings saved to a stream can be loaded using LoadSettingsFromStream. It may be helpful to call CanSaveObjectSettings before calling either SaveSettingsToFile or SaveSettingsToStream, to make sure the settings you want to save can be saved. If either SaveSettingsToFile or SaveSettingsToStream is called for settings that cannot be saved, the save function will fail. Multiple settings can be combined in the Flags parameter using the OR operator.

Note: If multiple settings are combined in the flags parameter, all of the settings must be capable of being saved in order for this method to return true.

Example
C#
using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
 
public bool _result = false; 
public ConvertCtrlForm _form = new ConvertCtrlForm(); 
public ConvertCtrl _convertctrl; 
 
public string _streamSettings = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_ObjectSettingsExample_Stream.xml"); 
public string _fileSettings = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_ObjectSettingsExample.xml"); 
 
public void ObjectSettingsExample() 
{ 
   // reference the play control 
   _convertctrl = _form.ConvertCtrl; 
 
   // input and output files 
   string inFile = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_Source.avi"); 
   string outFile = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_ObjectSettingsExample.avi"); 
 
   try 
   { 
      Processor pVideoDizzy = _convertctrl.VideoProcessors.EFXDizzy; 
      // set a video processor 
      _convertctrl.SelectedVideoProcessors.Add(pVideoDizzy); 
 
      // save the settings to a file 
      if (SaveFileSettings()) 
      { 
         // now clear the selected processors again 
         _convertctrl.SelectedVideoProcessors.Clear(); 
 
         // check whether stream file exists 
         if (File.Exists(_fileSettings)) 
         { 
            // load the saved settings from a file 
            // and check whether the processor is selected again 
            LoadFileSettings(); 
 
            // set the result  
            _result = _convertctrl.SelectedVideoProcessors.Contains(pVideoDizzy); 
         } 
      } 
 
      // save the settings to a stream 
      if (SaveStreamSettings()) 
      { 
         // now clear the selected processors again 
         _convertctrl.SelectedVideoProcessors.Clear(); 
 
         // check whether the stream file exists 
         if (File.Exists(_streamSettings)) 
         { 
            // load the saved settings from a stream  
            // and check whether the processor is selected again 
            LoadStreamSettings(); 
 
            // set the result  
            _result &= _convertctrl.SelectedVideoProcessors.Contains(pVideoDizzy); 
         } 
      } 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
} 
 
private void LoadFileSettings() 
{ 
   _convertctrl.LoadSettingsFromFile(_fileSettings, ConvertSettings.Processors); 
} 
 
private bool SaveFileSettings() 
{ 
   //  check whether we can save the processors settings 
   if (_convertctrl.CanSaveObjectSettings(ConvertSettings.Processors)) 
   { 
      _convertctrl.SaveSettingsToFile(_fileSettings, ConvertSettings.Processors); 
      return true; 
   } 
   return false; 
} 
 
private void LoadStreamSettings() 
{ 
   Stream settings = new StreamReader(_streamSettings).BaseStream; 
   _convertctrl.LoadSettingsFromStream(settings, ConvertSettings.Processors); 
   settings.Close(); 
} 
 
private bool SaveStreamSettings() 
{ 
   //  check whether we can save the processors settings 
   if (_convertctrl.CanSaveObjectSettings(ConvertSettings.Processors)) 
   { 
      Stream settings = new StreamWriter(_streamSettings, false).BaseStream; 
      _convertctrl.SaveSettingsToStream(settings, ConvertSettings.Processors); 
      settings.Close(); 
      return true; 
   } 
   return false; 
} 
 
static class LEAD_VARS 
{ 
   public const string MediaDir = @"C:\LEADTOOLS23\Media"; 
} 
Requirements

Target Platforms

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Multimedia Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.