In This Topic ▼

FriendlyName Property

Summary

Gets a character string that contains the device's descriptive name.

Syntax

C++/CLI

public string FriendlyName { get; }

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

Property Value

A character string that contains the device's descriptive name.

Remarks

Gets a character string that contains the device's descriptive name. The device's descriptive name is not unique. However, it is ideal for presenting a descriptive name in user interfaces.

Example

using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
 
public bool _result = false; 
public ConvertCtrlForm _form = new ConvertCtrlForm(); 
 
public void TargetDevicesExample() 
{ 
   string inputName, inputFriendlyName; 
   int selectedCamera; 
 
   // reference the convert control 
   ConvertCtrl convertctrl = _form.ConvertCtrl; 
 
   try 
   { 
      // get the target devices object 
      TargetDevices devices = convertctrl.TargetDevices; 
 
      // select an output by name if possible 
      if (devices["Microsoft DV Camera"] == null) 
      { 
         MessageBox.Show("No MS DV Camera device available! Please connect the device and click OK."); 
         devices.Refresh(); 
         if (devices["Microsoft DV Camera"] == null) 
            throw new Exception("No MS DV Camera device available!"); 
      } 
      devices["Microsoft DV Camera"].Selected = true; 
 
      // get the full friendly name of the device  
      string friendlyName = devices["Microsoft DV Camera"].FriendlyName; 
 
      // get the selected index of the currently selected target device 
      // (the MS DV camera above) 
      selectedCamera = devices.Selection; 
 
      // now enumerate all the target devices, 
      // looking for an audio device and select it 
      foreach (TargetDevice td in devices) 
      { 
         // get the inputs properties 
         inputName = td.Name; 
         inputFriendlyName = td.FriendlyName; 
 
         // if we found a target audio device 
         if (inputFriendlyName.Contains("Audio")) 
         { 
            // select it and break 
            td.Selected = true; 
            break; 
         } 
      } 
 
      // set the result to what we expect 
      _result = (selectedCamera != devices.Selection); 
 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
}

Requirements

Target Platforms

Reference

TargetDevice Class

TargetDevice Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Multimedia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Multimedia Namespace

Leadtools.Multimedia.Common Namespace

Assemblies