In This Topic ▼

State Property

Summary

Gets the current state of the capture control.

Syntax

C++

public virtual CaptureState State { get; }

Public Overridable ReadOnly Property State As CaptureState

public: 
virtual property CaptureState State { 
   CaptureState get(); 
}

Property Value

A CaptureState enumeration value indicating the current control state.

Remarks

The value is one of the CaptureState enumeration values.

Example

using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
 
public void RunCaptureExample() 
{ 
   // reference the capture control 
   CaptureCtrl capturectrl = _form.CaptureCtrl; 
   string outFile = Path.Combine(LEAD_VARS.MediaDir, "CaptureCtrl_RunCaptureExample.avi"); 
 
   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; 
 
      // set the target output file 
      capturectrl.TargetFile = outFile; 
 
      // select a video compressor 
      capturectrl.VideoCompressors.Mpeg4.Selected = true; 
 
      // check whether we 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; 
 
         // subscribe to the compete event 
         capturectrl.Complete += RunCapture_Helper; 
 
         // prepare the capture process 
         capturectrl.ReadyCapture(CaptureMode.Video | CaptureMode.InhibitRun); 
 
         // actually run the capture now! 
         capturectrl.RunCapture(); 
 
         // 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 RunCapture_Helper(object sender, EventArgs e) 
{ 
   // set result 
   _result = true; 
} 
 
static class LEAD_VARS 
{ 
   public const string MediaDir = @"C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 20\Media"; 
}

Imports Leadtools 
Imports Leadtools.Multimedia 
Imports LeadtoolsMultimediaExamples.Fixtures 
 
Public _result As Boolean = False 
Public _form As CaptureCtrlForm = New CaptureCtrlForm() 
 
Public Sub RunCaptureExample() 
   ' reference the capture control 
   Dim capturectrl As CaptureCtrl = _form.CaptureCtrl 
   Dim outFile As String = Path.Combine(LEAD_VARS.MediaDir, "CaptureCtrl_RunCaptureExample.avi") 
 
   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 
 
      ' set the target output file 
      capturectrl.TargetFile = outFile 
 
      ' select a video 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 
 
         ' subscribe to the compete event 
         AddHandler capturectrl.Complete, AddressOf RunCapture_Helper 
 
         ' prepare the capture process 
         capturectrl.ReadyCapture(CaptureMode.Video Or CaptureMode.InhibitRun) 
 
         ' actually run the capture now! 
         capturectrl.RunCapture() 
 
         ' 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 RunCapture_Helper(ByVal sender As Object, ByVal e As EventArgs) 
   ' set result 
   _result = True 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const MediaDir As String = "C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 20\Media" 
End Class

Requirements

Target Platforms

Reference

CaptureCtrl Class

CaptureCtrl Members

Download our FREE evaluation

Help Version 20.0.2020.4.2

Leadtools.Multimedia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Multimedia Namespace

Leadtools.Multimedia.Common Namespace

Assemblies