IDvdControl2::SetSubpictureState 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 SetSubpictureState method turns the subpicture display on or off.

Syntax

HRESULT SetSubpictureState(
  [in]  BOOL    bState,
  [in]  DWORD   dwFlags,
  [out] IDvdCmd **ppCmd
);

Parameters

[in] bState

Boolean value that specifies whether the subpicture display is on; TRUE sets subpicture display on for subsequent playback.

[in] dwFlags

Bitwise OR of one or more flags from the DVD_CMD_FLAGS enumeration, specifying how to synchronize the command.

[out] ppCmd

Receives a pointer to an IDvdCmd object that can be used to synchronize DVD commands. The caller must release the interface. This parameter can be NULL. For more information, see Synchronizing DVD Commands.

Return value

Returns one of the following values.

Remarks

Subpicture streams are typically used in menus for button text and sometimes button graphics, and in video playback for subtitles, credits, or other overlaid graphics. Do not confuse subpictures with closed captions; the latter are encoded within the video stream. In general, this method is intended for controlling subpicture display over video while the DVD Navigator filter is playing video in the DVD Title domain.

This method corresponds to the second parameter of the Annex J "Sub-picture_Stream_Change" command.

The following table shows the Annex J command name to which this method name corresponds, and the domains in which this method is valid.

Requirements

See also

DVD Applications

Error and Success Codes

IDvdControl2 Interface

SelectSubpictureStream