IWMPClosedCaption::put_captioningId 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_captioningId method specifies the name of the element displaying the captioning.

Syntax

HRESULT put_captioningId(
  [in] BSTR bstrCaptioningID
);

Parameters

[in] bstrCaptioningID

BSTR containing the captioning ID.

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 element name specified can be any HTML element in the webpage as long as it supports the innerHTML attribute. If the webpage contains multiple frames, the element name can only refer to an element in the same frame as the Windows Media Player control.

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