IMediaEvent interface (control.h)
[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
The IMediaEvent interface contains methods for retrieving event notifications and for overriding the Filter Graph Manager's default handling of events. The IMediaEventEx interface inherits this interface and extends it.
The Filter Graph Manager implements this interface. Applications can use it to respond to events that occur in the filter graph, such as the end of a stream or a rendering error. Filters post events to the filter graph using the IMediaEventSink interface.
For more information about event notification, see Event Notification in DirectShow. For a list of system-defined event notifications, see Event Notification Codes.
Inheritance
The IMediaEvent interface inherits from the IDispatch interface. IMediaEvent also has these types of members:
Methods
The IMediaEvent interface has these methods.
| IMediaEvent::CancelDefaultHandling The CancelDefaultHandling method cancels the Filter Graph Manager's default handling for a specified event. The event notification is passed to the application. |
| IMediaEvent::FreeEventParams The FreeEventParams method frees resources associated with the parameters of an event. |
| IMediaEvent::GetEvent The GetEvent method retrieves the next event notification from the event queue. |
| IMediaEvent::GetEventHandle The GetEventHandle method retrieves a handle to a manual-reset event that remains signaled while the queue contains event notifications. |
| IMediaEvent::RestoreDefaultHandling The RestoreDefaultHandling method restores the Filter Graph Manager's default handling for a specified event. |
| IMediaEvent::WaitForCompletion The WaitForCompletion method waits for the filter graph to render all available data. The filter graph must be running or the method fails. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | control.h (include Dshow.h) |