Settings.getMode method

[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 getMode method determines whether the loop mode or shuffle mode is active.

Syntax

bRetVal = Settings.getMode(
  modeName
)

Parameters

modeName [in]

String specifying the name of the mode in question, containing one of the following values.

String	Description
autoRewind	Tracks are restarted at the beginning after playing to the end.
loop	The sequence of tracks repeats itself.
showFrame	The nearest key frame is displayed at the current position when not playing. This mode is not relevant for audio tracks.
shuffle	Tracks are played in random order.

Return value

This method returns a Boolean value indicating whether the specified mode is active.

Requirements

See also

Settings Object

Settings.setMode