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



SampleFrequency
A value representing the sample frequency of the AudioFormat to find.
BitsPerSample
A value representing the bits per sample of the AudioFormat to find.
Channels
A value representing the number of channels of the AudioFormat to find.
SampleFrequency
A value representing the sample frequency of the AudioFormat to find.
BitsPerSample
A value representing the bits per sample of the AudioFormat to find.
Channels
A value representing the number of channels of the AudioFormat to find.
Returns the index of the first occurrence of a AudioFormat object whose name matches the given string.

Syntax

Visual Basic (Declaration) 
Overloads Public Function IndexOf( _
   ByVal SampleFrequency As Integer, _
   ByVal BitsPerSample As Integer, _
   ByVal Channels As Integer _
) As Integer
Visual Basic (Usage)Copy Code
Dim instance As AudioFormats
Dim SampleFrequency As Integer
Dim BitsPerSample As Integer
Dim Channels As Integer
Dim value As Integer
 
value = instance.IndexOf(SampleFrequency, BitsPerSample, Channels)
C# 
public int IndexOf( 
   int SampleFrequency,
   int BitsPerSample,
   int Channels
)
C++/CLI 
public:
int IndexOf( 
   int SampleFrequency,
   int BitsPerSample,
   int Channels
) 

Parameters

SampleFrequency
A value representing the sample frequency of the AudioFormat to find.
BitsPerSample
A value representing the bits per sample of the AudioFormat to find.
Channels
A value representing the number of channels of the AudioFormat to find.

Return Value

The zero-based index position of the AudioFormat item found, or -1 if not found.

Example

Visual BasicCopy 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 audio formats object
      Dim audioformats As AudioFormats = capturectrl.AudioCaptureFormats

      ' check the index of 8hz, 16-bit, stereo
      Dim i As Integer = audioformats.IndexOf(8000, 16, 2)

      ' access the format via the collection indexer
      Dim af As AudioFormat = audioformats(i)

      ' check if the collection contains this format 
      ' (it should we just got it with IndexOf above)
      If audioformats.Contains(af) Then
         ' set the result to what we expect
         _result = True
      End If
   Catch e1 As Exception
      _result = False
   End Try
End Sub
C#Copy Code
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, you should use your audio device name here
      if (capturectrl.AudioDevices["USB"] == null)
         throw new Exception("No USB audio device available");

      capturectrl.AudioDevices["USB"].Selected = true;

      // reference the audio formats object
      AudioFormats audioformats = capturectrl.AudioCaptureFormats;

      // check the index of 8hz, 16-bit, stereo
      int i = audioformats.IndexOf(8000, 16, 2);

      // access the format via the collection indexer
      AudioFormat af = audioformats[i];

      // check if the collection contains this format 
      // (it should we just got it with IndexOf above)
      if (audioformats.Contains(af))
      {
         // set the result to what we expect
         _result = true;
      }
   }            
   catch (Exception)
   {
      _result = false;
   }
}

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