IDvdControl::SubpictureStreamChange method (strmif.h)

Article
07/27/2023

[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 IDvdControl interface is deprecated. Use IDvdControl2 instread.

Selects the new subpicture stream and enables or disables it for display.

Syntax

HRESULT SubpictureStreamChange(
  ULONG ulSubPicture,
  BOOL  bDisplay
);

Parameters

ulSubPicture

Value that specifies the source of the subpicture, which must be from 0 through 32, or 63.

Value	Description
0-31	Indicates that the stream is valid.
32	Enables you to toggle the display without changing the current stream (that is, change bDisplay without altering the current stream).
63	Indicates that the stream is the dummy stream.

bDisplay

Value that specifies whether the subpicture is enabled; TRUE makes the subpicture visible and FALSE hides it.

Return value

Returns an HRESULT value.

Remarks

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

Requirements

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