AverageFrameSize Property

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overridable ReadOnly Property AverageFrameSize As Integer

'Usage
 
Dim instance As CaptureCtrl
Dim value As Integer
 
value = instance.AverageFrameSize

public virtual int AverageFrameSize {get;}

public:
virtual property int AverageFrameSize {
   int get();
}

Property Value

A value representing the average frame size, in bytes, of the captured frames.

The value is reset to zero when you start a new capture.

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

Copy Code

Imports Leadtools
Imports Leadtools.Multimedia
Imports LeadtoolsMultimediaExamples.Fixtures

Public _result As Boolean = False
Public _form As CaptureCtrlForm = New CaptureCtrlForm()
Public _capturectrl As CaptureCtrl
Public Sub AverageFrameSizeExample()
   ' reference the capture control
   _capturectrl = _form.CaptureCtrl

   ' output file
   Dim outFile As String = Path.Combine(LEAD_VARS.MediaDir, "CaptureCtrl_AverageFrameSizeExample.avi")

   ' average frame size
   Dim AverageFrameSize As Integer

   Try
      ' set the source video device, select using your device name here
      If _capturectrl.VideoDevices("USB") Is Nothing Then
         Throw New Exception("No USB video device available")
      End If

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

      ' select a video compressor
      _capturectrl.VideoCompressors.Mpeg4.Selected = True

      ' set the target output file
      _capturectrl.TargetFile = outFile

      ' subscribe to the started event
      AddHandler _capturectrl.Started, AddressOf CaptureCtrl_Started

      ' start capture
      _capturectrl.StartCapture(CaptureMode.Video)

      ' get the average frame size
      AverageFrameSize = _capturectrl.AverageFrameSize

      ' set the result to what we expect
      _result = (AverageFrameSize > 0)

   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 _capturectrl.State = CaptureState.Running
      Application.DoEvents()
   Loop
End Sub

Private Sub CaptureCtrl_Started(ByVal sender As Object, ByVal e As EventArgs)
   ' stop the capture (we don't need a complete capture for this example)
   _capturectrl.StopCapture()
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.Multimedia;
using LeadtoolsMultimediaExamples.Fixtures;

public bool _result = false;
public CaptureCtrlForm _form = new CaptureCtrlForm();
// capture control
CaptureCtrl capturectrl;

// output file
string outFile = Path.Combine(LEAD_VARS.MediaDir,"CaptureCtrl_AverageFrameSizeExample.avi");

public void AverageFrameSizeExample()
{
   // reference the capture control
   capturectrl = _form.CaptureCtrl;

   // average frame size
   int AverageFrameSize = 0;

   try
   {
       // set the source video device. use your device's name here
      if (capturectrl.VideoDevices["USB"] == null)
      {
         throw new Exception("No USB video device available");
      }

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

      // select a video compressor
      capturectrl.VideoCompressors.Mpeg4.Selected = true;

      // set the target output file
      capturectrl.TargetFile = outFile;

      // subscribe to the started event
      capturectrl.Started += new System.EventHandler (CaptureCtrl_Started);

      // start capture
      capturectrl.StartCapture(CaptureMode.Video);

      // get the average frame size
      AverageFrameSize = capturectrl.AverageFrameSize;

      // set the result to what we expect
      _result = (AverageFrameSize > 0);
   }
   catch (COMException)
   {
      _result = false;
   }
   catch (Exception)
   {
      _result = false;
   }
}

void CaptureCtrl_Started(object sender, EventArgs e)
{
   // stop the capture (we do not need a complete capture for this example)
   capturectrl.StopCapture();
}

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

Target Platforms

Reference

CaptureCtrl Class
CaptureCtrl Members