IAudioEndpoint::SetEventHandle method (audioengineendpoint.h)

The SetEventHandle method sets the handle for the event that the endpoint uses to signal that it has completed processing of a buffer.

Syntax

HRESULT SetEventHandle(
  [in] HANDLE eventHandle
);

Parameters

[in] eventHandle

The event handle used to invoke a buffer completion callback.

Return value

If the method succeeds, it returns S_OK. If it fails, possible return codes include, but are not limited to, the following.

Remarks

The SetEventHandle method sets the audio engine event handle on the endpoint. In this implementation, the caller should receive an error response of AEERR_NOT_INITIALIZED if the audio endpoint is not initialized or the buffer is not set by the SetBuffer method.

To get event notifications, the audio engine will have set the AUDCLNT_STREAMFLAGS_EVENTCALLBACK flag on the endpoint. To set this flag, the audio engine calls the IAudioEndpoint::SetStreamFlags method.

This method must not be called from a real-time processing thread.

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

Requirements

See also

IAudioEndpoint