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



fileName
A string that represents the file name to save the DIB to.
timeOut
The timeout period in milliseconds. This method will fail if it was not able to take a DIB in the specified time. Use -1 to wait infinitely until a DIB is snapped.
fileName
A string that represents the file name to save the DIB to.
timeOut
The timeout period in milliseconds. This method will fail if it was not able to take a DIB in the specified time. Use -1 to wait infinitely until a DIB is snapped.
Saves a snapshot from the running stream to a file as device-independent bitmap(DIB).

Syntax

Visual Basic (Declaration) 
Public Overridable Sub SaveStillDIB( _
   ByVal fileName As String, _
   ByVal timeOut As Integer _
) 
Visual Basic (Usage)Copy Code
Dim instance As CaptureCtrl
Dim fileName As String
Dim timeOut As Integer
 
instance.SaveStillDIB(fileName, timeOut)
C# 
public virtual void SaveStillDIB( 
   string fileName,
   int timeOut
)
C++/CLI 
public:
virtual void SaveStillDIB( 
   String^ fileName,
   int timeOut
) 

Parameters

fileName
A string that represents the file name to save the DIB to.
timeOut
The timeout period in milliseconds. This method will fail if it was not able to take a DIB in the specified time. Use -1 to wait infinitely until a DIB is snapped.

Example

Visual BasicCopy Code
Public _form As CaptureCtrlForm = New CaptureCtrlForm()
      Public _capturectrl As CaptureCtrl = Nothing
      Public _result As Boolean = False
      Private _dibFile As String = Path.Combine(LEAD_VARS.MediaDir, "CaptureCtrl_SaveStillDIB.dib")

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

         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

            ' set a video compressor for the capture file
            _capturectrl.VideoCompressors.Mpeg4.Selected = True

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

            ' save the still DIB to a file
            _capturectrl.SaveStillDIB(_dibFile, -1)

            ' stop the capture
            _capturectrl.StopCapture()

            ' check for the capture file and set the result
            If File.Exists(Path.Combine(Directory.GetCurrentDirectory(), _dibFile)) 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 CaptureCtrlForm _form = new CaptureCtrlForm();
      public CaptureCtrl _capturectrl = null;
      public bool _result = false;
      string _dibFile = Path.Combine(LEAD_VARS.MediaDir,"CaptureCtrl_SaveStillDIB.dib");

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

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

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

            // set a video compressor for the capture file
            _capturectrl.VideoCompressors.Mpeg4.Selected = true;

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

            // save the still DIB to a file
            _capturectrl.SaveStillDIB(_dibFile, -1);

            // stop the capture
            _capturectrl.StopCapture();

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

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

Remarks

Saves a snapshot, as a DIB, from the running stream to a specified filename. This method will not return until the specified timeout occurs or the DIB is snapped.

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