IAudioDeviceEndpoint::GetEventDrivenCapable method (audioengineendpoint.h)

The GetEventDrivenCapable method indicates whether the device endpoint is event driven. The device endpoint controls the period of the audio engine by setting events that signal buffer availability.

Syntax

HRESULT GetEventDrivenCapable(
  [out] BOOL *pbisEventCapable
);

Parameters

[out] pbisEventCapable

A value of TRUE indicates that the device endpoint is event driven. A value of FALSE indicates that it is not event driven. If the endpoint device is event driven, the audio engine can receive events from an audio device endpoint.

Return value

If the method succeeds, it returns S_OK.

Remarks

Call the GetEventDrivenCapable method before calling the IAudioDeviceEndpoint::SetBuffer method, which initializes the device endpoint and creates a buffer. This allows the device endpoint to set up the structures needed for driving events.

If the audio engine requires an event driven device endpoint, it will:

• Create an event and set the event handle on the device endpoint by calling the IAudioEndpoint::SetEventHandle method.
• Specify event driven mode by setting the AUDCLNT_STREAMFLAGS_EVENTCALLBACK flag on the device endpoint by calling the IAudioEndpoint::SetStreamFlags method.

The Remote Desktop Services AudioEndpoint API is for use in Remote Desktop scenarios; it is not for client applications.

Requirements

Requirement	Value
Minimum supported client	Windows 7
Minimum supported server	Windows Server 2008 R2
Target Platform	Windows
Header	audioengineendpoint.h

See also

IAudioDeviceEndpoint