COutputQueue.IsSpecialSample method

[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 IsSpecialSample method determines whether queued data is a control message.

Syntax

BOOL IsSpecialSample(
   IMediaSample *pSample
);

Parameters

pSample

Pointer to an item in the queue.

Return value

Returns TRUE if pSample is a control message, or FALSE otherwise.

Remarks

The COutputQueue::QueueSample method can receive control messages in addition to media samples. A control message is a defined constant (cast to a LONG_PTR type) that instructs the thread to perform an action. Control messages do not contain media data. For more information, see COutputQueue::QueueSample.

Requirements

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

See also

COutputQueue Class