IMediaSample::SetSyncPoint method (strmif.h)

Article
07/27/2023

[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 SetSyncPoint method specifies whether the beginning of this sample is a synchronization point.

Syntax

HRESULT SetSyncPoint(
  [in] BOOL bIsSyncPoint
);

Parameters

[in] bIsSyncPoint

Boolean value that specifies whether this is a synchronization point. If TRUE, this is a synchronization point.

Return value

Returns S_OK or an HRESULT value indicating the cause of the error.

Remarks

The filter that first generates the data in the sample should set this flag to TRUE or FALSE, as appropriate. For uncompressed video and PCM audio, set every sample to TRUE. For compressed video, set key frames to TRUE and delta frames to FALSE.

This flag is purely informational. Other filters downstream might check this flag; for example, a filter might need to skip to the next key frame.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib