←Select platform

IndexOf(int,int,int) Method

Summary

Returns the index of the first occurrence of a AudioFormat object whose name matches the given string.

Syntax

C++

public int IndexOf( 
   int SampleFrequency, 
   int BitsPerSample, 
   int Channels 
)

Public Overloads Function IndexOf( _ 
   ByVal SampleFrequency As Integer, _ 
   ByVal BitsPerSample As Integer, _ 
   ByVal Channels As Integer _ 
) As Integer

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

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 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 whether the collection contains this format  
      // (it should since we just got it with IndexOf above) 
      if (audioformats.Contains(af)) 
      { 
         // 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 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

Requirements

Target Platforms

Reference

AudioFormats Class

AudioFormats Members

Overload List

Help Version 19.0.2017.10.27

Leadtools.Multimedia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Multimedia Namespace

Leadtools.Multimedia.Common Namespace

Assemblies