IDvdInfo2::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.]

The GetCurrentSubpicture method retrieves the number of available subpicture streams in the current title, the currently selected subpicture stream number, and the state of the subpicture.

Syntax

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

Parameters

[out] pulStreamsAvailable

Receives the number of available subpicture streams.

[out] pulCurrentStream

Receives the number of the currently selected subpicture stream.

[out] pbIsDisabled

Receives a Boolean value that indicates whether the subpicture display is disabled; TRUE means it is disabled.

Return value

Returns one of the following HRESULT values.

Remarks

DVD content authors can specify that any particular subpicture stream on a disc is forcedly activated, meaning that the DVD authors require this stream to display whether the viewer wants to watch it or not. The DVD Navigator complies with all such commands from the disc, meaning that forcedly activated streams are displayed even if the application has disabled subpicture display with the IDvdControl2::SetSubpictureState method.

Requirements

See also

DVD Applications

EC_DVD_SUBPICTURE_STREAM_CHANGE

Error and Success Codes

IDvdInfo2 Interface