Item Property

Summary

Gets the AudioInput item with the specified name.

Syntax
C#
VB
C++
public AudioInput Item( 
   string name 
) { get; } 
Public Overloads ReadOnly Property Item( _ 
   ByVal name As String _ 
) As AudioInput 
public: 
property AudioInput^ Item { 
   AudioInput^ get(String^ name); 
} 

Parameters

name
The string name of the item to get.

Property Value

The AudioInput item with the specified name.

Exceptions

ExceptionDescription
System.ArgumentOutOfRangeExceptionThe exception that is thrown when the value of an argument is outside the allowable range of values as defined by the invoked method.
System.NullReferenceExceptionThe exception that is thrown when there is an attempt to dereference a null object reference.

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. Audio Input names are unique. An application can use this method to find a specific input. An Audio Input name can be retrieved with the AudioInput.Name property. If the method fails, an error is raised. For more information, refer to the Error Codes.

Example
C#
VB
using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
 
public void IndexContainsExample() 
{ 
   try 
   { 
      // reference the form capture control 
      CaptureCtrl capturectrl = _form.CaptureCtrl; 
 
      // 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 form capture control's audio inputs 
      AudioInputs inputs = capturectrl.AudioInputs; 
 
      // check for the master volume input 
      int i = inputs.IndexOf("Master Volume"); 
 
      // access the input via the collection indexer 
      AudioInput ai = inputs[i]; 
 
      // check whether the collection contains this input  
      // (it should we just got it with IndexOf above!) 
      if (inputs.Contains(ai)) 
      { 
         // 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() 
   Try 
      ' reference the form capture control 
      Dim capturectrl As CaptureCtrl = _form.CaptureCtrl 
 
      ' 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 form capture control's audio inputs 
      Dim inputs As AudioInputs = capturectrl.AudioInputs 
 
      ' check for the master volume input 
      Dim i As Integer = inputs.IndexOf("Master Volume") 
 
      ' access the input via the collection indexer 
      Dim ai As AudioInput = inputs(i) 
 
      ' check if the collection contains this input  
      ' (it should we just got it with IndexOf above!) 
      If inputs.Contains(ai) 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

Help Version 20.0.2019.9.19
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Multimedia Assembly