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



Gets or sets a value that indicates the point at which the still image will be captured.

Syntax

Visual Basic (Declaration) 
Public Overridable Property StillTap As PlayStillTap
Visual Basic (Usage)Copy Code
Dim instance As PlayCtrl
Dim value As PlayStillTap
 
instance.StillTap = value
 
value = instance.StillTap
C# 
public virtual PlayStillTap StillTap {get; set;}
C++/CLI 
public:
virtual property PlayStillTap StillTap {
   PlayStillTap get();
   void set (    PlayStillTap value);
}

Property Value

A PlayStillTap enumeration value indicating the tap location.

Example

Visual BasicCopy Code
Public _result As Boolean = False
      Public _form As PlayCtrlForm = New PlayCtrlForm()
      Public _playctrl As PlayCtrl = Nothing
      Public _bmpFile As String = Path.Combine(LEAD_VARS.MediaDir, "PlayCtrl_SaveStillBitmap.bmp")
      Public Sub SaveStillBitmapExample()
         ' input and output file names
         Dim inFile As String = Path.Combine(LEAD_VARS.MediaDir, "PlayCtrl_ShortSource.avi")

         Try
            ' reference the convert control
            _playctrl = _form.PlayCtrl

            ' set a timer on the form to make the still bitmap
            _form.TestTimer.Interval = 5000
            AddHandler _form.TestTimer.Tick, AddressOf SaveStillBitmap_Helper

            ' add an effects processor for playback
            _playctrl.SelectedVideoProcessors.Add(_playctrl.VideoProcessors.EFXDizzy)

            ' set the still tap location to Processors so that we get
            ' our effect applied to the still image -- you could of course
            ' set the tap to Source to capture the still without the applied effect 
            _playctrl.StillTap = PlayStillTap.Processors

            ' set the source and target files
            _playctrl.SourceFile = inFile

            ' now start the test timer for the still capture
            _form.TestTimer.Start()
         Catch e1 As Exception
            _result = False
         End Try

         ' 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.
         Do While _playctrl.State = PlayState.Running
            Application.DoEvents()
         Loop
      End Sub

      Public Sub SaveStillBitmap_Helper(ByVal sender As Object, ByVal e As EventArgs)
         ' cancel the timer
         _form.TestTimer.Stop()

         ' try to simulate an error condition
         _playctrl.SaveStillBitmap(_bmpFile, StillFormatType.BMP, 0, 0, -1)

         ' check for the capture file and set the result
         If File.Exists(Path.Combine(Directory.GetCurrentDirectory(), _bmpFile)) Then
            _result = True
         End If

         _playctrl.Stop()
      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 PlayCtrlForm _form = new PlayCtrlForm();
      public PlayCtrl _playctrl = null;
      public string _bmpFile = Path.Combine(LEAD_VARS.MediaDir,"PlayCtrl_SaveStillBitmap.bmp");
      public void SaveStillBitmapExample()
      {
         // input and output file names
         string inFile =Path.Combine(LEAD_VARS.MediaDir,"PlayCtrl_ShortSource.avi");

         try
         {
            // reference the convert control
            _playctrl = _form.PlayCtrl;

            // set a timer on the form to make the still bitmap
            _form.TestTimer.Interval = 5000;
            _form.TestTimer.Tick += new EventHandler(SaveStillBitmap_Helper);

            // add an effects processor for playback
            _playctrl.SelectedVideoProcessors.Add(_playctrl.VideoProcessors.EFXDizzy);

            // set the still tap location to Processors so that we get
            // our effect applied to the still image -- you could of course
            // set the tap to Source to capture the still without the applied effect 
            _playctrl.StillTap = PlayStillTap.Processors;

            // set the source and target files
            _playctrl.SourceFile = inFile;

            // now start the test timer for the still capture
            _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();
      }

      public void SaveStillBitmap_Helper(object sender, EventArgs e)
      {
         // cancel the timer
         _form.TestTimer.Stop();

         // try to simulate an error condition
         _playctrl.SaveStillBitmap(_bmpFile, StillFormatType.BMP, 0, 0, -1);

         // check for the capture file and set the result
         if (File.Exists(Path.Combine(Directory.GetCurrentDirectory(), _bmpFile)))
            _result = true;

         _playctrl.Stop();
      }

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

Remarks

For a list of possible values, refer to the PlayStillTap enumeration values. Still images can be captured using GetStillDIB, GetStillImage, SaveStillDIB or SaveStillBitmap.

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