LEADTOOLS Multimedia (Leadtools.Multimedia assembly) Send comments on this topic. | Back to Introduction | Help Version 17.0.3.22
Constants.PreferredFilters Class
See Also  Members  
Leadtools.Multimedia Namespace : Constants.PreferredFilters Class



The PreferredFilters static class contains constant string values for predefined values that can be used to identify preferred filters.

It contains the "Don't Care", "LEAD Default" strings as well as defines for the display names of the most common LEAD filters.

Object Model

Constants.PreferredFilters Class

Syntax

Visual Basic (Declaration) 
Public MustInherit NotInheritable Class Constants.PreferredFilters
Visual Basic (Usage)Copy Code
Dim instance As Constants.PreferredFilters
C# 
public static class Constants.PreferredFilters
C++/CLI 
public ref class Constants.PreferredFilters abstract sealed

Example

Visual BasicCopy Code
Public _result As Boolean = False
Public _form As PlayCtrlForm = New PlayCtrlForm()
Public Sub PlayerPreferredFiltersExample()
    Try
        ' reference the forms capture control
        Dim playctrl As PlayCtrl = _form.PlayCtrl

        ' set the preferred mpeg2 decoder to the LEAD default (which is the LEAD MPEG2 Decoder)
        playctrl.SetPreferredFilter(PreferredFilter.MPEG2Decompressor, Leadtools.Multimedia.Constants.PreferredFilters.LEADDefault)

        ' the default mpeg2 decoder should be the LEAD MPEG2 decoder now
        ' the filter names are not case sensitive, so do ignore the case in the compare
        _result = (String.Compare(playctrl.GetPreferredFilter(PreferredFilter.MPEG2Decompressor), Leadtools.Multimedia.Constants.PreferredFilters.MPEG2Decompressor, True) = 0)
    Catch e1 As Exception
        _result = False
    End Try
End Sub
C#Copy Code
public bool _result = false;
public PlayCtrlForm _form = new PlayCtrlForm();
public void PlayerPreferredFiltersExample()
{
   PlayCtrl playctrl = _form.PlayCtrl;

   try
   {
      // set the preferred mpeg2 decoder to the LEAD default (which is the LEAD MPEG2 Decoder)
      playctrl.SetPreferredFilter(PreferredFilter.MPEG2Decompressor, Constants.PreferredFilters.LEADDefault);

      // the default mpeg2 decoder should be the LEAD MPEG2 decoder now
      // the filter names are not case sensitive, so do ignore the case in the compare
      _result = (string.Compare(playctrl.GetPreferredFilter(PreferredFilter.MPEG2Decompressor), Constants.PreferredFilters.MPEG2Decompressor, true) == 0);
   }
   catch (Exception)
   {
      _result = false;
   }
}

Remarks

The constants in this class are designed to be used with the ConvertCtrl.SetPreferredFilter, ConvertCtrl.GetPreferredFilter, PlayCtrl.GetPreferredFilter and PlayCtrl.SetPreferredFilter methods.

Inheritance Hierarchy

System.Object
   Leadtools.Multimedia.Constants.PreferredFilters

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also