LEADTOOLS Multimedia (Leadtools.Multimedia assembly) Send comments on this topic. | Back to Introduction | Help Version 17.0.3.22
Remove Method
See Also 
Leadtools.Multimedia Namespace > TargetFormats Class : Remove Method



item
The TargetFormat to be removed.
item
The TargetFormat to be removed.
Removes a TargetFormat item from the collection.

Syntax

Visual Basic (Declaration) 
Public Function Remove( _
   ByVal item As TargetFormat _
) As Boolean
Visual Basic (Usage)Copy Code
Dim instance As TargetFormats
Dim item As TargetFormat
Dim value As Boolean
 
value = instance.Remove(item)
C# 
public bool Remove( 
   TargetFormat item
)
C++/CLI 
public:
bool Remove( 
   TargetFormat^ item
) 

Parameters

item
The TargetFormat to be removed.

Return Value

System.Boolean

Example

Visual BasicCopy Code
Public _result As Boolean = False
Public _form As CaptureCtrlForm = 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

      ' no recompression for video and audio
      capturectrl.VideoCompressors.Mpeg2.Selected = True
      capturectrl.AudioCompressors.AC3.Selected = True

      ' select the DVD target format
      capturectrl.TargetFormats(TargetFormatType.DVD).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 sink As String = t.Sink
         Dim sinkSubType As String = t.SinkSubType
         Dim audio As String = t.AudioCompressor
         Dim video As String = t.VideoCompressor
         Dim sRecAudio As String = t.RecommendedAudioCompressor
         Dim sRecVideo As String = t.RecommendedVideoCompressor
         Dim mux As String = t.Mux
         Dim avMux As String = t.AVMux
         Dim sft As StreamFormatType = t.Streams

         ' if we found the video tuner input
         If name = "AVI" Then
            ' select it and break
            t.Selected = True
            Exit For
         End If
      Next t

      ' check it directly
      Dim tft As TargetFormatType = capturectrl.TargetFormat

      ' set the result to what we expect
      _result = (tft <> TargetFormatType.DVD AndAlso n <> capturectrl.TargetFormats.Selection)
   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
C#Copy Code
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;

      // no recompression for video and audio
      capturectrl.VideoCompressors.Mpeg2.Selected = true;
      capturectrl.AudioCompressors.AC3.Selected = true;

      // select the DVD target format
      capturectrl.TargetFormats[TargetFormatType.DVD].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;
         string sink = t.Sink;
         string sinkSubType = t.SinkSubType;
         string audio = t.AudioCompressor;
         string video = t.VideoCompressor;
         string sRecAudio = t.RecommendedAudioCompressor;
         string sRecVideo = t.RecommendedVideoCompressor;
         string mux = t.Mux;
         string avMux = t.AVMux;
         StreamFormatType sft = t.Streams;

         // if we found the video tuner input
         if (name == "AVI")
         {
            // 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.DVD && 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();
}

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.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also