IDvdInfo::GetCurrentSubpicture 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.]

Note  The IDvdInfo interface is deprecated. Use IDvdInfo2 instead.

 

Retrieves the number of available subpicture streams, the currently selected subpicture stream number, and whether the subpicture display is disabled.

Syntax

HRESULT GetCurrentSubpicture(
  [out] ULONG *pulStreamsAvailable,
  [out] ULONG *pulCurrentStream,
  [out] BOOL  *pIsDisabled
);

Parameters

[out] pulStreamsAvailable

Pointer to the retrieved number of available subpicture streams.

[out] pulCurrentStream

Pointer to the retrieved number of the currently selected subpicture stream.

[out] pIsDisabled

Pointer to a value indicating whether the subpicture display is disabled.

Return value

Returns an HRESULT value .

Return code	Description
E_UNEXPECTED	DVD is not initialized or domain is not DVD_DOMAIN_Title.
S_OK	Success.
VFW_E_DVD_INVALIDDOMAIN	Requested action is not supported on this domain (DVD_DOMAIN).
VFW_E_DVD_OPERATION_INHIBITED	Requested action cannot occur at this point in the movie due to the authoring of the current DVD-Video disc.

Remarks

Subpicture streams authored as forcedly activated streams will be displayed even if the application has disabled subpicture display with the IDvdControl::SubpictureStreamChange method.

This method returns an error unless the domain is DVD_DOMAIN_Title. For more information, see DVD_DOMAIN.

Requirements

Requirement	Value
Target Platform	Windows
Header	strmif.h (include Dshow.h)

See also

Error and Success Codes

IDvdInfo Interface