SaveSettingsToStream Method (PlayCtrl)

Saves some or all of the play object settings to a stream.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overridable Sub SaveSettingsToStream( _
   ByVal targetStream As Stream, _
   ByVal flags As PlaySettings _
)

'Usage
 
Dim instance As PlayCtrl
Dim targetStream As Stream
Dim flags As PlaySettings
 
instance.SaveSettingsToStream(targetStream, flags)

public virtual void SaveSettingsToStream( 
   Stream targetStream,
   PlaySettings flags
)

public:
virtual void SaveSettingsToStream( 
   Stream^ targetStream,
   PlaySettings flags
)

Parameters

targetStream: The stream to which settings will be saved.
flags: The PlaySettings enumeration values specifying which settings to save.

Remarks

Play object settings can be saved to a file by calling SaveSettingsToFile. If either PlayCtrl.SaveSettingsToFile or PlayCtrl.SaveSettingsToStream is called for settings that cannot be saved, the save method will fail. Call CanSaveObjectSettings before calling the save methods to make sure the settings can be saved. Saved settings can be loaded using the LoadSettingsFromFile method or the LoadSettingsFromStream method.

Example

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.Multimedia
Imports LeadtoolsMultimediaExamples.Fixtures

Public _result As Boolean = False
Public _form As PlayCtrlForm = New PlayCtrlForm()
Public _playctrl As PlayCtrl
Public _streamSettings As String = Path.Combine(LEAD_VARS.MediaDir, "PlayCtrl_ObjectSettingsExample_Stream.xml")
Public _fileSettings As String = Path.Combine(LEAD_VARS.MediaDir, "PlayCtrl_ObjectSettingsExample.xml")

Public Sub ObjectSettingsExample()
   ' reference the play control
   _playctrl = _form.PlayCtrl

   ' input files
   Dim inFile As String = Path.Combine(LEAD_VARS.MediaDir, "PlayCtrl_Source.avi")

   Try
      Dim pVideoDizzy As Processor = _playctrl.VideoProcessors.EFXDizzy
      ' set a video processor
      _playctrl.SelectedVideoProcessors.Add(pVideoDizzy)

      ' save the settings to a file
      If SaveFileSettings() Then
         ' now clear the selected processors again
         _playctrl.SelectedVideoProcessors.Clear()

         ' check if 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 = _playctrl.SelectedVideoProcessors.Contains(pVideoDizzy)
         End If
      End If

      ' save the settings to a stream
      If SaveStreamSettings() Then
         ' now clear the selected processors again
         _playctrl.SelectedVideoProcessors.Clear()

         ' check if 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 _playctrl.SelectedVideoProcessors.Contains(pVideoDizzy)
         End If
      End If
   Catch e1 As Exception
      _result = False
   End Try
End Sub

Private Sub LoadFileSettings()
   _playctrl.LoadSettingsFromFile(_fileSettings, PlaySettings.Processors)
End Sub

Private Function SaveFileSettings() As Boolean
   '  check if we can save the processors settings
   If _playctrl.CanSaveObjectSettings(PlaySettings.Processors) Then
      _playctrl.SaveSettingsToFile(_fileSettings, PlaySettings.Processors)
      Return True
   End If
   Return False
End Function

Private Sub LoadStreamSettings()
   Dim settings As Stream = New StreamReader(_streamSettings).BaseStream
   _playctrl.LoadSettingsFromStream(settings, PlaySettings.Processors)
   settings.Close()
End Sub

Private Function SaveStreamSettings() As Boolean
   '  check if we can save the processors settings
   If _playctrl.CanSaveObjectSettings(PlaySettings.Processors) Then
      Dim settings As Stream = New StreamWriter(_streamSettings, False).BaseStream
      _playctrl.SaveSettingsToStream(settings, PlaySettings.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 18\Media"
End Class

using Leadtools;
using Leadtools.Multimedia;
using LeadtoolsMultimediaExamples.Fixtures;

public bool _result = false;
public PlayCtrlForm _form = new PlayCtrlForm();
public PlayCtrl _playctrl;
public string _streamSettings =Path.Combine(LEAD_VARS.MediaDir,"PlayCtrl_ObjectSettingsExample_Stream.xml");
public string _fileSettings =Path.Combine(LEAD_VARS.MediaDir,"PlayCtrl_ObjectSettingsExample.xml");

public void ObjectSettingsExample()
{
   // reference the play control
   _playctrl = _form.PlayCtrl;

   // input files
   string inFile =Path.Combine(LEAD_VARS.MediaDir,"PlayCtrl_Source.avi");

   try
   {
      Processor pVideoDizzy = _playctrl.VideoProcessors.EFXDizzy;
      // set a video processor
      _playctrl.SelectedVideoProcessors.Add(pVideoDizzy);

      // save the settings to a file
      if (SaveFileSettings())
      {
         // now clear the selected processors again
         _playctrl.SelectedVideoProcessors.Clear();

         // check whether a 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 = _playctrl.SelectedVideoProcessors.Contains(pVideoDizzy);
         }
      }

      // save the settings to a stream
      if (SaveStreamSettings())
      {
         // now clear the selected processors again
         _playctrl.SelectedVideoProcessors.Clear();

         // check whether a 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 &= _playctrl.SelectedVideoProcessors.Contains(pVideoDizzy);
         }
      }
   }
   catch (Exception)
   {
      _result = false;
   }
}

private void LoadFileSettings()
{
   _playctrl.LoadSettingsFromFile(_fileSettings, PlaySettings.Processors);
}

private bool SaveFileSettings()
{
   //  check whether we can save the processors settings
   if (_playctrl.CanSaveObjectSettings(PlaySettings.Processors))
   {
      _playctrl.SaveSettingsToFile(_fileSettings, PlaySettings.Processors);
      return true;
   }
   return false;
}

private void LoadStreamSettings()
{
   Stream settings = new StreamReader(_streamSettings).BaseStream;
   _playctrl.LoadSettingsFromStream(settings, PlaySettings.Processors);
   settings.Close();
}

private bool SaveStreamSettings()
{
   //  check whether we can save the processors settings
   if (_playctrl.CanSaveObjectSettings(PlaySettings.Processors))
   {
      Stream settings = new StreamWriter(_streamSettings, false).BaseStream;
      _playctrl.SaveSettingsToStream(settings, PlaySettings.Processors);
      settings.Close();
      return true;
   }
   return false;
}

static class LEAD_VARS
{
public const string MediaDir = @"C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 18\Media";
}

Requirements

Target Platforms

Reference

PlayCtrl Class
PlayCtrl Members