GetStillImage Method (CaptureCtrl)

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overridable Function GetStillImage( _
   ByVal timeOut As Integer _
) As Image

'Usage
 
Dim instance As CaptureCtrl
Dim timeOut As Integer
Dim value As Image
 
value = instance.GetStillImage(timeOut)

public virtual Image GetStillImage( 
   int timeOut
)

public:
virtual Image^ GetStillImage( 
   int timeOut
)

Parameters

timeOut: The maximum time, in milliseconds, to wait for the image.

Return Value

Captured video image as a System.Drawing.Image

Gets a System.Drawing.Image object during a CaptureMode.Still capture. If TimeOut is -1, the method's time-out interval never elapses.

If the method fails, an error is raised. For more information, refer to the Error Codes.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.MediaFoundation
Imports LeadtoolsMediaFoundationExamples.Fixtures

Public _result As Boolean = False
Public _form As New CaptureCtrlForm()
Public Sub GetStillImageExample()
    ' reference the capture control
    Dim capturectrl As CaptureCtrl = _form.CaptureCtrl

    ' output file
    Dim outFile As String = Path.Combine(LEAD_VARS.MediaDir, "CaptureCtrl_GetStillImageExample.jpg")

    Try
        ' set the video capture device, use your capture 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 capture mode to still and start
        capturectrl.StartCapture(CaptureMode.Still)

        ' get a still image
        Dim image As Image = capturectrl.GetStillImage(-1)
        If image IsNot Nothing Then
            image.Save(outFile, ImageFormat.Jpeg)
        End If

        ' stop the capture
        capturectrl.StopCapture()

        ' check for the capture file and set the result
        If File.Exists(Path.Combine(Directory.GetCurrentDirectory(), outFile)) Then
            _result = True
        End If
    Catch generatedExceptionName 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 18\Media"
End Class

using Leadtools;
using Leadtools.MediaFoundation;
using LeadtoolsMediaFoundationExamples.Fixtures;

public bool _result = false;
public CaptureCtrlForm _form = new CaptureCtrlForm();
public void GetStillImageExample()
{
   // reference the capture control
   CaptureCtrl capturectrl = _form.CaptureCtrl;

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

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

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

      // set the capture mode to still and start
      capturectrl.StartCapture(CaptureMode.Still);

      // get a still image
      Image image = capturectrl.GetStillImage(-1);
      if (image != null)
         image.Save(outFile, ImageFormat.Jpeg);

      // stop the capture
      capturectrl.StopCapture();

      // check for the capture file and set the result
      if (File.Exists(Path.Combine(Directory.GetCurrentDirectory(), outFile)))
         _result = true;
   }
   catch (Exception)
   {
      _result = false;
   }
}

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

Target Platforms

Reference

CaptureCtrl Class
CaptureCtrl Members