IDvdControl2::SelectDefaultSubpictureLanguage 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 SelectDefaultSubpictureLanguage method sets the default language for subpicture text.

Syntax

HRESULT SelectDefaultSubpictureLanguage(
  [in] LCID                    Language,
  [in] DVD_SUBPICTURE_LANG_EXT subpictureExtension
);

Parameters

[in] Language

Locale identifier that specifies the default language.

[in] subpictureExtension

DVD_SUBPICTURE_LANG_EXT enumeration that specifies the default subpicture extension.

Return value

Returns one of the following values.

Return code Description
S_OK
Success.
E_INVALIDARG
Language is invalid.
VFW_E_DVD_INVALIDDOMAIN
The DVD Navigator filter is not in a valid domain.

Remarks

This method selects the default language and format to use for subpictures and menus when the disc is played. For example, if Language is specified as 0x409 for U.S. English and subpictureExtension is specified as DVD_SP_EXT_Caption_Big, the DVD Navigator tries to show U.S. English text in the "big caption" format in subpictures. If the default language or language extension is not found on a disc, the DVD Navigator selects the closest match.

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
None DVD_DOMAIN_Stop

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

See also

DVD Applications

Error and Success Codes

IDvdControl2 Interface