ltmmFilterEnum.Enable Property

 

Syntax

Object.Enable(Name As String) As Boolean

 

Parameter

Description

Name

Name is a string that can show either the Display Name or the Friendly Name of the filter. It is better to use Display Name since display names are unique. Two filters can be different and yet still have the same Friendly Name. When two Friendly Names are used, this function works on the first filter it internally enumerates with the specified friendly name.

Remarks

Enables or disables a DirectShow filter.

Possible values are:

Setting

Description

TRUE

The input is enabled.

FALSE

The input is disabled.

A DirectShow filter is enabled if its Merit is above 0x00200000. Otherwise it is disabled.

Merit values are used when building filter graphs. For more information, refer to the Microsoft documentation for DirectShow Merit.

A Display Name uniquely identifies a Directshow filter (or any filter). Display names for software filters have the following format:

 @device:sw:GUID\\GUID

For example, Microsoft’s MPEG-2 Splitter display name is:

@device:sw:{083863F1-70DE-11D0-BD40-00A0C911CE86}\\{3AE86B20-7BE8-11D1-ABE6-00A0C905F375}.

Since a Friendly Name is not unique there can be more than one filter with the same name. Despite this, it is useful as a descriptive name in user interfaces. For example, the Friendly Name for Microsoft’s MPEG-2 Splitter is MPEG-2 Splitter.

Assigning a value to this property can raise an exception.  For more information, refer to the Error Codes.

 

Platforms

Win32, x64

See Also

Elements:

ltmmFilterEnum.Merit property

Topics:

Multimedia Properties, Methods and Events