IDxtJpeg::get_MaskName 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 get_MaskName method retrieves the name of a JPEG file to be used as the wipe mask.

Syntax

HRESULT get_MaskName(
  [out, retval] BSTR *pVal
);

Parameters

pVal [out, retval]

Receives the file name.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

If the wipe transition is using one of the built-in SMPTE wipes that it supports, the value of this property is an empty string.

The caller must release the returned string, using the SysFreeString function.

Requirements

See also

IDxtJpeg Interface

IDxtJpeg::get_MaskNum