TargetFormat Property

Summary
Gets or sets the target format for the media file.
Syntax
C#
VB
C++
public virtual TargetFormatType TargetFormat { get; set; } 
Public Overridable Property TargetFormat As TargetFormatType 
public: 
virtual property TargetFormatType TargetFormat { 
   TargetFormatType get(); 
   void set (    TargetFormatType ); 
} 

Property Value

A TargetFormatType value representing the file format.

Remarks

The value is one of the TargetFormatType enumeration values. Assignment can raise an error exception. For more information, refer to the Error Codes.

Example
C#
VB
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_TargetFormatExample.avi"); 
 
public void TargetFormatExample() 
{ 
   // reference the capture control 
   capturectrl = _form.CaptureCtrl; 
 
   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 source audio device, select using your device name here 
      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 compete event 
         capturectrl.Complete += new System.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 (COMException) 
   { 
      _result = false; 
   } 
   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:\LEADTOOLS21\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_TargetFormatExample.avi") 
 
Public Sub TargetFormatExample() 
   ' reference the capture control 
   capturectrl = _form.CaptureCtrl 
 
   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 source audio device, select using your device name here 
      If capturectrl.AudioDevices("USB") Is Nothing Then 
         Throw New Exception("No USB audio device available") 
      End If 
 
      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) Then 
         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 compete event 
         AddHandler capturectrl.Complete, AddressOf 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() 
         End While 
      End If 
   Catch generatedExceptionName As COMException 
      _result = False 
   Catch generatedExceptionName As Exception 
      _result = False 
   End Try 
End Sub 
 
Public Sub CaptureCtrl_Complete(ByVal sender As Object, ByVal e As EventArgs) 
   ' set result 
   _result = True 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const MediaDir As String = "C:\LEADTOOLS21\Media" 
End Class 
Requirements

Target Platforms

Help Version 21.0.2021.3.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.MediaFoundation Assembly