In This Topic ▼

Mode Property

Summary

Gets the current capture mode.

Syntax

C++

public virtual CaptureMode Mode { get; }

Public Overridable ReadOnly Property Mode As CaptureMode

public: 
virtual property CaptureMode Mode { 
   CaptureMode get(); 
}

Property Value

A CaptureMode value representing the current capture mode.

Remarks

The value is one of the CaptureMode enumeration values.

Example

using Leadtools; 
using Leadtools.MediaFoundation; 
using LeadtoolsMediaFoundationExamples.Fixtures; 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
 
// capture control 
CaptureCtrl capturectrl; 
 
// output file 
string outFile = Path.Combine(LEAD_VARS.MediaDir, "CaptureCtrl_ModeExample.avi"); 
 
public void ModeExample() 
{ 
   // reference the capture control 
   capturectrl = _form.CaptureCtrl; 
 
   // Mode 
   CaptureMode Mode; 
 
   try 
   { 
      // set the source video device, select using your device name here 
      if (capturectrl.VideoDevices["USB"] == null) 
      { 
         throw new Exception("No USB video device available"); 
      } 
 
      capturectrl.VideoDevices["USB"].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 mode 
      Mode = capturectrl.Mode; 
 
      // set the result to what we expect 
      _result = (Mode == CaptureMode.Video); 
   } 
   catch (COMException) 
   { 
      _result = false; 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
} 
 
void CaptureCtrl_Started(object sender, EventArgs e) 
{ 
   // stop the capture (we don't need a complete capture for this example) 
   capturectrl.StopCapture(); 
} 
 
static class LEAD_VARS 
{ 
   public const string MediaDir = @"C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 20\Media"; 
}

Imports Leadtools 
Imports Leadtools.MediaFoundation 
Imports LeadtoolsMediaFoundationExamples.Fixtures 
 
Public _result As Boolean = False 
Public _form As New CaptureCtrlForm() 
 
' capture control 
Private capturectrl As CaptureCtrl 
 
' output file 
Private outFile As String = Path.Combine(LEAD_VARS.MediaDir, "CaptureCtrl_ModeExample.avi") 
 
Public Sub ModeExample() 
   ' reference the capture control 
   capturectrl = _form.CaptureCtrl 
 
   ' Mode 
   Dim Mode As CaptureMode 
 
   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 
 
      ' 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 mode 
      Mode = capturectrl.Mode 
 
      ' set the result to what we expect 
      _result = (Mode = CaptureMode.Video) 
   Catch generatedExceptionName As COMException 
      _result = False 
   Catch generatedExceptionName As Exception 
      _result = False 
   End Try 
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 20\Media" 
End Class

Requirements

Target Platforms

Reference

CaptureCtrl Class

CaptureCtrl Members

Download our FREE evaluation

Help Version 20.0.2020.4.2

Leadtools.MediaFoundation Assembly

Introduction

Getting Started

Namespaces

Leadtools.MediaFoundation Namespace

Leadtools.MediaFoundation.Common Namespace

Assemblies