Edit

Share via

CAMEvent.CAMEvent constructor

  • Article

[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.]

Constructor method.

Syntax

CAMEvent(
   BOOL    fManualReset,
   HRESULT *phr
);

Parameters

fManualReset

Boolean value that specifies whether the object is a manual-reset event or an auto-reset event. If TRUE, the object is a manual-reset event. Otherwise, it is an auto-reset event.

phr

Pointer to an HRESULT value. If the constructor fails, this parameter receives an error code. If this occurs, the object is not in a valid state.

For backward compatibility with earlier versions of strmbase.lib, this parameter defaults to NULL. However, passing a non-NULL value is preferred, so that the caller can check the status of the object.

Remarks

The event begins in a nonsignaled state.

With an auto-reset event, the CAMEvent::Wait method resets the event to nonsignaled when the method returns. With a manual-reset event, the event remains signaled until you call the CAMEvent::Reset method.

Requirements

Requirement Value
Header
Wxutil.h (include Streams.h)
Library
Strmbase.lib (retail builds);
Strmbasd.lib (debug builds)

See also

CAMEvent Class