Share via


IWMPPlayer::get_uiMode (Windows Embedded CE 6.0)

1/6/2010

The get_uiMode method retrieves a value indicating which controls are shown in the user interface.

Syntax

HRESULT get_uiMode( BSTR* pbstrMode ); 

Parameters

  • pbstrMode
    [out]  Pointer to a BSTR containing one of the following values.

The following table shows possible values for pbstrMode:

Value Description

invisible

Windows Media Player is embedded without any visible user interface (controls, video, or visualization window).

none

Windows Media Player is embedded without controls, and with only the video or visualization window displayed.

mini

Windows Media Player is embedded with the status window, play/pause, stop, mute, and volume controls shown in addition to the video or visualization window.

full

Default. Windows Media Player is embedded with the status window, seek bar, play/pause, stop, mute, next, previous, fast forward, fast reverse, and volume controls in addition to the video or visualization window.

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

This method retrieves the appearance of the embedded Windows Media Player. When the BSTR retrieved from get_uiMode is "none", "mini", or "full", a window is present for the display of video clips and audio visualizations. This window can be hidden (using the default skin) in mini or full mode by setting the height attribute of the OBJECT tag to 44, which is measured from the bottom, and leaves the controls portion of the user interface visible. If no embedded interface is desired, set both the width and height attributes to zero. This value will be different if the control size has been changed, or if you wish to display the status bar.

If the BSTR retrieved from get_uiMode is "invisible", no user interface is displayed, but space is still reserved on the page as specified by width and height. This is useful for retaining page layout whenever the UI mode changes. Additionally, the reserved space is transparent, so any elements layered behind the control will be visible.

If the BSTR retrieved from get_uiMode is "full" or "mini", Windows Media Player displays transport controls in full-screen mode. If the BSTR retrieved from get_uiMode is "none", no controls are displayed in full-screen mode.

See Also

Reference

IWMPPlayer Interface