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



timeOut
Value containing the maximum time to wait for the image, in milliseconds.
timeOut
Value containing the maximum time to wait for the image, in milliseconds.
Gets a System.Drawing.Image object during an CaptureMode.Still capture.

Syntax

Visual Basic (Declaration) 
Public Overridable Function GetStillImage( _
   ByVal timeOut As Integer _
) As Image
Visual Basic (Usage)Copy Code
Dim instance As CaptureCtrl
Dim timeOut As Integer
Dim value As Image
 
value = instance.GetStillImage(timeOut)
C# 
public virtual Image GetStillImage( 
   int timeOut
)
C++/CLI 
public:
virtual Image^ GetStillImage( 
   int timeOut
) 

Parameters

timeOut
Value containing the maximum time to wait for the image, in milliseconds.

Return Value

Captured video image as a System.Drawing.Image

Example

Visual BasicCopy Code
Public _result As Boolean = False
      Public _form As CaptureCtrlForm = 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 Not image Is 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 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 17\Media"
End Class
C#Copy Code
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 17\Media";
}

Remarks

Gets a System.Drawing.Image object during an 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.

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