Share via

Windows Media Player 11 SDK IWMPClosedCaption::put_SAMIFileName 

  • Article

Windows Media Player SDK banner art

Previous Next

IWMPClosedCaption::put_SAMIFileName

The put_SAMIFileName method specifies the name of the file containing the information needed for closed captioning.

Syntax

  HRESULT put_SAMIFileName(
  BSTR  bstrSAMIFileName
);

Parameters

bstrSAMIFileName

[in]  BSTR containing the SAMI file name.

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

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

Version: Windows Media Player 9 Series or later.

Header: Include wmp.h.

Library: Use wmp.dll.

See Also

Previous Next