←Select platform

FriendlyName Property (Device)

Summary

Gets the device's descriptive name.

Syntax

C++

public string FriendlyName {get;}

Public ReadOnly Property FriendlyName As String

public: 
property String^ FriendlyName { 
   String^ get(); 
}

Property Value

the device's friendly name.

Remarks

The returned name is not unique. However, it is ideal for presenting a descriptive name in user interfaces.

Example

using Leadtools; 
using Leadtools.MediaFoundation; 
using LeadtoolsMediaFoundationExamples.Fixtures; 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
 
public void DevicesExample() 
{ 
   string inputName, inputFriendlyName; 
   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 
   Devices devices = capturectrl.VideoDevices; 
 
   try 
   { 
      // select an input by name if possible 
      if (devices["USB"] != null) 
         devices["USB"].Selected = true; 
 
      // get the current selected input 
      selection = devices.Selection; 
 
      foreach (Device dev in devices) 
      { 
         // get the inputs properties 
         inputName = dev.Name; 
         inputFriendlyName = dev.FriendlyName; 
 
         // if we found a digital video capture device 
         if (inputFriendlyName.Contains("Digital")) 
         { 
            // select it and break 
            dev.Selected = true; 
            break; 
         } 
      } 
 
      // set the result to what we expect 
      _result = (selection != devices.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 DevicesExample() 
   Dim inputName, inputFriendlyName 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 devices As Devices = capturectrl.VideoDevices 
 
   Try 
      ' select an input by name if possible 
      If Not devices("USB") Is Nothing Then 
         devices("USB").Selected = True 
      End If 
 
      ' get the current selected input 
      selection = devices.Selection 
 
      For Each dev As Device In devices 
         ' get the inputs properties 
         inputName = dev.Name 
         inputFriendlyName = dev.FriendlyName 
 
         ' if we found a digital video capture device 
         If inputFriendlyName.Contains("Digital") Then 
            ' select it and break 
            dev.Selected = True 
            Exit For 
         End If 
      Next dev 
 
      ' set the result to what we expect 
      _result = (selection <> devices.Selection) 
 
   Catch e1 As Exception 
      _result = False 
   End Try 
End Sub