Share via


IDVDRenderer::SetSubpictureStreamNumber

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This method sets the decoding stream number for a subpicture.

Syntax

HRESULT SetSubpictureStreamNumber(
  int iDecodingNumber,
  BOOL bDisplay
);

Parameters

  • iDecodingNumber
    [in] Can be set to a valid audio stream number or –1 to discard the subpicture stream.
  • bDisplay
    [in] Value indicating if the currently selected audio stream should be displayed. This value is meaningless if iDecodingNumber is set to -1, however, Microsoft does not dictate how a driver should handle this scenario. Your driver may choose to save the value of bDisplay, even if iDecodingNumber is set to -1, so that if a user then sets a valid audio stream, the saved display value will apply to the new stream.

Return Value

The following table shows a list of possible return values.

Return value Description

S_OK

The request completed successfully.

E_INVALIDARG

An invalid argument was encountered.

Requirements

Header dvddrvr.idl
Windows Embedded CE Windows CE .NET 4.0 and later

See Also

Reference

IDVDRenderer