LEADTOOLS Multimedia (Leadtools.Multimedia assembly) Send comments on this topic. | Back to Introduction | Help Version 17.0.3.22
SourceStream Property
See Also 
Leadtools.Multimedia Namespace > ConvertCtrl Class : SourceStream Property



Gets or sets the media source stream.

Syntax

Visual Basic (Declaration) 
Public Overridable Property SourceStream As Stream
Visual Basic (Usage)Copy Code
Dim instance As ConvertCtrl
Dim value As Stream
 
instance.SourceStream = value
 
value = instance.SourceStream
C# 
public virtual Stream SourceStream {get; set;}
C++/CLI 
public:
virtual property Stream^ SourceStream {
   Stream^ get();
   void set (    Stream^ value);
}

Property Value

A System.IO.Stream object for the media source stream.

Example

Visual BasicCopy Code
Public _result As Boolean = False
      Public _form As ConvertCtrlForm = New ConvertCtrlForm()
      ' input and output file names
      Public _inFile As String = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_Source.mpeg")
      Public _outFile As String = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_SourceStreamExample.avi")

      Public Sub SourceStreamExample()
         ' reference the convert control
         Dim convertctrl As ConvertCtrl = _form.ConvertCtrl

         Try
            ' set the source stream
            convertctrl.SourceStream = New StreamReader(_inFile).BaseStream

            ' select video and audio compressors
            convertctrl.VideoCompressors.Mpeg2.Selected = True
            convertctrl.AudioCompressors.AC3.Selected = True

            ' set the target file and format
            convertctrl.TargetFile = _outFile
            convertctrl.TargetFormat = TargetFormatType.AVI

            ' subscribe to the complete event to check our result
            AddHandler convertctrl.Complete, AddressOf ConvertCtrl_Complete

            ' set the allowed streams
            convertctrl.AllowedStreams = StreamFormatType.AudioVideoCC

            ' convert it!
            convertctrl.StartConvert()
         Catch e1 As Exception
            _result = False
         End Try

         ' we'll loop on the state and pump messages for this example.
         ' but you should not need to if running from a Windows Forms application.
         Do While convertctrl.State = ConvertState.Running
            Application.DoEvents()
         Loop
      End Sub

      Private Sub ConvertCtrl_Complete(ByVal sender As Object, ByVal e As EventArgs)
         ' set the result
         _result = File.Exists(_outFile)
      End Sub

Public NotInheritable Class LEAD_VARS
   Public Const MediaDir As String = "C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 17\Media"
End Class
C#Copy Code
public bool _result = false;
      public ConvertCtrlForm _form = new ConvertCtrlForm();
      // input and output file names
      public string _inFile = Path.Combine(LEAD_VARS.MediaDir,"ConvertCtrl_Source.mpeg");
      public string _outFile = Path.Combine(LEAD_VARS.MediaDir,"ConvertCtrl_SourceStreamExample.avi");

      public void SourceStreamExample()
      {
         // reference the convert control
         ConvertCtrl convertctrl = _form.ConvertCtrl;

         try
         {
            // set the source stream
            convertctrl.SourceStream = new StreamReader(_inFile).BaseStream;

            // select video and audio compressors
            convertctrl.VideoCompressors.Mpeg2.Selected = true;
            convertctrl.AudioCompressors.AC3.Selected = true;

            // set the target file and format
            convertctrl.TargetFile = _outFile;
            convertctrl.TargetFormat = TargetFormatType.AVI;

            // subscribe to the complete event to check our result
            convertctrl.Complete += new EventHandler(ConvertCtrl_Complete);

            // set the allowed streams
            convertctrl.AllowedStreams = StreamFormatType.AudioVideoCC;

            // convert it!
            convertctrl.StartConvert();
         }
         catch (Exception)
         {
            _result = false;
         }

         // we'll loop on the state and pump messages for this example.
         // but you should not need to if running from a Windows Forms application.
         while (convertctrl.State == ConvertState.Running)
            Application.DoEvents();
      }

      void ConvertCtrl_Complete(object sender, EventArgs e)
      {
         // set the result
         _result = File.Exists(_outFile);
      }

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

Remarks

This property allows the user to assign a Stream derived object as the media source for the conversion process. The SourceType will be set to SourceObjectType.Stream.

Assignment can raise error exception. For more information, refer to the Error Codes.

Note: When setting this property, the convert control must be in the stopped state.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also