In This Topic ▼

Add(string,int) Method

Summary

Adds a TargetFormat item to the collection.

Syntax

C++

public void Add( 
   string Name, 
   int Index 
)

Public Overloads Sub Add( _ 
   ByVal Name As String, _ 
   ByVal Index As Integer _ 
)

public: 
void Add(  
   String^ Name, 
   int Index 
)

Parameters

Name
A String value representing the name of the new format.

Index
Zero based index of the position to insert the format. A value of -1 appends to end of the collection.

Remarks

The user should retrieve the item's object to define the individual properties of the format. The user may not insert a format before a predefined (ReadOnly) format. Check the initial Count value to determine the end of the predefined list. If the method fails, an error is raised. For more information, refer to the Error Codes.

Example

using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
 
public void AddExample() 
{ 
   // reference the capture control 
   CaptureCtrl capturectrl = _form.CaptureCtrl; 
 
   try 
   { 
      // set an audio device first.  use your audio device's name here 
      if (capturectrl.AudioDevices["USB"] == null) 
         throw new Exception("No USB audio device available"); 
 
      capturectrl.AudioDevices["USB"].Selected = true; 
 
      // reference the target formats collection 
      TargetFormats formats = capturectrl.TargetFormats; 
 
      // formats count before adding new one. 
      int nCount = formats.Count; 
 
      // demonstrating the add property, Add new format at the end of the collection 
      formats.Add("My Format", -1); 
 
      // get the newly added format 
      TargetFormat myFormat = capturectrl.TargetFormats[capturectrl.TargetFormats.Count - 1]; 
 
      // set the result to what we expect 
      _result = (nCount == (formats.Count - 1)); 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
}

Imports Leadtools 
Imports Leadtools.Multimedia 
Imports LeadtoolsMultimediaExamples.Fixtures 
 
Public _result As Boolean = False 
Public _form As CaptureCtrlForm = New CaptureCtrlForm() 
 
Public Sub AddExample() 
   ' reference the capture control 
   Dim capturectrl As CaptureCtrl = _form.CaptureCtrl 
 
   Try 
      ' set an audio device first, you should use your audio 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 
 
      ' reference the target formats collection 
      Dim formats As TargetFormats = capturectrl.TargetFormats 
 
      ' formats count before adding new one. 
      Dim nCount As Integer = formats.Count 
 
      ' demonstrating the add property, Add new format at the end of the collection 
      formats.Add("My Format", -1) 
 
      ' get the newly added format 
      Dim myFormat As TargetFormat = capturectrl.TargetFormats(capturectrl.TargetFormats.Count - 1) 
 
      ' set the result to what we expect 
      _result = (nCount = (formats.Count - 1)) 
 
   Catch e1 As Exception 
      _result = False 
   End Try 
End Sub

Requirements

Target Platforms

Reference

TargetFormats Class

TargetFormats Members

Overload List

Download our FREE evaluation

Help Version 20.0.2020.4.2

Leadtools.Multimedia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Multimedia Namespace

Leadtools.Multimedia.Common Namespace

Assemblies