IDvdControl2::SelectSubpictureStream method (strmif.h)

The SelectSubpictureStream method sets the subpicture stream to display.

Syntax

HRESULT SelectSubpictureStream(
  ULONG   ulSubPicture,
  DWORD   dwFlags,
  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.

dwFlags

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

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
S_OK
Success.
E_INVALIDARG
ulSubPicture is out of range or doesn't correspond to an SP stream.
E_UNEXPECTED
The ulSubPicture parameter is valid, but DVD Navigator cannot set it for some other reason.
VFW_E_DVD_OPERATION_INHIBITED
UOP control prohibits the operation.
VFW_E_DVD_INVALIDDOMAIN
Invalid domain.
VFW_E_DVD_STREAM_DISABLED
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
  • DVD_DOMAIN_VideoManagerMenu
  • DVD_DOMAIN_VideoTitleSetMenu
  • DVD_DOMAIN_Title
  • DVD_DOMAIN_Stop

Requirements

   
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

See also

Audio and Subpicture Streams

DVD Applications

Error and Success Codes

IDvdControl2 Interface