IWMPControls3::getAudioLanguageDescription method (wmp.h)

Article
4/26/2023

[The feature associated with this page, Windows Media Player SDK, is a legacy feature. It has been superseded by MediaPlayer. MediaPlayer has been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer instead of Windows Media Player SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The getAudioLanguageDescription method retrieves the description for the audio language corresponding to the specified one-based index.

Syntax

HRESULT getAudioLanguageDescription(
  [in]  long lIndex,
  [out] BSTR *pbstrLangDesc
);

Parameters

[in] lIndex

long specifying the one-based audio language index.

[out] pbstrLangDesc

Pointer to a BSTR containing the description.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The method succeeded.

Remarks

For Windows Media-based content, properties and methods related to language selection support only a single output.

Use the get_audioLanguageCount method to retrieve the number of supported audio languages, and then access an audio language individually by using a one-based index.

Windows Media Player 10 Mobile: This method is not supported.

Requirements


Minimum supported client	Windows Media Player 9 Series or later.
Target Platform	Windows
Header	wmp.h
DLL	Wmp.dll