In This Topic ▼

GetPreferredFilter Method

Summary

Retrieves the preferred filter's Display Name set using the SetPreferredFilter method.

Syntax

C++

public virtual string GetPreferredFilter( 
   PreferredFilter filterType 
)

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

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.

Remarks

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.

Example

using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
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; 
   } 
}

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

Requirements

Target Platforms

Reference

PlayCtrl Class

PlayCtrl Members

SetPreferredFilter Method

Download our FREE evaluation

Help Version 20.0.2020.4.2

Leadtools.Multimedia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Multimedia Namespace

Leadtools.Multimedia.Common Namespace

Assemblies