FriendlyName Property (Processor)

C#
Visual Basic
Objective-C
Java
C++

public string FriendlyName {get;}

'Declaration

Public ReadOnly Property FriendlyName As String

'Usage

Dim instance As Processor
Dim value As String
 
value = instance.FriendlyName

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

Property Value

A string that represents the processor's descriptive name.

The returned name is not unique. However, it is ideal for presenting a descriptive name in user interfaces.

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.Multimedia
Imports LeadtoolsMultimediaExamples.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

      ' add a video processor
      playctrl.SelectedVideoProcessors.Add(playctrl.VideoProcessors.EFXDizzy)

      ' 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) Then
         ' now show it to change some settings
         playctrl.SelectedVideoProcessors.EFXDizzy.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 19\Media"
End Class

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;

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

      // add a video processor
      playctrl.SelectedVideoProcessors.Add(playctrl.VideoProcessors.EFXDizzy);

      // 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:\Program Files (x86)\LEAD Technologies\LEADTOOLS 19\Media";
}

Target Platforms

Reference

Processor Class
Processor Members