Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]
The GetPreferredAspectRatio method retrieves the preferred aspect ratio.
Syntax
HRESULT GetPreferredAspectRatio(
[out] long *plAspectX,
[out] long *plAspectY
);
Parameters
[out] plAspectX
Pointer to a value that indicates the x-axis aspect ratio.
[out] plAspectY
Pointer to a value that indicates the y-axis aspect ratio.
Return value
Returns an HRESULT value. Possible values include the following.
| Return code | Description |
|---|---|
|
Success. |
|
One or both of the parameters are invalid. |
|
The renderer does not implement IBasicVideo2. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | control.h (include Dshow.h) |
| Library | Strmiids.lib |