In This Topic ▼

FriendlyName Property

Summary

Gets the processor's descriptive name.

Syntax

C++/CLI

public string FriendlyName { get; }

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.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
 
public bool _result = false; 
public PlayCtrlForm _form = new PlayCtrlForm(); 
 
public void HasDialogExample() 
{ 
   // reference the play control 
   PlayCtrl playctrl = _form.PlayCtrl; 
 
   // EFX dizzy video processor 
   Processor processor = playctrl.VideoProcessors.EFXDizzy; 
   string processorName = processor.Name; 
   string processorFriendlyName = processor.FriendlyName; 
 
   // input file 
   string inFile = Path.Combine(LEAD_VARS.MediaDir, "PlayCtrl_ShortSource.avi"); 
 
   try 
   { 
      // set form title to friendly name 
      _form.Text = processorFriendlyName; 
 
      // turn off auto start 
      playctrl.AutoStart = false; 
 
      // set the source file 
      playctrl.SourceFile = inFile; 
 
      // add a video processor using unique name 
      int selectedProcessorIndex = playctrl.VideoProcessors.IndexOf(processorName); 
      Processor selectedProcessor = playctrl.VideoProcessors[selectedProcessorIndex]; 
      playctrl.SelectedVideoProcessors.Add(selectedProcessor); 
 
      // 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.EFXDizzy.HasDialog(ProcessorDlg.Properties)) 
      { 
         // now show it to change some settings 
         playctrl.SelectedVideoProcessors.EFXDizzy.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:\LEADTOOLS23\Media"; 
}

Requirements

Target Platforms

Reference

Processor Class

Processor 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