IWMPClosedCaption::put_SAMIFileName method (wmp.h)

Article
4/26/2023

[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 put_SAMIFileName method specifies the name of the file containing the information needed for closed captioning.

Syntax

HRESULT put_SAMIFileName(
  [in] BSTR bstrSAMIFileName
);

Parameters

[in] bstrSAMIFileName

BSTR containing the SAMI file name.

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

The SAMI file must use an .smi or .sami file name extension.

Once you specify a value using put_SAMIFileName, that value persists until you specify a new value (or until a new media item is opened by using the sami URL parameter). Therefore, you must specify a new value with this method before you play each new media item. The new value will take effect when the next media item is opened (or when IWMPCore::close is called). Specifying a new value by using put_SAMIFileName has no effect on the current media item.

Windows Media Player 10 Mobile: This method always returns E_INVALIDARG.

Requirements

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

Share via