IDvdInfo2::IsSubpictureStreamEnabled method (strmif.h)

[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 IsSubpictureStreamEnabled method determines if the specified subpicture stream is enabled in the current title.

Syntax

HRESULT IsSubpictureStreamEnabled(
  [in]  ULONG ulStreamNum,
  [out] BOOL  *pbEnabled
);

Parameters

[in] ulStreamNum

Subpicture stream number to test.

[out] pbEnabled

Pointer to a variable of type BOOL that receives a value of TRUE if the audio stream is enabled, or FALSE otherwise.

Return value

Returns one of the following HRESULT values.

Return code Description
S_OK
Success.
E_INVALIDARG
Invalid argument.
E_UNEXPECTED
The DVD Navigator is not initialized.

Remarks

A DVD can have up to 32 separate subpicture streams, although typically not all the streams will be enabled for each title. Use IsSubpictureStreamEnabled to determine whether a particular stream is enabled for the current title, and then call IDvdControl2::SelectSubpictureStream to select one of the enabled streams.

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

See also

DVD Applications

Error and Success Codes

IDvdInfo2 Interface