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



mode
Specifies the capture Mode. Must be one of the CaptureMode enumeration values.
mode
Specifies the capture Mode. Must be one of the CaptureMode enumeration values.
Starts capturing data.

Syntax

Visual Basic (Declaration) 
Public Overridable Sub StartCapture( _
   ByVal mode As CaptureMode _
) 
Visual Basic (Usage)Copy Code
Dim instance As CaptureCtrl
Dim mode As CaptureMode
 
instance.StartCapture(mode)
C# 
public virtual void StartCapture( 
   CaptureMode mode
)
C++/CLI 
public:
virtual void StartCapture( 
   CaptureMode mode
) 

Parameters

mode
Specifies the capture Mode. Must be one of the CaptureMode enumeration values.

Example

Visual BasicCopy Code
Public _result As Boolean = False
      Public _form As CaptureCtrlForm = New CaptureCtrlForm()
      Public Sub CompleteExample()
         ' reference the capture control
         Dim capturectrl As CaptureCtrl = _form.CaptureCtrl
         Dim outFile As String = Path.Combine(LEAD_VARS.MediaDir, "CaptureCtrl_CompleteExample.avi")

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

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

            ' set the target output file
            capturectrl.TargetFile = outFile

            ' MPEG4 is a good general compressor
            capturectrl.VideoCompressors.Mpeg4.Selected = True

            ' check if we have can capture video
            If capturectrl.IsModeAvailable(CaptureMode.Video) Then
               capturectrl.FrameDelay = 0.033 ' 30 frames per second
               capturectrl.TimeLimit = 10 ' just 10 seconds of capture time
               capturectrl.UseTimeLimit = True

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

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

               ' 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

      Public Sub CaptureCtrl_Complete(ByVal sender As Object, ByVal e As EventArgs)
         ' set result (capture has completed)
         _result = True
      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 CaptureCtrlForm _form = new CaptureCtrlForm();
      public void CompleteExample()
      {
         // reference the capture control
         CaptureCtrl capturectrl = _form.CaptureCtrl;
         string outFile =Path.Combine(LEAD_VARS.MediaDir,"CaptureCtrl_CompleteExample.avi");

         try
         {
            // try to find a USB video device, use your video device name here
            if (capturectrl.VideoDevices["USB"] == null)
               throw new Exception("No USB video device available");

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

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

            // MPEG4 is a good general compressor
            capturectrl.VideoCompressors.Mpeg4.Selected = true;

            // check if we have can capture video
            if (capturectrl.IsModeAvailable(CaptureMode.Video))
            {
               capturectrl.FrameDelay = .033;  // 30 frames per second
               capturectrl.TimeLimit = 10;     // just 10 seconds of capture time
               capturectrl.UseTimeLimit = true;

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

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

               // 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 (Exception)
         {
            _result = false;
         }
      }

      public void CaptureCtrl_Complete(object sender, EventArgs e)
      {
         // set result (capture has completed)
         _result = true;
      }

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

Remarks

Starts capturing data. Places the object in the CaptureState.Running state. If the method fails, an error is raised.

For more information, refer to the Error Codes.

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