TargetFile Property (CaptureCtrl)

Gets or sets the filename for the media target file.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overridable Property TargetFile As String

'Usage
 
Dim instance As CaptureCtrl
Dim value As String
 
instance.TargetFile = value
 
value = instance.TargetFile

public virtual string TargetFile {get; set;}

public:
virtual property String^ TargetFile {
   String^ get();
   void set (    String^ value);
}

Property Value

A string value representing the filename.

Remarks

This property allows the user to set the output of the capture process to the specified filename. If the target format in the TargetFormat property is TargetFormatType.DVD, then the TargetFile property contains the directory in which the DVD image is located. Otherwise, the TargetFile property contains the name of a media file. If the TargetFile property refers to a directory, it should contain the full path to the directory. A relative path can be used, but is not recommended because relative paths are somewhat unpredictable. If the target format type is TargetFormatType.DVD and the TargetFile property contains the name of an existing file, that file will be deleted, and a directory or folder will be created with the same name. The filename can be used to indicate a regular file or a stream. For more details about filename syntax, refer to: Target File Syntax. The ResetTarget method should be called to stop the capture control from accessing the file or stream. The TargetType will be set to TargetObjectType.File. Assignment can raise an error exception.

For more information, refer to the Error Codes.

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 CaptureCtrlForm = New CaptureCtrlForm()
' output file
Dim outFile As String = Path.Combine(LEAD_VARS.MediaDir,"CaptureCtrl_TargetFileExample.avi")

Public Sub TargetFileExample()
   ' reference the capture control
   Dim capturectrl As CaptureCtrl = _form.CaptureCtrl

   Try
      ' try to find a USB camera
      If capturectrl.VideoDevices("USB") Is Nothing Then
         Throw New Exception("No USB video device available")
      End If

      capturectrl.VideoDevices("USB").Selected = True

      ' try to find a USB audio device
      If capturectrl.AudioDevices("USB") Is Nothing Then
         Throw New Exception("No USB audio device available")
      End If

      capturectrl.AudioDevices("USB").Selected = True

      ' set MPEG2 as the video compressor
      capturectrl.VideoCompressors.Mpeg2.Selected = True

      ' set AC3 as the audio compressor
      capturectrl.AudioCompressors.AC3.Selected = True

      ' set the target output file
      capturectrl.TargetFile = outFile

      ' set the target output format
      capturectrl.TargetFormat = TargetFormatType.AVI

      ' check if we have can capture video
      If capturectrl.IsModeAvailable(CaptureMode.VideoAndAudio) Then
         capturectrl.FrameRate = 5 ' 5 frames per second
         capturectrl.UseFrameRate = True
         capturectrl.TimeLimit = 10 ' just 10 seconds of capture time
         capturectrl.UseTimeLimit = True

         ' subscribe to the compete event
         AddHandler capturectrl.Complete, AddressOf CaptureCtrl_Complete

         ' start the capture process
         capturectrl.StartCapture(CaptureMode.VideoAndAudio)

         ' 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 capturectrl.State = CaptureState.Running
            Application.DoEvents()
         Loop
      End If
   Catch e1 As Exception
      _result = False
   End Try
End Sub

Private Sub CaptureCtrl_Complete(ByVal sender As Object, ByVal e As EventArgs)
   ' check for the capture file and set the result
   If File.Exists(outFile) Then
      _result = True
   End If
End Sub

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 CaptureCtrlForm _form = new CaptureCtrlForm();
// capture control
CaptureCtrl capturectrl;

// output file
string outFile = Path.Combine(LEAD_VARS.MediaDir,"CaptureCtrl_TargetFileExample.avi");

public void TargetFileExample()
{
   // reference the capture control
   capturectrl = _form.CaptureCtrl;

   try
   {
      // try to find a USB camera
      if (capturectrl.VideoDevices["USB"] == null)
      {
         throw new Exception("No USB video device available");
      }

      capturectrl.VideoDevices["USB"].Selected = true;

      // try to find a USB audio device
      if (capturectrl.AudioDevices["USB"] == null)
      {
         throw new Exception("No USB audio device available");
      }

      capturectrl.AudioDevices["USB"].Selected = true;

      // set MPEG2 as the video compressor
      capturectrl.VideoCompressors.Mpeg2.Selected = true;

      // set AC3 as the audio compressor
      capturectrl.AudioCompressors.AC3.Selected = true;

      // set the target output file
      capturectrl.TargetFile = outFile;

      // set the target output format
      capturectrl.TargetFormat = TargetFormatType.AVI;

      // check whether we can capture video
      if (capturectrl.IsModeAvailable(CaptureMode.VideoAndAudio))
      {
         capturectrl.FrameRate = 5;
         // 5 frames per second
         capturectrl.UseFrameRate = true;
         capturectrl.TimeLimit = 10;
         // just 10 seconds of capture time
         capturectrl.UseTimeLimit = true;

         // subscribe to the compete event
         capturectrl.Complete += new EventHandler(CaptureCtrl_Complete);

         // start the capture process
         capturectrl.StartCapture(CaptureMode.VideoAndAudio);

         // 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 (capturectrl.State == CaptureState.Running)
         {
            Application.DoEvents();
         }
      }

   }
   catch (COMException)
   {
      _result = false;
   }
   catch (Exception)
   {
      _result = false;
   }
}

public void CaptureCtrl_Complete(object sender, EventArgs e)
{
   // check for the capture file and set the result
   if (File.Exists(outFile))
   _result = true;
}

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

Requirements

Target Platforms

Reference

CaptureCtrl Class
CaptureCtrl Members