←Select platform

CanSaveObjectSettings Method

Summary

Determines whether the specified settings can be saved.

Syntax

C++

public virtual bool CanSaveObjectSettings( 
   ConvertSettings flags 
)

Public Overridable Function CanSaveObjectSettings( _ 
   ByVal flags As Leadtools.Multimedia.ConvertSettings _ 
) As Boolean

public: 
virtual bool CanSaveObjectSettings(  
   Leadtools.Multimedia.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

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:\Program Files (x86)\LEAD Technologies\LEADTOOLS 19\Media"; 
}

Imports Leadtools 
Imports Leadtools.Multimedia 
Imports LeadtoolsMultimediaExamples.Fixtures 
 
Public _result As Boolean = False 
Public _form As ConvertCtrlForm = New ConvertCtrlForm() 
Public _convertctrl As ConvertCtrl 
 
Public _streamSettings As String = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_ObjectSettingsExample_Stream.xml") 
Public _fileSettings As String = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_ObjectSettingsExample.xml") 
 
Public Sub ObjectSettingsExample() 
   ' reference the play control 
   _convertctrl = _form.ConvertCtrl 
 
   ' input and output files 
   Dim inFile As String = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_Source.avi") 
   Dim outFile As String = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_ObjectSettingsExample.avi") 
 
   Try 
      Dim pVideoDizzy As Processor = _convertctrl.VideoProcessors.EFXDizzy 
      ' set a video processor 
      _convertctrl.SelectedVideoProcessors.Add(pVideoDizzy) 
 
      ' save the settings to a file 
      If SaveFileSettings() Then 
         ' now clear the selected processors again 
         _convertctrl.SelectedVideoProcessors.Clear() 
 
         ' check if a stream file exists 
         If File.Exists(_fileSettings) Then 
            ' load the saved settings from a file 
            ' and check if the processor is selected again 
            LoadFileSettings() 
 
            ' set the result  
            _result = _convertctrl.SelectedVideoProcessors.Contains(pVideoDizzy) 
         End If 
      End If 
 
      ' save the settings to a stream 
      If SaveStreamSettings() Then 
         ' now clear the selected processors again 
         _convertctrl.SelectedVideoProcessors.Clear() 
 
         ' check if a stream file exists 
         If File.Exists(_streamSettings) Then 
            ' load the saved settings from a stream  
            ' and check if the processor is selected again 
            LoadStreamSettings() 
 
            ' set the result  
            _result = _result And _convertctrl.SelectedVideoProcessors.Contains(pVideoDizzy) 
         End If 
      End If 
   Catch e1 As Exception 
      _result = False 
   End Try 
End Sub 
 
Private Sub LoadFileSettings() 
   _convertctrl.LoadSettingsFromFile(_fileSettings, ConvertSettings.Processors) 
End Sub 
 
Private Function SaveFileSettings() As Boolean 
   '  check if we can save the processor's settings 
   If _convertctrl.CanSaveObjectSettings(ConvertSettings.Processors) Then 
      _convertctrl.SaveSettingsToFile(_fileSettings, ConvertSettings.Processors) 
      Return True 
   End If 
   Return False 
End Function 
 
Private Sub LoadStreamSettings() 
   Dim settings As Stream = New StreamReader(_streamSettings).BaseStream 
   _convertctrl.LoadSettingsFromStream(settings, ConvertSettings.Processors) 
   settings.Close() 
End Sub 
 
Private Function SaveStreamSettings() As Boolean 
   '  check if we can save the processors settings 
   If _convertctrl.CanSaveObjectSettings(ConvertSettings.Processors) Then 
      Dim settings As Stream = New StreamWriter(_streamSettings, False).BaseStream 
      _convertctrl.SaveSettingsToStream(settings, ConvertSettings.Processors) 
      settings.Close() 
      Return True 
   End If 
   Return False 
End Function 
 
Public NotInheritable Class LEAD_VARS 
   Public Const MediaDir As String = "C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 19\Media" 
End Class

Requirements

Target Platforms

Reference

ConvertCtrl Class

ConvertCtrl Members

Help Version 19.0.2017.10.27

Leadtools.Multimedia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Multimedia Namespace

Leadtools.Multimedia.Common Namespace

Assemblies