KsStudio - Properties and Events

This topic describes how to use the KSStudio Utility to work with properties and events.

Working with Properties

Properties for which a filter declares support are shown as a subitem of each filter, pin instance, and node. These Properties are grouped by PropertySet and are displayed using the following font conventions:

Diagram displaying three fonts representing attributes of the ksproperty get and set status.

Shown in a blue font - Property is readable and writable (KSPROPERTY_TYPE_GET | KSPROPERTY_TYPE_SET)

Shown in a gray font - Property is read-only (KSPROPERTY_TYPE_GET)

Shown in a black font that is striked through - Property was declared as readable but a KSPROPERTY_TYPE_GET called failed

You can change the value of a property by double clicking on the current value. After changing the value, hit ENTER, and the new value will be sent to the driver. If the call fails, the failure will be logged.

Working with Events

Events for which a filter declares support are shown as a subitem of each filter, pin instance, and node. These Events are grouped by EventSet. Events are disabled by default. To enable an Event, right-click on it and choose Enable from the popup menu. This ungrays the Event lightbulb icon. When the Event is signaled (as in the case of the user pressing a button on the corresponding hardware) the Event lightbulb lights up for 200 ms.

See also

KSStudio Utility

KSStudio - Filters and Filter Factories

KSStudio - Pins and Nodes

KSStudio - KS Monitor

KSStudio - Usage Examples