In This Topic ▼

FrameRate Property

Summary

Gets or sets the user defined frame rate in frames per second.

Syntax

C++/CLI

public virtual double FrameRate { get; set; }

public: 
virtual property double FrameRate { 
   double get(); 
   void set (    double ); 
}

Property Value

A value representing the user defined frame rate.

Remarks

The FrameRate property is only used if the UseFrameRate property is set to true. Assignment can raise an error exception. For more information, refer to the Error Codes.

Example

using Leadtools; 
using Leadtools.MediaFoundation; 
using LeadtoolsMediaFoundationExamples.Fixtures; 
 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
 
public void CapturePreviewExample() 
{ 
   // reference the capture control 
   CaptureCtrl capturectrl = _form.CaptureCtrl; 
 
   // output file for processor settings 
   string outFile = Path.Combine(LEAD_VARS.MediaDir, "CaptureCtrl_IsModeAvailableExample.avi"); 
 
   try 
   { 
      // try to find a USB camera 
      if (capturectrl.VideoDevices["USB"] == null) 
         throw new Exception("No USB video device available"); 
 
      capturectrl.VideoDevices["USB"].Selected = true; 
 
      // try to find a USB audio device 
      if (capturectrl.AudioDevices["USB"] == null) 
         throw new Exception("No USB audio device available"); 
 
      capturectrl.AudioDevices["USB"].Selected = true; 
 
      // set the target output file 
      capturectrl.TargetFile = outFile; 
 
      // set the target output format 
      capturectrl.TargetFormat = TargetFormatType.MP4; 
 
      // check if we have can capture video 
      if (capturectrl.IsModeAvailable(CaptureMode.VideoAndAudio)) 
      { 
         capturectrl.FrameRate = 5;       // 5 frames per second  
         capturectrl.UseFrameRate = true; 
         capturectrl.TimeLimit = 10;      // just 10 seconds of capture time 
         capturectrl.UseTimeLimit = true; 
 
         // subscribe to the complete event 
         capturectrl.Complete += new EventHandler(CaptureCtrl_Complete); 
 
         // start the capture process 
         capturectrl.StartCapture(CaptureMode.VideoAndAudio); 
 
         // 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 (capturectrl.State == CaptureState.Running) 
            Application.DoEvents(); 
      } 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
} 
 
public void CaptureCtrl_Complete(object sender, EventArgs e) 
{ 
   // set result 
   _result = true; 
} 
 
static class LEAD_VARS 
{ 
   public const string MediaDir = @"C:\LEADTOOLS22\Media"; 
}

Requirements

Target Platforms

Reference

CaptureCtrl Class

CaptureCtrl Members

Download our FREE evaluation

Help Version 22.0.2022.12.7

Leadtools.MediaFoundation Assembly

Introduction

Getting Started

Namespaces

Leadtools.MediaFoundation Namespace

Leadtools.MediaFoundation.Common Namespace

Assemblies