In This Topic ▼

Item Property

Summary

Gets or sets the TargetVideoFormat item with the specified name.

Syntax

C++

public TargetVideoFormat Item( 
   string name 
) { get; set; }

Public Overloads Property Item( _ 
   ByVal name As String _ 
) As TargetVideoFormat

public: 
property TargetVideoFormat^ Item { 
   TargetVideoFormat^ get(String^ name); 
   void set (String^ name, TargetVideoFormat^ ); 
}

Parameters

name
The string name of the item to get or set.

Property Value

The TargetVideoFormat item with the specified name.

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 allows access to 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. An application can use this method to find a specific target video format. If the method fails, an error is 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 
   { 
      // set an video device first, you should use your video device name here 
      if (capturectrl.VideoDevices["USB"] == null) 
         throw new Exception("No USB video device available"); 
 
      capturectrl.VideoDevices["USB"].Selected = true; 
 
      // reference the target formats object 
      TargetFormats formats = capturectrl.TargetFormats; 
 
      // reference the target format object 
      TargetFormat tf = formats[TargetFormatType.MP4]; 
 
      // reference the target video formats object 
      TargetVideoFormats tvformats = tf.VideoFormats; 
 
      // check the index using a name string 
      int i = tvformats.IndexOf("{34363248-0000-0010-8000-00AA00389B71}");// H264 
 
      // get target video format object 
      TargetVideoFormat tvf = tvformats[i]; 
 
      // make sure the target video format object's name equals {34363248-0000-0010-8000-00AA00389B71} 
      if (tvf.Name == "{34363248-0000-0010-8000-00AA00389B71}") 
      { 
         // get target video format friendly name, use it for view propose. 
         string friendlyname = tvf.FriendlyName; 
      } 
      else 
         throw new Exception(); 
 
      // select it 
      tvf.Selected = true; 
 
      // check if the collection contains this format  
      // (it should we just got it with IndexOf above) 
      if (tvformats.Contains(tvf)) 
      { 
         // 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 
      ' set an video device first, you should use your video device name here 
      If capturectrl.VideoDevices("USB") Is Nothing Then 
         Throw New Exception("No USB video device available") 
      End If 
 
      capturectrl.VideoDevices("USB").Selected = True 
 
      ' reference the target formats object 
      Dim formats As TargetFormats = capturectrl.TargetFormats 
 
      ' reference the target format object 
      Dim tf As TargetFormat = formats(TargetFormatType.MP4) 
 
      ' reference the target video formats object 
      Dim tvformats As TargetVideoFormats = tf.VideoFormats 
 
      ' check the index using a name string 
      Dim i As Integer = tvformats.IndexOf("{34363248-0000-0010-8000-00AA00389B71}") ' H264 
 
      ' get target video format object 
      Dim tvf As TargetVideoFormat = tvformats(i) 
 
      ' make sure the target video format object's name equals {00000161-0000-0010-8000-00AA00389B71} 
      If tvf.Name = "{34363248-0000-0010-8000-00AA00389B71}" Then 
         ' get target video format friendly name, use it for view propose. 
         Dim friendlyname As String = tvf.FriendlyName 
      Else 
         Throw New Exception() 
      End If 
 
      ' select it 
      tvf.Selected = True 
 
      ' check if the collection contains this format  
      ' (it should we just got it with IndexOf above) 
      If tvformats.Contains(tvf) 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

Reference

TargetVideoFormats Class

TargetVideoFormats Members

Overload List

Download our FREE evaluation

Help Version 21.0.2021.7.2

Leadtools.MediaFoundation Assembly

Introduction

Getting Started

Namespaces

Leadtools.MediaFoundation Namespace

Leadtools.MediaFoundation.Common Namespace

Assemblies