In This Topic ▼

Item Property

Summary

Gets the AudioFormat item at the specified index.

Syntax

C++/CLI

public AudioFormat Item( 
   int index 
) { get; }

public: 
property AudioFormat^ default [int] { 
   AudioFormat^ get(int index); 
}

Parameters

index
The zero-based index of the item to get.

Property Value

The AudioFormat item at the specified index.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	The exception that is thrown when the value of an argument is outside the allowable range of values as defined by the invoked method.

Remarks

This property provides the ability to access a specific item in the collection by using the following syntax: myCollection[index]. The C# language uses the this keyword to define the indexers instead of implementing the Item property. VB implements Item as a default property, which provides the same indexing functionality.

Example

using Leadtools; 
using Leadtools.MediaFoundation; 
using LeadtoolsMediaFoundationExamples.Fixtures; 
 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(false); 
 
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

Reference

AudioFormats Class

AudioFormats Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.MediaFoundation Assembly

Introduction

Getting Started

Namespaces

Leadtools.MediaFoundation Namespace

Leadtools.MediaFoundation.Common Namespace

Assemblies