Share via

Windows Media Player 11 SDK IWMPClosedCaption::get_SAMIStyle 

  • Article

Windows Media Player SDK banner art

Previous Next

IWMPClosedCaption::get_SAMIStyle

The get_SAMIStyle method retrieves the closed captioning style.

Syntax

  HRESULT get_SAMIStyle(
  BSTR*  pbstrSAMIStyle
);

Parameters

pbstrSAMIStyle

[out]  Pointer to a BSTR containing the SAMI style.

Return Values

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

A SAMI file can contain several format style definitions. SAMI styles are defined between the <STYLE> and </STYLE> tags in the SAMI file. A style is defined with a text string preceded by a # character. For example, the following code specifies text formatting to be used for a style.

#Emphasis1 {Name: Big Bold Italic; font-size: 14pt; text-align: center;
            color: blue; font-family: sans-serif; font-weight: bold;
            font-style: italic;}

If no SAMI style is specified, the first style defined in the SAMI file is used by default.

Windows Media Player 10 Mobile: This method always retrieves a BSTR containing an empty string.

Requirements

Version: Windows Media Player 9 Series or later.

Header: Include wmp.h.

Library: Use wmp.dll.

See Also

Previous Next