MCI_PUT
The MCI_PUT
command sets the source, destination, and frame rectangles. Digital-video and
video-overlay devices recognize this command.
MCIERROR mciSendCommand(MCIDEVICEID wDeviceID,
MCI_PUT,
DWORD dwFlags, (DWORD)
(LPMCI_GENERIC_PARMS) lpDest);
Parameters
wDeviceID
Device
identifier of the MCI device that is to receive the command message.
dwFlags
MCI_NOTIFY,
MCI_WAIT, or, for digital-video devices, MCI_TEST. For information about these
flags, see The Wait, Notify, and Test Flags.
lpDest
Address of an
MCI_GENERIC_PARMS
structure. (Devices with extended command sets might replace this structure
with a device-specific structure.)
Return Values
Returns zero
if successful or an error otherwise.
Remarks
The following
additional flags are used with the digitalvideo device type:
MCI_DGV_PUT_CLIENT
The rectangle
defined for MCI_DGV_RECT applies to the position of the client window. The
rectangle specified is relative to the parent window of the display window.
MCI_DGV_PUT_WINDOW must be set concurrently with this flag.
MCI_DGV_PUT_DESTINATION
The rectangle
defined for MCI_DGV_RECT specifies a destination rectangle. The destination
rectangle specifies the portion of the client window associated with this device
driver instance that shows the image or video.
MCI_DGV_PUT_FRAME
The rectangle
defined for MCI_DGV_RECT applies to the frame rectangle. The frame rectangle
specifies the portion of the frame buffer used as the destination of the video
images obtained from the video rectangle. The video should be scaled to fit
within the frame buffer rectangle.
The rectangle
is specified in frame buffer coordinates. The default rectangle is the full
frame buffer. Specifying this rectangle lets the device scale the image as it
digitizes the data. Devices that cannot scale the image reject this command
with MCIERR_UNSUPPORTED_FUNCTION. You can use the MCI_GETDEVCAPS_CAN_STRETCH
flag with the MCI_GETDEVCAPS
command to determine if a device scales the image. A device returns FALSE if it
cannot scale the image.
MCI_DGV_PUT_SOURCE
The rectangle
defined for MCI_DGV_RECT specifies a source rectangle. The source rectangle
specifies which portion of the frame buffer is to be scaled to fit into the
destination rectangle.
MCI_DGV_PUT_VIDEO
The rectangle
defined for MCI_DGV_RECT applies to the video rectangle. The video rectangle
specifies which portion of the current presentation source is stored in the
frame buffer. The rectangle is specified using the natural coordinates of the
presentation source. It allows the specification of cropping that occurs prior
to storing images and video in the frame buffer. The default rectangle is the
full active scan area or the full decompressed images and video.
MCI_DGV_PUT_WINDOW
The rectangle
defined for MCI_DGV_RECT applies to the display window. This rectangle is
relative to the parent window of the display window (usually the desktop). If
the window is not specified, it defaults to the initial window size and
position.
MCI_DGV_RECT
The rc
member of the structure identified by lpDest contains a valid rectangle.
For
digital-video devices, lpDest points to an MCI_DGV_PUT_PARMS structure.
The following
additional flags are used with the overlay device type:
MCI_OVLY_PUT_DESTINATION
The rectangle
defined for MCI_OVLY_RECT specifies the area of the client window used to
display an image. The rectangle contains the offset and visible extent of the
image relative to the window origin. If the frame is being stretched, the
source is stretched to the destination rectangle.
MCI_OVLY_PUT_FRAME
The rectangle
defined for MCI_OVLY_RECT specifies the area of the video buffer used to
receive the video image. The rectangle contains the offset and extent of the
buffer area relative to the video buffer origin.
MCI_OVLY_PUT_SOURCE
The rectangle
defined for MCI_OVLY_RECT specifies the area of the video buffer used as the
source of the digital image. The rectangle contains the offset and extent of
the clipping rectangle for the video buffer relative to its origin.
MCI_OVLY_PUT_VIDEO
The rectangle
defined for MCI_OVLY_RECT specifies the area of the video source capture by the
video buffer. The rectangle contains the offset and extent of the clipping
rectangle for the video source relative to its origin.
MCI_OVLY_RECT
The rc
member of the structure identified by lpDest contains a valid display
rectangle. If this flag is not specified, the default rectangle matches the
coordinates of the video buffer or window being clipped.
For video-overlay
devices, lpDest points to an MCI_OVLY_RECT_PARMS structure.
See Also