LEADTOOLS Multimedia (Leadtools.Multimedia assembly)

GetPreferredFilter Method (ConvertCtrl)

Show in webframe
Example 



A PreferredFilter enumeration value specifying the desired filter type.
Retrieves the preferred filter's Display Name set using the SetPreferredFilter method.
Syntax
'Declaration
 
Public Overridable Function GetPreferredFilter( _
   ByVal filterType As PreferredFilter _
) As String
'Usage
 
Dim instance As ConvertCtrl
Dim filterType As PreferredFilter
Dim value As String
 
value = instance.GetPreferredFilter(filterType)
public virtual string GetPreferredFilter( 
   PreferredFilter filterType
)
public:
virtual String^ GetPreferredFilter( 
   PreferredFilter filterType
) 

Parameters

filterType
A PreferredFilter enumeration value specifying the desired filter type.

Return Value

A string containing 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
Copy Code  
Imports Leadtools
Imports Leadtools.Multimedia
Imports LeadtoolsMultimediaExamples.Fixtures

Public _result As Boolean = False
Public _form As ConvertCtrlForm = New ConvertCtrlForm()
Public Sub ConverterPreferredFiltersExample()
   Try
      ' reference the forms capture control
      Dim convertCtrl As ConvertCtrl = _form.ConvertCtrl

      ' set the preferred ISO Demultiplexer to the LEAD default (which is the LEAD ISO Demultiplexer)
      convertCtrl.SetPreferredFilter(PreferredFilter.ISODemultiplexer, _
                                     Leadtools.Multimedia.Constants.PreferredFilters.LEADDefault)

      ' the default ISO Demultiplexer should be the LEAD ISO Demultiplexer now
      ' the filter names are not case sensitive, so do ignore the case in the compare
      _result = (String.Compare(convertCtrl.GetPreferredFilter(PreferredFilter.ISODemultiplexer), _
                                Leadtools.Multimedia.Constants.PreferredFilters.ISODemultiplexer, True) = 0)
       Catch e1 As Exception
           _result = False
       End Try
   End Sub
using Leadtools;
using Leadtools.Multimedia;
using LeadtoolsMultimediaExamples.Fixtures;

public bool _result = false;
public ConvertCtrlForm _form = new ConvertCtrlForm();
public void ConverterPreferredFiltersExample()
{
   ConvertCtrl convertCtrl = _form.ConvertCtrl;

   try
   {
      // set the preferred ISO Demultiplexer to the LEAD default (which is the LEAD ISO Demultiplexer)
      convertCtrl.SetPreferredFilter(PreferredFilter.ISODemultiplexer, Constants.PreferredFilters.LEADDefault);

      // the default ISO Demultiplexer should be the LEAD ISO Demultiplexer now
      // filter names are not case sensitive, so ignore case in the compare
      _result = (string.Compare(convertCtrl.GetPreferredFilter(PreferredFilter.ISODemultiplexer),
                 Constants.PreferredFilters.ISODemultiplexer, true) == 0);
   }
   catch (Exception)
   {
      _result = false;
   }
}
Requirements

Target Platforms

See Also

Reference

ConvertCtrl Class
ConvertCtrl Members
SetPreferredFilter Method

 

 


Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.

Leadtools.Multimedia requires a Multimedia or Multimedia Suite license and unlock key. For more information, refer to: LEADTOOLS Toolkit Features