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

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public static class Constants.PreferredFilters

'Declaration
 
Public MustInherit NotInheritable Class Constants.PreferredFilters

'Usage
 
Dim instance As Constants.PreferredFilters

public sealed static class Constants.PreferredFilters

function Leadtools.Multimedia.Constants.PreferredFilters()

public ref class Constants.PreferredFilters abstract sealed

Remarks

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

Example

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

Copy 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

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 ignore case in the compare
      _result = (string.Compare(playctrl.GetPreferredFilter(PreferredFilter.MPEG2Decompressor),
                 Constants.PreferredFilters.MPEG2Decompressor, true) == 0);
   }
   catch (Exception)
   {
      _result = false;
   }
}

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

Constants.PreferredFilters Members
Leadtools.Multimedia Namespace
GetPreferredFilter Method
SetPreferredFilter Method
GetPreferredFilter Method
SetPreferredFilter Method