In This Topic ▼

FriendlyName Property

Summary

Gets the processor'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 that represents the processor's descriptive 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 PlayCtrlForm _form = new PlayCtrlForm(); 
 
public void HasDialogExample() 
{ 
   // reference the play control 
   PlayCtrl playctrl = _form.PlayCtrl; 
 
   // input file 
   string inFile = Path.Combine(LEAD_VARS.MediaDir, "PlayCtrl_Source.avi"); 
 
   try 
   { 
      // turn off auto start 
      playctrl.AutoStart = false; 
 
      // set the source file 
      playctrl.SourceFile = inFile; 
 
 
      // get index of lead video Stabilizer transform 
      int nIndex = playctrl.VideoProcessors.IndexOf("{E2B6EDDE-38C5-11D5-91F6-00104BDB8FF9}"); 
 
      // add the lead video Stabilizer transform to the selected video processors 
      playctrl.SelectedVideoProcessors.Add(playctrl.VideoProcessors[nIndex]); 
 
      // The HasDialog method tells us that the object 
      // can display the desired dialog. 
      // check to see if the processor dialog can be displayed 
      if (playctrl.SelectedVideoProcessors[0].HasDialog(ProcessorDlg.Properties)) 
      { 
         // now show it to change some settings 
         playctrl.SelectedVideoProcessors[0].ShowDialog(ProcessorDlg.Properties, _form); 
         _result = true; 
      } 
 
      // start the playback 
      playctrl.Run(); 
 
      // we'll loop on the state and pump messages for this example. 
      // but you should not need to if running from a Windows Forms application. 
      while (playctrl.State == PlayState.Running) 
         Application.DoEvents(); 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string MediaDir = @"C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 20\Media"; 
}

Imports Leadtools 
Imports Leadtools.MediaFoundation 
Imports LeadtoolsMediaFoundationExamples.Fixtures 
 
Public _result As Boolean = False 
Public _form As PlayCtrlForm = New PlayCtrlForm() 
 
Public Sub HasDialogExample() 
   ' reference the play control 
   Dim playctrl As PlayCtrl = _form.PlayCtrl 
 
   ' input file 
   Dim inFile As String = Path.Combine(LEAD_VARS.MediaDir, "PlayCtrl_Source.avi") 
 
   Try 
      ' turn off auto start 
      playctrl.AutoStart = False 
 
      ' set the source file 
      playctrl.SourceFile = inFile 
 
      ' get index of lead video Stabilizer transform 
      Dim nIndex As Integer = playctrl.VideoProcessors.IndexOf("{E2B6EDDE-38C5-11D5-91F6-00104BDB8FF9}") 
 
      ' add the lead video Stabilizer transform to the selected video processors 
      playctrl.SelectedVideoProcessors.Add(playctrl.VideoProcessors(nIndex)) 
 
      ' The HasDialog method tells us that the object 
      ' can display the desired dialog. 
      ' check to see if the processor dialog can be displayed 
      If playctrl.SelectedVideoProcessors(0).HasDialog(ProcessorDlg.Properties) Then 
         ' now show it to change some settings 
         playctrl.SelectedVideoProcessors(0).ShowDialog(ProcessorDlg.Properties, _form) 
         _result = True 
      End If 
 
      ' start the playback 
      playctrl.Run() 
 
      ' we'll loop on the state and pump messages for this example. 
      ' but you should not need to if running from a Windows Forms application. 
      Do While playctrl.State = PlayState.Running 
         Application.DoEvents() 
      Loop 
   Catch e1 As Exception 
      _result = False 
   End Try 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const MediaDir As String = "C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 20\Media" 
End Class

Requirements

Target Platforms

Reference

Processor Class

Processor Members

Download our FREE evaluation

Help Version 20.0.2020.4.2

Leadtools.MediaFoundation Assembly

Introduction

Getting Started

Namespaces

Leadtools.MediaFoundation Namespace

Leadtools.MediaFoundation.Common Namespace

Assemblies