Item(String) Property

Visual Basic
C#
C++/CLI

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

'Usage
 
Dim instance As Compressors
Dim name As String
Dim value As Compressor
 
value = instance.Item(name)

public Compressor Item( 
   string name
) {get;}

public:
property Compressor^ Item {
   Compressor^ get(String^ name);
}

Parameters

name: The string name of the item to get.

Property Value

The Compressor 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.

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. Compressor names are unique. An application can use this method to find a specific compressor. A Compressor's name can be retrieved with the Compressor.Name property or by using the LTMM DirectShow Filter List Utility. 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

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
      ' 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 compressors object
      Dim compressors As Compressors = capturectrl.VideoCompressors

      ' check the index of a video compressor
      Dim i As Integer = compressors.IndexOf(capturectrl.VideoCompressors.Mpeg2)

      Dim cmp As Compressor = Nothing
      If i > -1 Then
         ' access the compressor via the collection indexer
         cmp = compressors(i)
      End If

      ' check if the collection contains this input 
      ' (it should we just got it with IndexOf above)
      If compressors.Contains(cmp) Then
         ' set the result to what we expect
         _result = True
      End If
   Catch e1 As Exception
      _result = False
   End Try
End Sub

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
   {
      // 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 compressors object
      Compressors compressors = capturectrl.VideoCompressors;

      // check the index of a video compressor
      int i = compressors.IndexOf(capturectrl.VideoCompressors.Mpeg2);

      Compressor cmp = null;
      if (i > -1)
         // access the compressor via the collection indexer
         cmp = compressors[i];

      // check whether the collection contains this input 
      // (it should we just got it with IndexOf above)
      if (compressors.Contains(cmp))
      {
         // set the result to what we expect
         _result = true;
      }
   }
   catch (Exception)
   {
      _result = false;
   }
}

Target Platforms

Reference

Compressors Class
Compressors Members
Overload List