SaveStillBitmap Method (CaptureCtrl)

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overridable Sub SaveStillBitmap( _
   ByVal fileName As String, _
   ByVal format As StillFormatType, _
   ByVal quality As Integer, _
   ByVal flags As Integer, _
   ByVal timeOut As Integer _
)

'Usage
 
Dim instance As CaptureCtrl
Dim fileName As String
Dim format As StillFormatType
Dim quality As Integer
Dim flags As Integer
Dim timeOut As Integer
 
instance.SaveStillBitmap(fileName, format, quality, flags, timeOut)

public virtual void SaveStillBitmap( 
   string fileName,
   StillFormatType format,
   int quality,
   int flags,
   int timeOut
)

public:
virtual void SaveStillBitmap( 
   String^ fileName,
   StillFormatType format,
   int quality,
   int flags,
   int timeOut
)

Parameters

fileName: A string containing the name of the file in which to save the bitmap.
format: A StillFormatType value that represents the output file format.
quality: Value that represents the compression quality. For a list of possible values, refer to Compression Quality Factors.
If the StillFormatType parameter is equal to StillFormatType.CMP, the StillQuality enumeration values can be used.
flags: Reserved for future use. Pass 0.
timeOut: The timeout period in milliseconds. The method will fail if it was not able to take a sample in the specified time. Use -1 to wait indefinitely until a sample is snapped.

Saves a snapshot from the running stream to a file as a bitmap. This method blocks (does not return) until either the timeout occurs or the sample is snapped.

The following methods can also be used to obtain still images:

.

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

Copy Code

Imports Leadtools
Imports Leadtools.MediaFoundation
Imports LeadtoolsMediaFoundationExamples.Fixtures

Public _form As New CaptureCtrlForm()
Public _capturectrl As CaptureCtrl = Nothing
Public _result As Boolean = False

Public Sub SaveStillBitmapExample()
    ' reference the capture control
    _capturectrl = _form.CaptureCtrl

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

    Try
        ' select a video capture device
        If _capturectrl.VideoDevices("USB") Is Nothing Then
            Throw New Exception("No USB video device available")
        End If

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

        ' start the capture
        _capturectrl.StartCapture(CaptureMode.Still)

        ' save the still image to a jpeg file
        _capturectrl.SaveStillBitmap(jpgFile, StillFormatType.JPEG444, StillQuality.MC, 0, -1)

        ' stop the capture
        _capturectrl.StopCapture()

        ' check for the capture file and set the result
        If File.Exists(jpgFile) 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 CaptureCtrlForm _form = new CaptureCtrlForm();
public CaptureCtrl _capturectrl = null;
public bool _result = false;

public void SaveStillBitmapExample()
{
   // reference the capture control
   _capturectrl = _form.CaptureCtrl;

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

   try
   {
      // select a video capture device
      if (_capturectrl.VideoDevices["USB"] == null)
         throw new Exception("No USB video device available");

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

      // start the capture
      _capturectrl.StartCapture(CaptureMode.Still);

      // save the still image to a jpeg file
      _capturectrl.SaveStillBitmap(jpgFile, StillFormatType.JPEG444, StillQuality.MC, 0, -1);

      // stop the capture
      _capturectrl.StopCapture();

      // check for the capture file and set the result
      if (File.Exists(jpgFile))
         _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