In This Topic ▼

FriendlyName Property

Summary

Gets the compressor's descriptive name.

Syntax

C++

public string FriendlyName { get; }

Public ReadOnly Property FriendlyName As String

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; 
   } 
}

Imports Leadtools 
Imports Leadtools.Multimedia 
Imports LeadtoolsMultimediaExamples.Fixtures 
 
Public _result As Boolean = False 
Public _form As CaptureCtrlForm = New CaptureCtrlForm() 
 
Public Sub CompressorsExample() 
   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 video compressors object 
   Dim compressors As VideoCompressors = capturectrl.VideoCompressors 
 
   Try 
      ' select an input by name if possible 
      If Not compressors.Mpeg2 Is Nothing Then 
         compressors.Mpeg2.Selected = True 
      End If 
 
      ' get the current selected input 
      selection = compressors.Selection 
 
      For Each cmp As Compressor In compressors 
         ' get the compressor properties 
         inputName = cmp.Name 
         inputFriendlyName = cmp.FriendlyName 
         Dim rel As CompressorReliability = cmp.Reliability 
 
         ' if we found the video tuner input 
         If inputFriendlyName = "LEAD H264 Encoder (4.0)" AndAlso rel = CompressorReliability.Stable Then 
            ' select it and break 
            cmp.Selected = True 
            Exit For 
         End If 
      Next cmp 
 
      ' set the result to what we expect 
      _result = (selection <> compressors.Selection) 
 
   Catch e1 As Exception 
      _result = False 
   End Try 
End Sub

Requirements

Target Platforms

Reference

Compressor Class

Compressor Members

Download our FREE evaluation

Help Version 20.0.2020.4.2

Leadtools.Multimedia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Multimedia Namespace

Leadtools.Multimedia.Common Namespace

Assemblies