LEADTOOLS Multimedia (Leadtools.Multimedia assembly) Send comments on this topic. | Back to Introduction | Help Version 17.0.3.22
Item(String) Property
See Also 
Leadtools.Multimedia Namespace > Compressors Class > Item Property : Item(String) Property



name
The string name of the item to get.
Gets the Compressor item with the specified name.

Syntax

Visual Basic (Declaration) 
Overloads Public ReadOnly Property Item( _
   ByVal name As String _
) As Compressor
Visual Basic (Usage)Copy Code
Dim instance As Compressors
Dim name As String
Dim value As Compressor
 
value = instance.Item(name)
C# 
public Compressor Item( 
   string name
) {get;}
C++/CLI 
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.

Exceptions

ExceptionDescription
System.ArgumentOutOfRangeException 

Example

Visual BasicCopy Code
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
C#Copy Code
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 if 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;
   }
}

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

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also