Share via


IWMPSettings::get_autoStart method (wmp.h)

[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 get_autoStart method retrieves a value indicating whether the current media item begins playing automatically.

Syntax

HRESULT get_autoStart(
  [out] VARIANT_BOOL *pfAutoStart
);

Parameters

[out] pfAutoStart

Pointer to a VARIANT_BOOL that indicates whether the current media item begins playing automatically. The default is TRUE.

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

If pfAutoStart is TRUE, the media item will begin playing when IWMPCore::put_URL, IWMPCore::put_currentPlaylist, or IWMPCore::put_currentMedia is called. Otherwise, the media item will not start playing until the IWMPControls::play method is called.

pfAutoStart for the full mode of Windows Media Player can be set globally by external events (such as loading a CD). Skins and remoted Player controls cannot expect a default value because they both employ the full mode Windows Media Player playback engine.

Requirements

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

See also

IWMPControls::play

IWMPCore::put_URL

IWMPCore::put_currentMedia

IWMPCore::put_currentPlaylist

IWMPSettings Interface

IWMPSettings::put_autoStart