←Select platform

Item(String) Property

Summary

Gets the CaptureInput item with the specified name.

Syntax

C++

public Leadtools.Mediafoundation.CaptureInput Item(  
   string name 
) {get;}

Public Overloads ReadOnly Property Item( _ 
   ByVal name As String _ 
) As Leadtools.Mediafoundation.CaptureInput

public: 
property Leadtools.Mediafoundation.CaptureInput^ Item { 
   Leadtools.Mediafoundation.CaptureInput^ get(String^ name); 
}

Parameters

name
The string name of the item to get.

Property Value

The CaptureInput item with the specified name

'null' if no item matching the name exists

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.
System.NullReferenceException	The 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. Capture Input names are unique. An application can use this method to find a specific input. A Capture Input name can be retrieved with the CaptureInput.Name property. If the method fails, an error will be raised.

For more information, refer to the Error Codes.

Example

using Leadtools; 
using Leadtools.MediaFoundation; 
using LeadtoolsMediaFoundationExamples.Fixtures; 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
 
public void IndexContainsExample() 
{ 
   // reference the capture control 
   CaptureCtrl capturectrl = _form.CaptureCtrl; 
 
   try 
   { 
      // select a video device, use your device name here instead of Analog 
      if (capturectrl.VideoDevices["Analog"] == null) 
         throw new Exception("No Analog video tuner device available"); 
 
      capturectrl.VideoDevices["Analog"].Selected = true; 
 
      // reference the video inputs object 
      CaptureInputs inputs = capturectrl.VideoInputs; 
 
      // check the index of a video tuner 
      int i = inputs.IndexOf("Video Tuner"); 
 
      CaptureInput ci = null; 
      if (i > -1) 
         // access the input via the collection indexer 
         ci = inputs[i]; 
 
      // check if the collection contains this input  
      // (it should we just got it with IndexOf above) 
      if (inputs.Contains(ci)) 
      { 
         // set the result to what we expect 
         _result = true; 
      } 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
}

Imports Leadtools 
Imports Leadtools.MediaFoundation 
Imports LeadtoolsMediaFoundationExamples.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 
      ' select a video device, use your device name here instead of Analog 
      If capturectrl.VideoDevices("Analog") Is Nothing Then 
         Throw New Exception("No Analog video tuner device available") 
      End If 
 
      capturectrl.VideoDevices("Analog").Selected = True 
 
      ' reference the video inputs object 
      Dim inputs As CaptureInputs = capturectrl.VideoInputs 
 
      ' check the index of a video tuner 
      Dim i As Integer = inputs.IndexOf("Video Tuner") 
 
      Dim ci As CaptureInput = Nothing 
      If i > -1 Then 
         ' access the input via the collection indexer 
         ci = inputs(i) 
      End If 
 
      ' check if the collection contains this input  
      ' (it should we just got it with IndexOf above) 
      If inputs.Contains(ci) Then 
         ' set the result to what we expect 
         _result = True 
      End If 
   Catch e1 As Exception 
      _result = False 
   End Try 
End Sub