Item(String) Property

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public AudioInput Item( 
   string name
) {get;}

'Declaration
 
Public Overloads ReadOnly Property Item( _
   ByVal name As String _
) As AudioInput

'Usage
 
Dim instance As AudioInputs
Dim name As String
Dim value As AudioInput
 
value = instance.Item(name)

public AudioInput Item( 
   string name
) {get;}

 get_Item(String)();

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.

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.
System.NullReferenceException	The exception that is thrown when there is an attempt to dereference a null object reference.

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. Visual Basic 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.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

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

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;
   }
}

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

Reference

AudioInputs Class
AudioInputs Members
Overload List