IWMPControls3::get_currentAudioLanguageIndex method (wmp.h)

[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 get_currentAudioLanguageIndex method retrieves the one-based index that corresponds to the audio language for playback.

Syntax

HRESULT get_currentAudioLanguageIndex(
  [out] long *plIndex
);

Parameters

[out] plIndex

Pointer to a long containing the one-based index.

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.

Windows Media Player 10 Mobile: This method always retrieves a long set to 0.

Requirements

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

See also

IWMPControls3 Interface

IWMPControls3::getAudioLanguageDescription

IWMPControls3::getAudioLanguageID

IWMPControls3::getLanguageName

IWMPControls3::get_audioLanguageCount

IWMPControls3::get_currentAudioLanguage

IWMPControls3::put_currentAudioLanguageIndex