GetPreferredFilter Method (CaptureCtrl)

Visual Basic
C#
C++/CLI

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

'Usage
 
Dim instance As CaptureCtrl
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.

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

Imports Leadtools
Imports Leadtools.Multimedia
Imports LeadtoolsMultimediaExamples.Fixtures

Public _result As Boolean = False
Public _form As CaptureCtrlForm = New CaptureCtrlForm()
Public Sub CapturePreferredFiltersExample()
   Try
      ' reference the forms capture control
      Dim captureCtrl As CaptureCtrl = _form.CaptureCtrl

      ' set the preferred H264 decompressor to the LEAD default (which is the LEAD H264 Decoder)
      captureCtrl.SetPreferredFilter(PreferredFilter.H264Decompressor, Leadtools.Multimedia.Constants.PreferredFilters.LEADDefault)

      ' the default H264 Decompressor should be the LEAD H264 Decoder now
      ' the filter names are not case sensitive, so do ignore the case in the compare
      _result = (String.Compare(captureCtrl.GetPreferredFilter(PreferredFilter.H264Decompressor), Leadtools.Multimedia.Constants.PreferredFilters.H264Decompressor, 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 CaptureCtrlForm _form = new CaptureCtrlForm();
public void CapturePreferredFiltersExample()
{
   CaptureCtrl captureCtrl = _form.CaptureCtrl;

   try
   {
      // set the preferred H264 decompressor to the LEAD default (which is the LEAD H264 Decoder)
      captureCtrl.SetPreferredFilter(PreferredFilter.H264Decompressor, Constants.PreferredFilters.LEADDefault);

      // the default H264 Decompressor should be the LEAD H264 Decoder now
      // filter names are not case sensitive, so ignore case in the compare
      _result = (string.Compare(captureCtrl.GetPreferredFilter(PreferredFilter.H264Decompressor),
                 Constants.PreferredFilters.H264Decompressor, true) == 0);
   }
   catch (Exception)
   {
      _result = false;
   }
}

Target Platforms

Reference

CaptureCtrl Class
CaptureCtrl Members
SetPreferredFilter Method