IDvdControl2::SelectSubpictureStream 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 SelectSubpictureStream method sets the subpicture stream to display.
Syntax
HRESULT SelectSubpictureStream(
ULONG ulSubPicture,
[in] DWORD dwFlags,
[out] IDvdCmd **ppCmd
);
Parameters
ulSubPicture
Value that specifies the subpicture stream, which must be from 0 through 31, or 63.
| Value | Description |
|---|---|
| 0-31 | The stream is valid. |
| 63 | The stream is the dummy stream, which means it is a muted, low-bitrate stream. |
[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.
| Return code | Description |
|---|---|
|
Success. |
|
ulSubPicture is out of range or doesn't correspond to an SP stream. |
|
The ulSubPicture parameter is valid, but DVD Navigator cannot set it for some other reason. |
|
UOP control prohibits the operation. |
|
Invalid domain. |
|
The specified stream is disabled. |
Remarks
The following table shows the Annex J command name to which this method name corresponds, and the domains in which this method is valid.
| Annex J Command Name | Valid Domains |
| Sub-picture_Stream_Change |
|
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 |