FriendlyName Property

Summary
Gets the capture subtype's descriptive name.
Syntax
C#
VB
C++
public string FriendlyName {get;} 
Public ReadOnly Property FriendlyName As String 
public: 
property String^ FriendlyName { 
   String^ get(); 
} 

Property Value

String value of the capture subtype friendly name.

Remarks

Gets the capture subtype's descriptive name. The CaptureCtrl.VideoCaptureSubTypes property is a CaptureSubTypes object that contains all the subtypes available for the current capture device. The CaptureSubTypes collection contains an CaptureSubType object for each of the supported subtypes.

Example
C#
VB
using Leadtools; 
using Leadtools.MediaFoundation; 
using LeadtoolsMediaFoundationExamples.Fixtures; 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
 
public void CaptureSubTypesExample() 
{ 
   string name, friendlyName; 
   int selection; 
 
   // reference the capture control 
   CaptureCtrl capturectrl = _form.CaptureCtrl; 
 
   // 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; 
 
   // get the audio inputs object 
   CaptureSubTypes subTypes = capturectrl.VideoCaptureSubTypes; 
 
   // save the current subtype selection 
   selection = subTypes.Selection; 
 
   try 
   { 
      // select an capture subtype by name for MPEG2Video if available 
      if (subTypes[Constants.MEDIASUBTYPE_MPEG2Video] != null) 
      { 
         subTypes[Constants.MEDIASUBTYPE_MPEG2Video].Selected = true; 
      } 
      else // else try YUY2 
      if (subTypes[Constants.MEDIASUBTYPE_YUY2] != null) 
      { 
         subTypes[Constants.MEDIASUBTYPE_YUY2].Selected = true; 
      } 
 
      foreach (CaptureSubType cst in subTypes) 
      { 
         // get the subtype properties 
         name = cst.Name; 
         friendlyName = cst.FriendlyName; 
 
         // if we found the video tuner input 
         if (friendlyName == "YUY2") 
         { 
            // select it and break 
            cst.Selected = true; 
            break; 
         } 
      } 
 
      // set the result to what we expect 
      _result = (selection == subTypes.Selection); 
 
   } 
   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 CaptureSubTypesExample() 
   Dim name, friendlyName As String 
   Dim selection As Integer 
 
   ' reference the capture control 
   Dim capturectrl As CaptureCtrl = _form.CaptureCtrl 
 
   ' 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 
 
   ' get the audio inputs object 
   Dim subTypes As CaptureSubTypes = capturectrl.VideoCaptureSubTypes 
 
   ' save the current subtype selection 
   selection = subTypes.Selection 
 
   Try 
      ' select an capture subtype by name for MPEG2Video if available 
      If Not subTypes(Leadtools.MediaFoundation.Constants.MEDIASUBTYPE_MPEG2Video) Is Nothing Then 
         subTypes(Leadtools.MediaFoundation.Constants.MEDIASUBTYPE_MPEG2Video).Selected = True 
      Else ' else try YUY2 
         If Not subTypes(Leadtools.MediaFoundation.Constants.MEDIASUBTYPE_YUY2) Is Nothing Then 
            subTypes(Leadtools.MediaFoundation.Constants.MEDIASUBTYPE_YUY2).Selected = True 
         End If 
      End If 
 
      For Each cst As CaptureSubType In subTypes 
         ' get the subtype properties 
         name = cst.Name 
         friendlyName = cst.FriendlyName 
 
         ' if we found the video tuner input 
         If friendlyName = "YUY2" Then 
            ' select it and break 
            cst.Selected = True 
            Exit For 
         End If 
      Next cst 
 
      ' set the result to what we expect 
      _result = (selection = subTypes.Selection) 
 
   Catch e1 As Exception 
      _result = False 
   End Try 
End Sub 
Requirements

Target Platforms

Help Version 21.0.2021.7.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.MediaFoundation Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.