EFFECTS Element
[The feature associated with this page, Windows Media Player SDK, is a legacy feature. It has been superseded by MediaPlayer. MediaPlayer has been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer instead of Windows Media Player SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
The EFFECTS element provides a way to organize and manipulate visualizations by using the following attributes and methods. A predefined EFFECTS element is also provided for convenience.
The EFFECTS element supports the following attributes.
| Attribute | Description |
|---|---|
| allowAll | Specifies or retrieves a value indicating whether to include all the visualizations in the registry. |
| currentEffect | Specifies or retrieves the current visualization. |
| currentEffectPresetCount | Retrieves number of available presets for the current visualization. |
| currentEffectTitle | Retrieves the display title of the current visualization. |
| currentEffectType | Retrieves the registry name of the current visualization. |
| currentPreset | Specifies or retrieves the current preset of the current visualization. |
| currentPresetTitle | Retrieves the title of the current preset of the current visualization. |
| effectCanGoFullScreen | Retrieves a value indicating whether the current visualization can be displayed full-screen. |
| effectCount | Retrieves the number of visualizations available. |
| effectHasPropertyPage | Retrieves a value indicating whether the current visualization has a property page. |
| fullScreen | Specifies or retrieves a value indicating whether the current visualization is displayed full-screen. Can only be set at run time. |
| windowed | Specifies or retrieves a value indicating whether the visualization will be windowed or windowless, that is, whether the entire rectangle of the control will be visible at all times, or whether it can be clipped. Can only be set at design time. |
The EFFECTS element supports the following methods.
| Method | Description |
|---|---|
| effectTitle | Retrieves the friendly name of the visualization with the specified registry index. |
| effectType | Retrieves the registry name of the visualization with the specified registry index. |
| next | Displays the next visualization preset, moving to the next visualization if necessary. |
| nextEffect | Displays the first preset of the next visualization, skipping intervening presets. |
| nextPreset | Displays the next preset of the current visualization. |
| previous | Displays the previous visualization preset, moving to the last preset of the previous visualization if necessary. |
| previousEffect | Displays the previous visualization, skipping presets. |
| previousPreset | Displays the previous preset of the current visualization. |
| settings | Displays the attribute page for the current visualization, if present. |
The EFFECTS element supports the ambient attributes and can implement the ambient event handlers. For more information, see Ambient Attributes and Ambient Event Handlers.
Predefined effects are normal EFFECTS elements with various common attribute settings specified by default. The following predefined effects are available.
| Predefined EFFECTS | Description |
|---|---|
| WMPEFFECTS | An EFFECTS element that iterates through the available effects. |
Related topics