mmpSetStage

Syntax

BOOL mmpSetStage(idMovie, hWndStage, lprectStage, wOptions)

This function provides the playback window, or stage window, for the Movie Player instance. It also specifies the position and size of the playback region within the window. It brings the stage window to the foreground and optionally updates the current frame.

Parameters

MMPID idMovie

Identifies the movie ID of the Movie Player instance.

HWND hWndStage

Identifies the handle to the window to associate with the Movie Player instance.

LPRECT lprectStage

Points to a RECT structure specifying the origin and extents of the playback area within the stage window.

The top and left fields of the RECT contain the offset of the playback area within the stage-window client area, and the right and bottom fields contain the extents.

If the movie as authored is larger than the specified extents, the playback area is clipped. If this parameter is NULL, the authored size of the movie is used.

WORD wOptions

Specifies the following flags:

MMP_DRAW_FRAME

Draw the current frame to the stage window.

MMP_STAGE_OFFSET

Use the RECT structure pointed to by the lprectStage parameter to position and size the playback area.

MMP_STAGE_CENTER

Center the playback area in the window client area.

MMP_STAGE_BORDER

Draw a border around the playback area. Use the MMP_STAGE_CENTER or MMP_STAGE_OFFSET flags to provide room for the left and top borders.

The border consists of a shadow placed under the movie and over a backdrop of the Windows desktop color. The border is visible whenever the stage window is larger than the authored movie size; otherwise, portions of the border and movie are clipped by Windows.

MMP_STAGE_FIXED

Fix the size and position of the movie playback area. When the window is resized, or when a new movie is loaded, the playback area remains fixed at either the size of the client area at the time mmpSetStage was called or, if the MMP_STAGE_OFFSET flag was specified, the offset and extents specified by the RECT values.

Return Value

Returns TRUE if operation successful, otherwise returns FALSE.

Comments

You can use any pop-up or overlapped window for the stage window.

The Movie Player must have a movie file loaded when you call this API; otherwise, the function fails and reports error code MMPERR_STAGE_ERROR.

See Also

mmpGetStage, mmpOpen