MFRequireProtectedEnvironment function (mfidl.h)

Article
02/22/2024

Queries whether a media presentation requires the Protected Media Path (PMP).

Syntax

HRESULT MFRequireProtectedEnvironment(
  [in] IMFPresentationDescriptor *pPresentationDescriptor
);

Parameters

[in] pPresentationDescriptor

Pointer to the IMFPresentationDescriptor interface of a presentation descriptor. The presentation descriptor is created by the media source, and describes the presentation.

Return value

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	This presentation requires a protected environment.
S_FALSE	This presentation does not require a protected environment.

Remarks

If this function returns S_OK, it means the PMP is required for this presentation. Call MFCreatePMPMediaSession to create the PMP session object.

If the function returns S_FALSE, you can use the unprotected pipeline. Call MFCreateMediaSession to create the regular Media Session object.

Internally, this function checks whether any of the stream descriptors in the presentation have the MF_SD_PROTECTED attribute with the value TRUE.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	mfidl.h
Library	Mf.lib
DLL	Mf.dll