In This Topic ▼

Scrub Method

Summary

Forces a frame to the renderer while stopped.

Syntax

C++

public virtual void Scrub()

Public Overridable Sub Scrub()

public: 
virtual void Scrub();

Remarks

This method has no effect unless the object is in the PlayState.Stopped state. It is usually only useful if you have set AutoScrub to false.

Example

Imports Leadtools 
Imports Leadtools.Multimedia 
Imports LeadtoolsMultimediaExamples.Fixtures 
 
Public _result As Boolean = False 
Public _form As PlayCtrlForm = New PlayCtrlForm() 
Private _duration As Double = 0.0 
Private _currentPos As Double = -1 
Public Sub PlayExample() 
   ' reference the play control 
   Dim playctrl As PlayCtrl = _form.PlayCtrl 
 
   ' input file 
   Dim inFile As String = Path.Combine(LEAD_VARS.MediaDir, "PlayCtrl_Source.avi") 
 
   Try 
      ' set autoscrub to false 
      playctrl.AutoScrub = False 
 
      ' set autostart to false 
      playctrl.AutoStart = False 
 
      ' set our source media file 
      playctrl.SourceFile = inFile 
 
      ' this is the location where you can safely install callbacks 
 
      ' force a poster frame if wanted 
      playctrl.Scrub() 
 
      ' get the reported duration 
      _duration = playctrl.Duration 
 
      ' set event handler to get tracking position changes 
      AddHandler playctrl.TrackingPositionChanged, AddressOf PlayCtrl_TrackingPositionChanged 
 
      ' run it! 
      playctrl.Run() 
   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 
 
   ' set the result to determine if the reported duration 
   ' is the same as the final position from tracking 
   _result = (_duration = _currentPos AndAlso _duration > 0.0) 
End Sub 
 
Private Sub PlayCtrl_TrackingPositionChanged(ByVal sender As Object, ByVal e As TrackingPositionChangedEventArgs) 
   ' get the frame and tracking positions for demonstration only 
   Dim frame As Integer = _form.PlayCtrl.CurrentFramePosition 
   Dim tracking As Integer = _form.PlayCtrl.CurrentTrackingPosition 
 
   ' get the current position 
   _currentPos = Math.Max(_currentPos, _form.PlayCtrl.CurrentPosition) 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
Public Const MediaDir As String = "C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 20\Media" 
End Class

using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
public bool _result = false; 
public PlayCtrlForm _form = new PlayCtrlForm(); 
double _duration = 0.0; 
double _currentPos = -1; 
public void PlayExample() 
{ 
   // reference the play control 
   PlayCtrl playctrl = _form.PlayCtrl; 
 
   // input file 
   string inFile =Path.Combine(LEAD_VARS.MediaDir,"PlayCtrl_Source.avi"); 
 
   try 
   { 
      // set autoscrub to false 
      playctrl.AutoScrub = false; 
 
      // set autostart to false 
      playctrl.AutoStart = false; 
 
      // set our source media file 
      playctrl.SourceFile = inFile; 
 
      // this is the location where you can safely install callbacks 
 
      // force a poster frame if wanted 
      playctrl.Scrub(); 
 
      // get the reported duration 
      _duration = playctrl.Duration; 
 
      // set event handler to get tracking position changes 
      playctrl.TrackingPositionChanged += new TrackingPositionChangedEventHandler(PlayCtrl_TrackingPositionChanged); 
 
      // run it! 
      playctrl.Run(); 
   } 
   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(); 
 
   // set the result to determine if the reported duration 
   // is the same as the final position from tracking 
   _result = (_duration == _currentPos && _duration > 0.0); 
} 
 
void PlayCtrl_TrackingPositionChanged(object sender, TrackingPositionChangedEventArgs e) 
{ 
   // get the frame and tracking positions for demonstration only 
   int frame = _form.PlayCtrl.CurrentFramePosition; 
   int tracking = _form.PlayCtrl.CurrentTrackingPosition; 
 
   // get the current position 
   _currentPos = Math.Max(_currentPos, _form.PlayCtrl.CurrentPosition); 
} 
 
static class LEAD_VARS 
{ 
public const string MediaDir = @"C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 20\Media"; 
}

Requirements

Target Platforms

Reference

PlayCtrl Class

PlayCtrl Members

Download our FREE evaluation

Help Version 20.0.2020.4.2

Leadtools.Multimedia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Multimedia Namespace

Leadtools.Multimedia.Common Namespace

Assemblies