Share via


ClosedCaption.getSAMIStyleName 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 getSAMIStyleName method retrieves the name of a style supported by the current SAMI file.

Syntax

strRetVal = ClosedCaption.getSAMIStyleName(
  index
)

Parameters

index [in]

Number (long) specifying the index of the style name to retrieve.

Return value

This method returns a String containing the name of the style as specified in the SAMI file.

Remarks

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

This method cannot be used until a digital media file is open (Player.openState is equal to 13).

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

Requirements

Requirement Value
Version
Windows Media Player 9 Series or later.
DLL
Wmp.dll

See also

Adding Closed Captions to Digital Media

ClosedCaption Object

ClosedCaption.SAMIStyle