CBaseRenderer.ScheduleSample 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 ScheduleSample method schedules a sample for rendering.

Syntax

virtual BOOL ScheduleSample(
   IMediaSample *pMediaSample
);

Parameters

pMediaSample

Pointer to the sample's IMediaSample interface.

Return value

Returns TRUE if the sample was scheduled, or FALSE if the sample was dropped.

Remarks

This method first determines whether the sample should be rendered immediately, rendered in the future, or dropped. (To do so, it calls the CBaseRenderer::GetSampleTimes method.) If the sample should be rendered immediately, the method signals the CBaseRenderer::m_RenderEvent event. If the sample should be rendered in the future, the method calls the IReferenceClock::AdviseTime method for scheduling.

Requirements

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

See also

CBaseRenderer Class