GetPreferredFilter Method (PlayCtrl)

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

public virtual string GetPreferredFilter( 
   PreferredFilter filterType
)

'Declaration
 
Public Overridable Function GetPreferredFilter( _
   ByVal filterType As PreferredFilter _
) As String

'Usage
 
Dim instance As PlayCtrl
Dim filterType As PreferredFilter
Dim value As String
 
value = instance.GetPreferredFilter(filterType)

public virtual string GetPreferredFilter( 
   PreferredFilter filterType
)

 function Leadtools.Multimedia.PlayCtrl.GetPreferredFilter( 
   filterType 
)

public:
virtual String^ GetPreferredFilter( 
   PreferredFilter filterType
)

Parameters

filterType: A PreferredFilter enumeration value specifying the desired filter type

Return Value

A string of a filter's display name.

This method can be used to determine whether a preferred filter has been set by SetPreferredFilter. It will return NULL (if no preferred filter has been set) or a display name indicating the preferred filter.

A display name uniquely identifies the filter. Display names have the following format:

@device:sw:GUID\GUID

For example, the display name for the LEAD MPEG2 Transport Demultiplexer is: @device:sw:{083863F1-70DE-11D0-BD40-00A0C911CE86}\{E2B7DF1A-38C5-11D5-91F6-00104BDB8FF9}

A list of display names for common filters can be found in Constants.PreferredFilters.

Please see SetPreferredFilter for more information on filter display names.

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

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

PlayCtrl Class
PlayCtrl Members
SetPreferredFilter Method