In This Topic ▼

FriendlyName Property

Summary

Gets the device's descriptive name.

Syntax

C++/CLI

public string FriendlyName {get;}

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 USB 
   if (capturectrl.VideoDevices["USB"] == null) 
      throw new Exception("No USB video device available"); 
 
   capturectrl.VideoDevices["USB"].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 device whose name contains the word "Capture" 
         if (inputFriendlyName.Contains("Capture")) 
         { 
            // select it and break 
            dev.Selected = true; 
            break; 
         } 
      } 
 
      // set the result to what we expect 
      _result = (selection != devices.Selection); 
 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
}

Requirements

Target Platforms

Reference

Device Class

Device Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.MediaFoundation Assembly

Introduction

Getting Started

Namespaces

Leadtools.MediaFoundation Namespace

Leadtools.MediaFoundation.Common Namespace

Assemblies