In This Topic ▼

GetStillImage Method

Summary

Gets a System.Drawing.Image object.

Syntax

C++/CLI

public virtual Image GetStillImage( 
   int timeOut 
)

public: 
virtual Image^ GetStillImage(  
   int timeOut 
)

Parameters

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

Return Value

The System.Drawing.Image object

Remarks

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. Note: The frame data is retrieved from the underlying graph after the processing filters. If the capture needs to occur before the processing is completed use the LeadVideoCallBackFilter and place it first in the collection of processing filters.

Example

using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
 
public PlayCtrlForm _form = new PlayCtrlForm(); 
public PlayCtrl _playctrl = null; 
public bool _result = false; 
public string _inFile = Path.Combine(LEAD_VARS.MediaDir, "PlayCtrl_Source.avi"); 
public string _outFile = Path.Combine(LEAD_VARS.MediaDir, "PlayCtrl_GetStillImageExample.jpg"); 
 
public void GetStillImageExample() 
{ 
   // reference the play control 
   _playctrl = _form.PlayCtrl; 
 
   try 
   { 
      // set the test timer on our form 
      _form.TestTimer.Interval = 2000; // wait 2 seconds after start 
      _form.TestTimer.Tick += GetStillImage_Helper; 
 
      // set input media file 
      _playctrl.SourceFile = _inFile; 
 
      // set the timer on 
      _form.TestTimer.Start(); 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
 
   // 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 (_playctrl.State == PlayState.Running) 
      Application.DoEvents(); 
 
   // check for the capture file and set the result 
   if (File.Exists(Path.Combine(Directory.GetCurrentDirectory(), _outFile))) 
      _result = true; 
} 
 
public void GetStillImage_Helper(object sender, EventArgs e) 
{ 
   // get a still image 
   Image image = _playctrl.GetStillImage(-1); 
   if (image != null) 
      image.Save(_outFile, ImageFormat.Jpeg); 
 
   // stop the capture 
   _playctrl.Stop(); 
} 
 
static class LEAD_VARS 
{ 
   public const string MediaDir = @"C:\LEADTOOLS23\Media"; 
}

Requirements

Target Platforms

Reference

PlayCtrl Class

PlayCtrl Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Multimedia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Multimedia Namespace

Leadtools.Multimedia.Common Namespace

Assemblies