KSPROPERTY_RTAUDIO_REGISTER_NOTIFICATION_EVENT

The KSPROPERTY_RTAUDIO_REGISTER_NOTIFICATION_EVENT property registers a user-mode event for DMA-driven event notification. Events must be registered after successfully calling KSPROPERTY_RTAUDIO_BUFFER_WITH_NOTIFICATION.

The following table summarizes the features of this property.

Usage Summary Table

GetSetTargetProperty descriptor typeProperty value type

Yes

Yes

Pin

KSRTAUDIO_NOTIFICATION_EVENT_PROPERTY

NULL

 

The property descriptor (instance data) consists of a KSRTAUDIO_NOTIFICATION_EVENT_PROPERTY structure that contains a KSPROPERTY structure along with a user-mode event handle.

The property value (operation data) for this property is NULL because no operation data is returned.

Return Value

A KSPROPERTY_ RTAUDIO_REGISTER_NOTIFICATION_EVENT property request returns STATUS_SUCCESS to indicate that it has completed successfully. Otherwise, the request returns an appropriate failure status code. The following table shows some of the possible failure status codes.

Status codeMeaning

STATUS_NOT_SUPPORTED

Event notifications are not supported.

STATUS_INSUFFICIENT_RESOURCES

Memory for the buffer cannot be allocated.

STATUS_DEVICE_NOT_READY

The device is not ready.

 

Remarks

This property is used to register user-mode events for DMA-driven event notification.

When the pin is placed into the run state (KSSTATE_RUN) the registered events are signaled once or twice per cycle of the cyclic audio buffer, depending on the notification count requested when KSPROPERTY_RTAUDIO_BUFFER_WITH_NOTIFICATION was called. For more information about KSSTATERUN, see the State Transitions topic.

After you stop the pin, and prior to the time when you close it, each registered event is unregistered via a call to KSPROPERTY_RTAUDIO_UNREGISTER_NOTIFICATION_EVENT.

Requirements

Version

Available in Windows Vista and later Windows operating systems.

Header

Ksmedia.h

See also

KSPROPERTY
KSPROPERTY_RTAUDIO_BUFFER_WITH_NOTIFICATION
KSPROPERTY_RTAUDIO_UNREGISTER_NOTIFICATION_EVENT
State Transitions

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft