KSPROPERTY_TOPOLOGYNODE_ENABLE
The KSPROPERTY_TOPOLOGYNODE_ENABLE property is used to turn on or off the topology nodes in an already built topology.
Usage Summary Table
| Get | Set | Target | Property descriptor type | Property value type |
|---|---|---|---|---|
Yes |
Yes |
Filter |
BOOL |
The property value (operation data) is of type BOOL and specifies whether the node is turned on or off. A value of TRUE indicates that the node is turned on. FALSE indicates that the node is turned off.
Return Value
A KSPROPERTY_TOPOLOGYNODE_ENABLE property request returns STATUS_SUCCESS to indicate that it has completed successfully. Otherwise, the request returns an appropriate error status code.
Remarks
Enabling an already enabled node or disabling an already disabled node has no effect, but should not be treated as an error.
Disabling a node turns off the transformation that the node performs on the stream that passes through the node. In the case of an AEC, AGC, or noise-suppression node (KSNODETYPE_ACOUSTIC_ECHO_CANCEL, KSNODETYPE_AGC, or KSNODETYPE_NOISE_SUPPRESS), for example, a disabled node operates in pass-through mode (that is, it performs no operation on the stream as it flows from the node's input pin to its output pin).
Requirements
Header |
Ksmedia.h (include Ksmedia.h) |