Share via


IWMPClosedCaption2::getSAMILangName 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 getSAMILangName method returns the name of a language supported by the current SAMI file.

Syntax

public System.String getSAMILangName(
  System.Int32 nIndex
);

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

Parameters

nIndex [in]

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

Return value

A System.String that is the name of the language as specified in the SAMI file.

Remarks

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

This method returns a zero-length string ("") 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#)

IWMPClosedCaption.SAMILang (VB and C#)

IWMPClosedCaption2 Interface (VB and C#)