Share via


IWMPClosedCaption2::getSAMILangID method

[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 getSAMILangID method returns the locale identifier (LCID) of a language supported by the current SAMI file.

Syntax

public System.Int32 getSAMILangID(
  System.Int32 nIndex
);

Public Function getSAMILangID( _
  ByVal nIndex As System.Int32 _
) As System.Int32
Implements IWMPClosedCaption2.getSAMILangID

Parameters

nIndex [in]

A System.Int32 that is the zero-based index of the LCID to retrieve.

Return value

A System.Int32 that is the LCID of the language with the specified index.

Remarks

The languages in a SAMI file are indexed in the order shown in the file, starting with zero.

This method returns 0 unless a digital media file is open (AxWindowsMediaPlayer.openState is equal to 13).

Requirements

Requirement Value
Version
Windows Media Player 9 Series or later
Namespace
WMPLib
Assembly
Interop.WMPLib.dll (Interop.WMPLib.dll.dll)

See also

Adding Closed Captions to Digital Media

IWMPClosedCaption Interface (VB and C#)

IWMPClosedCaption2 Interface (VB and C#)