- filterType
- A PreferredFilter enumeration value specifying the desired filter type
Visual Basic (Declaration) | |
---|---|
Public Overridable Function GetPreferredFilter( _ ByVal filterType As PreferredFilter _ ) As String |
Visual Basic (Usage) | ![]() |
---|---|
Dim instance As ConvertCtrl Dim filterType As PreferredFilter Dim value As String value = instance.GetPreferredFilter(filterType) |
C# | |
---|---|
public virtual string GetPreferredFilter( PreferredFilter filterType ) |
C++/CLI | |
---|---|
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.Visual Basic | ![]() |
---|---|
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 |
C# | ![]() |
---|---|
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 // the filter names are not case sensitive, so do ignore the case in the compare _result = (string.Compare(convertCtrl.GetPreferredFilter(PreferredFilter.ISODemultiplexer), Constants.PreferredFilters.ISODemultiplexer, true) == 0); } catch (Exception) { _result = false; } } |
This method can be used to determine whether a preferred filter has been set by ConvertCtrl.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 ConvertCtrl.SetPreferredFilter for more information on filter display names.
Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7