IMediaSample2::SetProperties 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 SetProperties method sets the properties of a media sample.

Syntax

HRESULT SetProperties(
  [in] DWORD      cbProperties,
  [in] const BYTE *pbProperties
);

Parameters

[in] cbProperties

Length of property data to set, in bytes.

[in] pbProperties

Pointer to a buffer of size cbProperties.

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
S_OK	Success.
E_INVALIDARG	Invalid argument.
E_OUTOFMEMORY	Insufficient memory.
E_POINTER	NULL pointer argument.

Remarks

The data contained in AM_SAMPLE2_PROPERTIES structure. You can specify a subset of the sample properties by setting cbProperties to a value less than the size of the AM_SAMPLE2_PROPERTIES structure.

The standard implementation of this method does not support updating AM_SAMPLE2_PROPERTIES structure. If these members are not equal to zero, the method returns E_INVALIDARG. To modify the data contained in the sample's memory buffer, call IMediaSample::GetPointer.

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