←Select platform

SourceFile Property

Summary

Gets or sets the media source filename, URL or UDP address.

Syntax

C#
VB
C++
[EditorAttribute(System.Type, System.Type)] 
public virtual string SourceFile { get; set; } 
Public Overridable Property SourceFile As String 
public: 
virtual property String^ SourceFile { 
   String^ get(); 
   void set (    String^ ); 
} 

Property Value

A value representing the source filename.

Remarks

This property allows the user to set the media source to the specified filename, URL or UDP address. The SourceType will be set to SourceObjectType.File. The filename can be used to indicate a regular file or a network stream. For more details on the filename syntax, refer to: SourceFile syntax. Assignment can raise an error exception. When you set the source to a URL, setting the property will block waiting until data arrives or the filter's timeout is exceeded. The timeouts can be large (15+ seconds), so setting the source in the main user interface thread might block the app for many seconds. If no data is received, some filters (LEAD MPEG-2 Transport UDP Source and LEAD RTSP Source), will cause a MediaEvent event to be fired every second. The event will have eventCode set to MediaEventCode.EC_LOADSTATUS and param1 will be set to LoadStatusEventCode.AM_LOADSTATUS_WAITING_FOR_DATA. See the MediaEventCode enumeration for more details. You can abort the wait for data by calling ResetSource while processing the event. See LoadStatusEventCode for more details.

For more information, refer to the Error Codes.

Note: When trying to rip an audio directly from an audio CD, set the SourceFile property to the location of the file. For example, if the CD-ROM drive is named "F:\" and the ".cda" file for the first track on a CD is called "Track1.cda", then the location of the first track on the CD is "F:\Track01.cda".

Example

C#
VB
using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
public bool _result = false; 
public ConvertCtrlForm _form = new ConvertCtrlForm(); 
 
public void HasDialogExample() 
{ 
   // reference the convert control 
   ConvertCtrl 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_HasDialogExample.avi"); 
 
   try 
   { 
      // set the source for conversion 
      convertctrl.SourceFile = inFile; 
 
      // set the video and audio compressors 
      convertctrl.VideoCompressors.Mpeg2.Selected = true; 
      convertctrl.AudioCompressors.AC3.Selected = true; 
 
      // set the target output file and format 
      convertctrl.TargetFile = outFile; 
 
      // set the target output format 
      convertctrl.TargetFormat = TargetFormatType.AVI; 
 
      // The HasDialog method tells us that the control 
      // can display the desired settings dialog. 
      // check to see if the convert source dialog is available 
      if (convertctrl.HasDialog(ConvertDlg.TargetFormat)) 
      { 
         // now show it 
         convertctrl.ShowDialog(ConvertDlg.TargetFormat, _form); 
         _result = true; 
      } 
 
      // enable preview 
      convertctrl.Preview = true; 
 
      // set preview visible 
      convertctrl.PreviewVisible = true; 
 
      // start the capture process 
      convertctrl.StartConvert(); 
 
      // 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(); 
 
      // see if there was an error 
      if (convertctrl.ConvertError != 0) 
      { 
         // set the result to false 
         _result = false; 
      } 
   } 
   catch (Exception) 
   { 
      _result = 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 Sub HasDialogExample() 
   ' reference the convert control 
   Dim convertctrl As 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_HasDialogExample.avi") 
 
   Try 
      ' set the source for conversion 
      convertctrl.SourceFile = inFile 
 
      ' set the video and audio compressors 
      convertctrl.VideoCompressors.Mpeg2.Selected = True 
      convertctrl.AudioCompressors.AC3.Selected = True 
 
      ' set the target output file and format 
      convertctrl.TargetFile = outFile 
 
      ' set the target output format 
      convertctrl.TargetFormat = TargetFormatType.AVI 
 
      ' The HasDialog method tells us that the control 
      ' can display the desired settings dialog. 
      ' check to see if the convert source dialog is available 
      If convertctrl.HasDialog(ConvertDlg.TargetFormat) Then 
         ' now show it 
         convertctrl.ShowDialog(ConvertDlg.TargetFormat, _form) 
         _result = True 
      End If 
 
      ' enable preview 
      convertctrl.Preview = True 
 
      ' set preview visible 
      convertctrl.PreviewVisible = True 
 
      ' start the capture process 
      convertctrl.StartConvert() 
 
      ' 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 
 
      ' see if there was an error 
      If convertctrl.ConvertError <> 0 Then 
         ' set the result to false 
         _result = False 
      End If 
   Catch e1 As Exception 
      _result = False 
   End Try 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const MediaDir As String = "C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 19\Media" 
End Class 

Requirements

Target Platforms

Help Version 19.0.2017.10.19
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Multimedia Assembly