←Select platform

Remove Method

Summary

Removes a TargetFormat item from the collection.

Syntax

C++

public bool Remove( 
   TargetFormat item 
)

Public Function Remove( _ 
   ByVal item As Leadtools.Mediafoundation.TargetFormat _ 
) As Boolean

public: 
bool Remove(  
   Leadtools.Mediafoundation.TargetFormat^ item 
)

Parameters

item
The TargetFormat to be removed.

Return Value

System.Boolean

Remarks

Removes the specified TargetFormat item. Predefined read-only formats cannot be removed. If the method fails, an error is raised. 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 TargetFormatsExample() 
{ 
   // reference the capture control 
   CaptureCtrl capturectrl = _form.CaptureCtrl; 
 
   try 
   { 
      // set the video capture device, use your capture device name here 
      if (capturectrl.VideoDevices["USB"] == null) 
         throw new Exception("No USB video device available"); 
 
      capturectrl.VideoDevices["USB"].Selected = true; 
 
      // set the audio capture device, use your capture device name here 
      if (capturectrl.AudioDevices["USB"] == null) 
         throw new Exception("No USB audio device available"); 
 
      capturectrl.AudioDevices["USB"].Selected = true; 
 
      // select the MP4 target format 
      capturectrl.TargetFormats[TargetFormatType.MP4].Selected = true; 
 
      // get the current selected input 
      int n = capturectrl.TargetFormats.Selection; 
 
      // loop through the target formats and set a different one 
      foreach (TargetFormat t in capturectrl.TargetFormats) 
      { 
         // get the format properties 
         string name = t.Name; 
         StreamFormatType sft = t.Streams; 
 
         // if we found the video tuner input 
         if (name == "WMV") 
         { 
            // select it and break 
            t.Selected = true; 
            break; 
         } 
      } 
 
      // check it directly 
      TargetFormatType tft = capturectrl.TargetFormat; 
 
      // set the result to what we expect 
      _result = (tft != TargetFormatType.MP4 && n != capturectrl.TargetFormats.Selection); 
   } 
   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 (capturectrl.State == CaptureState.Running) 
      Application.DoEvents(); 
}

Imports Leadtools 
Imports Leadtools.MediaFoundation 
Imports LeadtoolsMediaFoundationExamples.Fixtures 
 
Public _result As Boolean = False 
Public _form As New CaptureCtrlForm() 
 
Public Sub TargetFormatsExample() 
   ' reference the capture control 
   Dim capturectrl As CaptureCtrl = _form.CaptureCtrl 
 
   Try 
      ' set the video capture device, use your capture 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 audio capture device, use your capture 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 
 
      ' select the MP4 target format 
      capturectrl.TargetFormats(TargetFormatType.MP4).Selected = True 
 
      ' get the current selected input 
      Dim n As Integer = capturectrl.TargetFormats.Selection 
 
      ' loop through the target formats and set a different one 
      For Each t As TargetFormat In capturectrl.TargetFormats 
         ' get the format properties 
         Dim name As String = t.Name 
         Dim sft As StreamFormatType = t.Streams 
 
         ' if we found the video tuner input 
         If name = "WMV" Then 
            ' select it and break 
            t.Selected = True 
            Exit For 
         End If 
      Next 
 
      ' check it directly 
      Dim tft As TargetFormatType = capturectrl.TargetFormat 
 
      ' set the result to what we expect 
      _result = (tft <> TargetFormatType.MP4 AndAlso n <> capturectrl.TargetFormats.Selection) 
   Catch generatedExceptionName 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. 
   While capturectrl.State = CaptureState.Running 
      Application.DoEvents() 
   End While 
End Sub

Requirements

Target Platforms

Reference

TargetFormats Class

TargetFormats Members

Help Version 19.0.2017.10.27

Leadtools.MediaFoundation Assembly

Introduction

Getting Started

Namespaces

Leadtools.MediaFoundation Namespace

Leadtools.MediaFoundation.Common Namespace

Assemblies