In This Topic ▼

FriendlyName Property

Summary

Gets the compressor's descriptive name.

Syntax

C++/CLI

public string FriendlyName { get; }

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

Property Value

A string value of the compressor'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.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
 
public void CompressorsExample() 
{ 
   string inputName, inputFriendlyName; 
   int selection; 
 
   // reference the capture control 
   CaptureCtrl capturectrl = _form.CaptureCtrl; 
 
   // select a video device, use your device's 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 video compressors object 
   VideoCompressors compressors = capturectrl.VideoCompressors; 
 
   try 
   { 
      // select an input by name if possible 
      if (compressors.Mpeg2 != null) 
         compressors.Mpeg2.Selected = true; 
 
      // get the current selected input 
      selection = compressors.Selection; 
 
      foreach (Compressor cmp in compressors) 
      { 
         // get the compressor properties 
         inputName = cmp.Name; 
         inputFriendlyName = cmp.FriendlyName; 
         CompressorReliability rel = cmp.Reliability; 
 
         // if we found the video tuner input 
         if (inputFriendlyName == "LEAD H264 Encoder (4.0)" 
            && rel == CompressorReliability.Stable) 
         { 
            // select it and break 
            cmp.Selected = true; 
            break; 
         } 
      } 
 
      // set the result to what we expect 
      _result = (selection != compressors.Selection); 
 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
}

Requirements

Target Platforms

Reference

Compressor Class

Compressor Members

Download our FREE evaluation

Help Version 22.0.2022.12.7

Leadtools.Multimedia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Multimedia Namespace

Leadtools.Multimedia.Common Namespace

Assemblies