Share via

CBaseControlVideo::get_SourceTop

  • Article
 
Microsoft DirectShow 9.0

CBaseControlVideo::get_SourceTop

The get_SourceTop method retrieves the top coordinate of the current source rectangle.

Syntax

  HRESULT get_SourceTop(
    long *pSourceTop
);

Parameters

pSourceTop

Pointer to the top coordinate of the source rectangle.

Return Value

Returns an HRESULT value that depends on the implementation; can be one of the following values, or other values not listed.

Value Description
E_FAIL Failure.
E_POINTER Null pointer argument.
VFW_E_NOT_CONNECTED The operation cannot be performed because the pins are not connected.
NOERROR Success.

Remarks

This member function implements the IBasicVideo::get_SourceTop method.

An application can change the source and destination rectangles for the video through the IBasicVideo interface. The source rectangle affects which section of the native video source will appear on the display; the destination rectangle affects where the video will appear when played. The destination rectangle is relative to the client area of the window in which it is playing. The upper-left corner of the window is coordinate (0,0).

Requirements

**  Header:** Declared in Ctlutil.h; include Streams.h.

**  Library:** Use Strmbase.lib (retail builds) or Strmbasd.lib (debug builds).

See Also