IDvdInfo2::GetSubpictureAttributes method (strmif.h)

Article
02/22/2024

[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 GetSubpictureAttributes method retrieves the attributes of the specified subpicture stream in the specified title or menu.

Syntax

HRESULT GetSubpictureAttributes(
  [in]  ULONG                    ulStream,
  [out] DVD_SubpictureAttributes *pATR
);

Parameters

[in] ulStream

Index number, from 0 through 31, of the subpicture stream to query. See Remarks.

[out] pATR

Pointer to a DVD_SubpictureAttributes structure that receives the subpicture attributes.

Return value

Returns one of the following HRESULT values.

Return code	Description
S_OK	Success.
E_FAIL	No subpicture streams were found.
E_POINTER	Invalid argument.
VFW_E_DVD_NO_ATTRIBUTES	The subpicture has no defined attributes.

Remarks

The index numbers 0-31 are valid only for titles. Menus have only one subpicture stream, which must be specified using one of the constants in the table below:

Value	Description
DVD_STREAM_DATA_CURRENT (0x800)	To query the currently selected subpicture stream.
DVD_STREAM_DATA_VMGM (0x400)	To query the subpicture attributes for the Video Manager or "Top" Menu.
DVD_STREAM_DATA_VTSM (0x401)	To query the subpicture attributes for the currently selected Video Title Set Menu.

This method is demonstrated in the DVDSample application in CDvdCore::GetSPAttributes() and CSPLangDlg::GetSPLang.

Requirements

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