In This Topic ▼

IndexOf(string) Method

Summary

Determines the index of a specific TargetFormat name in the collection.

Syntax

C++

public int IndexOf( 
   string name 
)

Public Overloads Function IndexOf( _ 
   ByVal name As String _ 
) As Integer

public: 
int IndexOf(  
   String^ name 
)

Parameters

name
The TargetFormat name to locate in the collection.

Return Value

The zero-based index of the found item; otherwise -1 if no item found.

Remarks

This method searches the underlying item collection to locate the item name specified.

Example

using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
 
public void IndexContainsExample() 
{ 
   // 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 object 
      TargetFormats formats = capturectrl.TargetFormats; 
 
      // check the index using a name string 
      int i = formats.IndexOf("WAVE"); 
 
      // or get a target format directly, using a TargetFormatType enum 
      TargetFormat mpeg1 = formats[TargetFormatType.MPEG1Audio]; 
 
      // access the format via the collection indexer 
      TargetFormat af = formats[i]; 
 
      // check whether the collection contains this format  
      // (it should we just got it with IndexOf above) 
      if (formats.Contains(af) && formats.Contains(mpeg1)) 
      { 
         // set the result to what we expect 
         _result = true; 
      } 
   } 
   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 IndexContainsExample() 
   ' 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 object 
      Dim formats As TargetFormats = capturectrl.TargetFormats 
 
      ' check the index using a name string 
      Dim i As Integer = formats.IndexOf("WAVE") 
 
      ' or get a target format directly, using a TargetFormatType enum 
      Dim mpeg1 As TargetFormat = formats(TargetFormatType.MPEG1Audio) 
 
      ' access the format via the collection indexer 
      Dim af As TargetFormat = formats(i) 
 
      ' check if the collection contains this format  
      ' (it should we just got it with IndexOf above) 
      If formats.Contains(af) AndAlso formats.Contains(mpeg1) Then 
         ' set the result to what we expect 
         _result = True 
      End If 
   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