LEADTOOLS Multimedia (Leadtools.Multimedia assembly)
LEAD Technologies, Inc

IndexOf(String) Method

Example 





The TargetFormat name to locate in the collection.
Determines the index of a specific TargetFormat name in the collection.
Syntax
public int IndexOf( 
   string name
)
'Declaration
 
Public Overloads Function IndexOf( _
   ByVal name As String _
) As Integer
'Usage
 
Dim instance As TargetFormats
Dim name As String
Dim value As Integer
 
value = instance.IndexOf(name)
public int IndexOf( 
   string name
)
 function Leadtools.Multimedia.TargetFormats.IndexOf(String)( 
   name 
)
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
Copy CodeCopy Code  
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
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;
   }
}
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

TargetFormats Class
TargetFormats Members
Overload List

 

 


Products | Support | Contact Us | Copyright Notices

© 2006-2012 All Rights Reserved. LEAD Technologies, Inc.

Leadtools.Multimedia requires a Multimedia or Multimedia Suite license and unlock key. For more information, refer to: LEADTOOLS Toolkit Features